xref: /linux-6.15/scripts/checkpatch.pl (revision 5fe3af11)
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)
40a920b5bSAndy Whitcroft# (c) 2007, Andy Whitcroft <[email protected]> (new conditions, test suite, etc)
50a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2
60a920b5bSAndy Whitcroft
70a920b5bSAndy Whitcroftuse strict;
80a920b5bSAndy Whitcroft
90a920b5bSAndy Whitcroftmy $P = $0;
1000df344fSAndy Whitcroft$P =~ s@.*/@@g;
110a920b5bSAndy Whitcroft
126e144ee5SAndy Whitcroftmy $V = '0.24';
130a920b5bSAndy Whitcroft
140a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev);
150a920b5bSAndy Whitcroft
160a920b5bSAndy Whitcroftmy $quiet = 0;
170a920b5bSAndy Whitcroftmy $tree = 1;
180a920b5bSAndy Whitcroftmy $chk_signoff = 1;
190a920b5bSAndy Whitcroftmy $chk_patch = 1;
20773647a0SAndy Whitcroftmy $tst_only;
216c72ffaaSAndy Whitcroftmy $emacs = 0;
228905a67cSAndy Whitcroftmy $terse = 0;
236c72ffaaSAndy Whitcroftmy $file = 0;
246c72ffaaSAndy Whitcroftmy $check = 0;
258905a67cSAndy Whitcroftmy $summary = 1;
268905a67cSAndy Whitcroftmy $mailback = 0;
2713214adfSAndy Whitcroftmy $summary_file = 0;
286c72ffaaSAndy Whitcroftmy $root;
29c2fdda0dSAndy Whitcroftmy %debug;
300a920b5bSAndy WhitcroftGetOptions(
316c72ffaaSAndy Whitcroft	'q|quiet+'	=> \$quiet,
320a920b5bSAndy Whitcroft	'tree!'		=> \$tree,
330a920b5bSAndy Whitcroft	'signoff!'	=> \$chk_signoff,
340a920b5bSAndy Whitcroft	'patch!'	=> \$chk_patch,
356c72ffaaSAndy Whitcroft	'emacs!'	=> \$emacs,
368905a67cSAndy Whitcroft	'terse!'	=> \$terse,
376c72ffaaSAndy Whitcroft	'file!'		=> \$file,
386c72ffaaSAndy Whitcroft	'subjective!'	=> \$check,
396c72ffaaSAndy Whitcroft	'strict!'	=> \$check,
406c72ffaaSAndy Whitcroft	'root=s'	=> \$root,
418905a67cSAndy Whitcroft	'summary!'	=> \$summary,
428905a67cSAndy Whitcroft	'mailback!'	=> \$mailback,
4313214adfSAndy Whitcroft	'summary-file!'	=> \$summary_file,
4413214adfSAndy Whitcroft
45c2fdda0dSAndy Whitcroft	'debug=s'	=> \%debug,
46773647a0SAndy Whitcroft	'test-only=s'	=> \$tst_only,
470a920b5bSAndy Whitcroft) or exit;
480a920b5bSAndy Whitcroft
490a920b5bSAndy Whitcroftmy $exit = 0;
500a920b5bSAndy Whitcroft
510a920b5bSAndy Whitcroftif ($#ARGV < 0) {
5200df344fSAndy Whitcroft	print "usage: $P [options] patchfile\n";
530a920b5bSAndy Whitcroft	print "version: $V\n";
540a920b5bSAndy Whitcroft	print "options: -q               => quiet\n";
550a920b5bSAndy Whitcroft	print "         --no-tree        => run without a kernel tree\n";
568905a67cSAndy Whitcroft	print "         --terse          => one line per report\n";
576c72ffaaSAndy Whitcroft	print "         --emacs          => emacs compile window format\n";
586c72ffaaSAndy Whitcroft	print "         --file           => check a source file\n";
596c72ffaaSAndy Whitcroft	print "         --strict         => enable more subjective tests\n";
606c72ffaaSAndy Whitcroft	print "         --root           => path to the kernel tree root\n";
6113214adfSAndy Whitcroft	print "         --no-summary     => suppress the per-file summary\n";
6213214adfSAndy Whitcroft	print "         --summary-file   => include the filename in summary\n";
630a920b5bSAndy Whitcroft	exit(1);
640a920b5bSAndy Whitcroft}
650a920b5bSAndy Whitcroft
66c2fdda0dSAndy Whitcroftmy $dbg_values = 0;
67c2fdda0dSAndy Whitcroftmy $dbg_possible = 0;
687429c690SAndy Whitcroftmy $dbg_type = 0;
69a1ef277eSAndy Whitcroftmy $dbg_attr = 0;
70c2fdda0dSAndy Whitcroftfor my $key (keys %debug) {
71c2fdda0dSAndy Whitcroft	eval "\${dbg_$key} = '$debug{$key}';"
72c2fdda0dSAndy Whitcroft}
73c2fdda0dSAndy Whitcroft
748905a67cSAndy Whitcroftif ($terse) {
758905a67cSAndy Whitcroft	$emacs = 1;
768905a67cSAndy Whitcroft	$quiet++;
778905a67cSAndy Whitcroft}
788905a67cSAndy Whitcroft
796c72ffaaSAndy Whitcroftif ($tree) {
806c72ffaaSAndy Whitcroft	if (defined $root) {
816c72ffaaSAndy Whitcroft		if (!top_of_kernel_tree($root)) {
826c72ffaaSAndy Whitcroft			die "$P: $root: --root does not point at a valid tree\n";
836c72ffaaSAndy Whitcroft		}
846c72ffaaSAndy Whitcroft	} else {
856c72ffaaSAndy Whitcroft		if (top_of_kernel_tree('.')) {
866c72ffaaSAndy Whitcroft			$root = '.';
876c72ffaaSAndy Whitcroft		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
886c72ffaaSAndy Whitcroft						top_of_kernel_tree($1)) {
896c72ffaaSAndy Whitcroft			$root = $1;
906c72ffaaSAndy Whitcroft		}
916c72ffaaSAndy Whitcroft	}
926c72ffaaSAndy Whitcroft
936c72ffaaSAndy Whitcroft	if (!defined $root) {
940a920b5bSAndy Whitcroft		print "Must be run from the top-level dir. of a kernel tree\n";
950a920b5bSAndy Whitcroft		exit(2);
960a920b5bSAndy Whitcroft	}
976c72ffaaSAndy Whitcroft}
986c72ffaaSAndy Whitcroft
996c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0;
1006c72ffaaSAndy Whitcroft
1016c72ffaaSAndy Whitcroftour $Ident       = qr{[A-Za-z_][A-Za-z\d_]*};
1026c72ffaaSAndy Whitcroftour $Storage	= qr{extern|static|asmlinkage};
1036c72ffaaSAndy Whitcroftour $Sparse	= qr{
1046c72ffaaSAndy Whitcroft			__user|
1056c72ffaaSAndy Whitcroft			__kernel|
1066c72ffaaSAndy Whitcroft			__force|
1076c72ffaaSAndy Whitcroft			__iomem|
1086c72ffaaSAndy Whitcroft			__must_check|
1096c72ffaaSAndy Whitcroft			__init_refok|
110cf655043SAndy Whitcroft			__kprobes
1116c72ffaaSAndy Whitcroft		}x;
1126c72ffaaSAndy Whitcroftour $Attribute	= qr{
1136c72ffaaSAndy Whitcroft			const|
1146c72ffaaSAndy Whitcroft			__read_mostly|
1156c72ffaaSAndy Whitcroft			__kprobes|
11624e1d81aSAndy Whitcroft			__(?:mem|cpu|dev|)(?:initdata|init)|
11724e1d81aSAndy Whitcroft			____cacheline_aligned|
11824e1d81aSAndy Whitcroft			____cacheline_aligned_in_smp|
119*5fe3af11SAndy Whitcroft			____cacheline_internodealigned_in_smp|
120*5fe3af11SAndy Whitcroft			__weak
1216c72ffaaSAndy Whitcroft		  }x;
122c45dcabdSAndy Whitcroftour $Modifier;
1236c72ffaaSAndy Whitcroftour $Inline	= qr{inline|__always_inline|noinline};
1246c72ffaaSAndy Whitcroftour $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
1256c72ffaaSAndy Whitcroftour $Lval	= qr{$Ident(?:$Member)*};
1266c72ffaaSAndy Whitcroft
1276c72ffaaSAndy Whitcroftour $Constant	= qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
1286c72ffaaSAndy Whitcroftour $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
1296c72ffaaSAndy Whitcroftour $Operators	= qr{
1306c72ffaaSAndy Whitcroft			<=|>=|==|!=|
1316c72ffaaSAndy Whitcroft			=>|->|<<|>>|<|>|!|~|
132c2fdda0dSAndy Whitcroft			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1336c72ffaaSAndy Whitcroft		  }x;
1346c72ffaaSAndy Whitcroft
1358905a67cSAndy Whitcroftour $NonptrType;
1368905a67cSAndy Whitcroftour $Type;
1378905a67cSAndy Whitcroftour $Declare;
1388905a67cSAndy Whitcroft
139171ae1a4SAndy Whitcroftour $UTF8	= qr {
140171ae1a4SAndy Whitcroft	[\x09\x0A\x0D\x20-\x7E]              # ASCII
141171ae1a4SAndy Whitcroft	| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
142171ae1a4SAndy Whitcroft	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
143171ae1a4SAndy Whitcroft	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
144171ae1a4SAndy Whitcroft	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
145171ae1a4SAndy Whitcroft	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
146171ae1a4SAndy Whitcroft	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
147171ae1a4SAndy Whitcroft	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
148171ae1a4SAndy Whitcroft}x;
149171ae1a4SAndy Whitcroft
1508ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x:
1518ed22cadSAndy Whitcroft	(?:__)?(?:u|s|be|le)(?:\d|\d\d)|
1528ed22cadSAndy Whitcroft	atomic_t
1538ed22cadSAndy Whitcroft)};
1548ed22cadSAndy Whitcroft
1558905a67cSAndy Whitcroftour @typeList = (
1568905a67cSAndy Whitcroft	qr{void},
157c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?char},
158c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?short},
159c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?int},
160c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long},
161c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+int},
162c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+long},
163c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+long\s+int},
1648905a67cSAndy Whitcroft	qr{unsigned},
1658905a67cSAndy Whitcroft	qr{float},
1668905a67cSAndy Whitcroft	qr{double},
1678905a67cSAndy Whitcroft	qr{bool},
1688905a67cSAndy Whitcroft	qr{struct\s+$Ident},
1698905a67cSAndy Whitcroft	qr{union\s+$Ident},
1708905a67cSAndy Whitcroft	qr{enum\s+$Ident},
1718905a67cSAndy Whitcroft	qr{${Ident}_t},
1728905a67cSAndy Whitcroft	qr{${Ident}_handler},
1738905a67cSAndy Whitcroft	qr{${Ident}_handler_fn},
1748905a67cSAndy Whitcroft);
175c45dcabdSAndy Whitcroftour @modifierList = (
176c45dcabdSAndy Whitcroft	qr{fastcall},
177c45dcabdSAndy Whitcroft);
1788905a67cSAndy Whitcroft
1798905a67cSAndy Whitcroftsub build_types {
180d2172eb5SAndy Whitcroft	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
181d2172eb5SAndy Whitcroft	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
182c8cb2ca3SAndy Whitcroft	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
1838905a67cSAndy Whitcroft	$NonptrType	= qr{
184d2172eb5SAndy Whitcroft			(?:$Modifier\s+|const\s+)*
185cf655043SAndy Whitcroft			(?:
186c45dcabdSAndy Whitcroft				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
1878ed22cadSAndy Whitcroft				(?:$typeTypedefs\b)|
188c45dcabdSAndy Whitcroft				(?:${all}\b)
189cf655043SAndy Whitcroft			)
190c8cb2ca3SAndy Whitcroft			(?:\s+$Modifier|\s+const)*
1918905a67cSAndy Whitcroft		  }x;
1928905a67cSAndy Whitcroft	$Type	= qr{
193c45dcabdSAndy Whitcroft			$NonptrType
1948905a67cSAndy Whitcroft			(?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
195c8cb2ca3SAndy Whitcroft			(?:\s+$Inline|\s+$Modifier)*
1968905a67cSAndy Whitcroft		  }x;
1978905a67cSAndy Whitcroft	$Declare	= qr{(?:$Storage\s+)?$Type};
1988905a67cSAndy Whitcroft}
1998905a67cSAndy Whitcroftbuild_types();
2006c72ffaaSAndy Whitcroft
2016c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file);
2020a920b5bSAndy Whitcroft
2034a0df2efSAndy Whitcroftmy @dep_includes = ();
2044a0df2efSAndy Whitcroftmy @dep_functions = ();
2056c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt";
2066c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") {
2076c72ffaaSAndy Whitcroft	open(REMOVE, "<$root/$removal") ||
2086c72ffaaSAndy Whitcroft				die "$P: $removal: open failed - $!\n";
2090a920b5bSAndy Whitcroft	while (<REMOVE>) {
210f0a594c1SAndy Whitcroft		if (/^Check:\s+(.*\S)/) {
211f0a594c1SAndy Whitcroft			for my $entry (split(/[, ]+/, $1)) {
212f0a594c1SAndy Whitcroft				if ($entry =~ m@include/(.*)@) {
2134a0df2efSAndy Whitcroft					push(@dep_includes, $1);
2144a0df2efSAndy Whitcroft
215f0a594c1SAndy Whitcroft				} elsif ($entry !~ m@/@) {
216f0a594c1SAndy Whitcroft					push(@dep_functions, $entry);
217f0a594c1SAndy Whitcroft				}
2184a0df2efSAndy Whitcroft			}
2190a920b5bSAndy Whitcroft		}
2200a920b5bSAndy Whitcroft	}
2210a920b5bSAndy Whitcroft}
2220a920b5bSAndy Whitcroft
22300df344fSAndy Whitcroftmy @rawlines = ();
224c2fdda0dSAndy Whitcroftmy @lines = ();
225c2fdda0dSAndy Whitcroftmy $vname;
2266c72ffaaSAndy Whitcroftfor my $filename (@ARGV) {
2276c72ffaaSAndy Whitcroft	if ($file) {
2286c72ffaaSAndy Whitcroft		open(FILE, "diff -u /dev/null $filename|") ||
2296c72ffaaSAndy Whitcroft			die "$P: $filename: diff failed - $!\n";
2306c72ffaaSAndy Whitcroft	} else {
2316c72ffaaSAndy Whitcroft		open(FILE, "<$filename") ||
2326c72ffaaSAndy Whitcroft			die "$P: $filename: open failed - $!\n";
2336c72ffaaSAndy Whitcroft	}
234c2fdda0dSAndy Whitcroft	if ($filename eq '-') {
235c2fdda0dSAndy Whitcroft		$vname = 'Your patch';
236c2fdda0dSAndy Whitcroft	} else {
237c2fdda0dSAndy Whitcroft		$vname = $filename;
238c2fdda0dSAndy Whitcroft	}
2396c72ffaaSAndy Whitcroft	while (<FILE>) {
2400a920b5bSAndy Whitcroft		chomp;
24100df344fSAndy Whitcroft		push(@rawlines, $_);
2426c72ffaaSAndy Whitcroft	}
2436c72ffaaSAndy Whitcroft	close(FILE);
244c2fdda0dSAndy Whitcroft	if (!process($filename)) {
2450a920b5bSAndy Whitcroft		$exit = 1;
2460a920b5bSAndy Whitcroft	}
24700df344fSAndy Whitcroft	@rawlines = ();
24813214adfSAndy Whitcroft	@lines = ();
2490a920b5bSAndy Whitcroft}
2500a920b5bSAndy Whitcroft
2510a920b5bSAndy Whitcroftexit($exit);
2520a920b5bSAndy Whitcroft
2530a920b5bSAndy Whitcroftsub top_of_kernel_tree {
2546c72ffaaSAndy Whitcroft	my ($root) = @_;
2556c72ffaaSAndy Whitcroft
2566c72ffaaSAndy Whitcroft	my @tree_check = (
2576c72ffaaSAndy Whitcroft		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
2586c72ffaaSAndy Whitcroft		"README", "Documentation", "arch", "include", "drivers",
2596c72ffaaSAndy Whitcroft		"fs", "init", "ipc", "kernel", "lib", "scripts",
2606c72ffaaSAndy Whitcroft	);
2616c72ffaaSAndy Whitcroft
2626c72ffaaSAndy Whitcroft	foreach my $check (@tree_check) {
2636c72ffaaSAndy Whitcroft		if (! -e $root . '/' . $check) {
2640a920b5bSAndy Whitcroft			return 0;
2650a920b5bSAndy Whitcroft		}
2666c72ffaaSAndy Whitcroft	}
2676c72ffaaSAndy Whitcroft	return 1;
2686c72ffaaSAndy Whitcroft}
2690a920b5bSAndy Whitcroft
2700a920b5bSAndy Whitcroftsub expand_tabs {
2710a920b5bSAndy Whitcroft	my ($str) = @_;
2720a920b5bSAndy Whitcroft
2730a920b5bSAndy Whitcroft	my $res = '';
2740a920b5bSAndy Whitcroft	my $n = 0;
2750a920b5bSAndy Whitcroft	for my $c (split(//, $str)) {
2760a920b5bSAndy Whitcroft		if ($c eq "\t") {
2770a920b5bSAndy Whitcroft			$res .= ' ';
2780a920b5bSAndy Whitcroft			$n++;
2790a920b5bSAndy Whitcroft			for (; ($n % 8) != 0; $n++) {
2800a920b5bSAndy Whitcroft				$res .= ' ';
2810a920b5bSAndy Whitcroft			}
2820a920b5bSAndy Whitcroft			next;
2830a920b5bSAndy Whitcroft		}
2840a920b5bSAndy Whitcroft		$res .= $c;
2850a920b5bSAndy Whitcroft		$n++;
2860a920b5bSAndy Whitcroft	}
2870a920b5bSAndy Whitcroft
2880a920b5bSAndy Whitcroft	return $res;
2890a920b5bSAndy Whitcroft}
2906c72ffaaSAndy Whitcroftsub copy_spacing {
291773647a0SAndy Whitcroft	(my $res = shift) =~ tr/\t/ /c;
2926c72ffaaSAndy Whitcroft	return $res;
2936c72ffaaSAndy Whitcroft}
2940a920b5bSAndy Whitcroft
2954a0df2efSAndy Whitcroftsub line_stats {
2964a0df2efSAndy Whitcroft	my ($line) = @_;
2974a0df2efSAndy Whitcroft
2984a0df2efSAndy Whitcroft	# Drop the diff line leader and expand tabs
2994a0df2efSAndy Whitcroft	$line =~ s/^.//;
3004a0df2efSAndy Whitcroft	$line = expand_tabs($line);
3014a0df2efSAndy Whitcroft
3024a0df2efSAndy Whitcroft	# Pick the indent from the front of the line.
3034a0df2efSAndy Whitcroft	my ($white) = ($line =~ /^(\s*)/);
3044a0df2efSAndy Whitcroft
3054a0df2efSAndy Whitcroft	return (length($line), length($white));
3064a0df2efSAndy Whitcroft}
3074a0df2efSAndy Whitcroft
308773647a0SAndy Whitcroftmy $sanitise_quote = '';
309773647a0SAndy Whitcroft
310773647a0SAndy Whitcroftsub sanitise_line_reset {
311773647a0SAndy Whitcroft	my ($in_comment) = @_;
312773647a0SAndy Whitcroft
313773647a0SAndy Whitcroft	if ($in_comment) {
314773647a0SAndy Whitcroft		$sanitise_quote = '*/';
315773647a0SAndy Whitcroft	} else {
316773647a0SAndy Whitcroft		$sanitise_quote = '';
317773647a0SAndy Whitcroft	}
318773647a0SAndy Whitcroft}
31900df344fSAndy Whitcroftsub sanitise_line {
32000df344fSAndy Whitcroft	my ($line) = @_;
32100df344fSAndy Whitcroft
32200df344fSAndy Whitcroft	my $res = '';
32300df344fSAndy Whitcroft	my $l = '';
32400df344fSAndy Whitcroft
325c2fdda0dSAndy Whitcroft	my $qlen = 0;
326773647a0SAndy Whitcroft	my $off = 0;
327773647a0SAndy Whitcroft	my $c;
32800df344fSAndy Whitcroft
329773647a0SAndy Whitcroft	# Always copy over the diff marker.
330773647a0SAndy Whitcroft	$res = substr($line, 0, 1);
331773647a0SAndy Whitcroft
332773647a0SAndy Whitcroft	for ($off = 1; $off < length($line); $off++) {
333773647a0SAndy Whitcroft		$c = substr($line, $off, 1);
334773647a0SAndy Whitcroft
335773647a0SAndy Whitcroft		# Comments we are wacking completly including the begin
336773647a0SAndy Whitcroft		# and end, all to $;.
337773647a0SAndy Whitcroft		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
338773647a0SAndy Whitcroft			$sanitise_quote = '*/';
339773647a0SAndy Whitcroft
340773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
341773647a0SAndy Whitcroft			$off++;
34200df344fSAndy Whitcroft			next;
343773647a0SAndy Whitcroft		}
34481bc0e02SAndy Whitcroft		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
345773647a0SAndy Whitcroft			$sanitise_quote = '';
346773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
347773647a0SAndy Whitcroft			$off++;
348773647a0SAndy Whitcroft			next;
349773647a0SAndy Whitcroft		}
350773647a0SAndy Whitcroft
351773647a0SAndy Whitcroft		# A \ in a string means ignore the next character.
352773647a0SAndy Whitcroft		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
353773647a0SAndy Whitcroft		    $c eq "\\") {
354773647a0SAndy Whitcroft			substr($res, $off, 2, 'XX');
355773647a0SAndy Whitcroft			$off++;
356773647a0SAndy Whitcroft			next;
357773647a0SAndy Whitcroft		}
358773647a0SAndy Whitcroft		# Regular quotes.
359773647a0SAndy Whitcroft		if ($c eq "'" || $c eq '"') {
360773647a0SAndy Whitcroft			if ($sanitise_quote eq '') {
361773647a0SAndy Whitcroft				$sanitise_quote = $c;
362773647a0SAndy Whitcroft
363773647a0SAndy Whitcroft				substr($res, $off, 1, $c);
364773647a0SAndy Whitcroft				next;
365773647a0SAndy Whitcroft			} elsif ($sanitise_quote eq $c) {
366773647a0SAndy Whitcroft				$sanitise_quote = '';
36700df344fSAndy Whitcroft			}
36800df344fSAndy Whitcroft		}
369773647a0SAndy Whitcroft
370773647a0SAndy Whitcroft		#print "SQ:$sanitise_quote\n";
371773647a0SAndy Whitcroft		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
372773647a0SAndy Whitcroft			substr($res, $off, 1, $;);
373773647a0SAndy Whitcroft		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
374773647a0SAndy Whitcroft			substr($res, $off, 1, 'X');
37500df344fSAndy Whitcroft		} else {
376773647a0SAndy Whitcroft			substr($res, $off, 1, $c);
37700df344fSAndy Whitcroft		}
378c2fdda0dSAndy Whitcroft	}
379c2fdda0dSAndy Whitcroft
380c2fdda0dSAndy Whitcroft	# The pathname on a #include may be surrounded by '<' and '>'.
381c45dcabdSAndy Whitcroft	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
382c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
383c2fdda0dSAndy Whitcroft		$res =~ s@\<.*\>@<$clean>@;
384c2fdda0dSAndy Whitcroft
385c2fdda0dSAndy Whitcroft	# The whole of a #error is a string.
386c45dcabdSAndy Whitcroft	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
387c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
388c45dcabdSAndy Whitcroft		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
389c2fdda0dSAndy Whitcroft	}
390c2fdda0dSAndy Whitcroft
39100df344fSAndy Whitcroft	return $res;
39200df344fSAndy Whitcroft}
39300df344fSAndy Whitcroft
3948905a67cSAndy Whitcroftsub ctx_statement_block {
3958905a67cSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
3968905a67cSAndy Whitcroft	my $line = $linenr - 1;
3978905a67cSAndy Whitcroft	my $blk = '';
3988905a67cSAndy Whitcroft	my $soff = $off;
3998905a67cSAndy Whitcroft	my $coff = $off - 1;
400773647a0SAndy Whitcroft	my $coff_set = 0;
4018905a67cSAndy Whitcroft
40213214adfSAndy Whitcroft	my $loff = 0;
40313214adfSAndy Whitcroft
4048905a67cSAndy Whitcroft	my $type = '';
4058905a67cSAndy Whitcroft	my $level = 0;
406cf655043SAndy Whitcroft	my $p;
4078905a67cSAndy Whitcroft	my $c;
4088905a67cSAndy Whitcroft	my $len = 0;
40913214adfSAndy Whitcroft
41013214adfSAndy Whitcroft	my $remainder;
4118905a67cSAndy Whitcroft	while (1) {
412773647a0SAndy Whitcroft		#warn "CSB: blk<$blk> remain<$remain>\n";
4138905a67cSAndy Whitcroft		# If we are about to drop off the end, pull in more
4148905a67cSAndy Whitcroft		# context.
4158905a67cSAndy Whitcroft		if ($off >= $len) {
4168905a67cSAndy Whitcroft			for (; $remain > 0; $line++) {
417dea33496SAndy Whitcroft				last if (!defined $lines[$line]);
418c2fdda0dSAndy Whitcroft				next if ($lines[$line] =~ /^-/);
4198905a67cSAndy Whitcroft				$remain--;
42013214adfSAndy Whitcroft				$loff = $len;
421c2fdda0dSAndy Whitcroft				$blk .= $lines[$line] . "\n";
4228905a67cSAndy Whitcroft				$len = length($blk);
4238905a67cSAndy Whitcroft				$line++;
4248905a67cSAndy Whitcroft				last;
4258905a67cSAndy Whitcroft			}
4268905a67cSAndy Whitcroft			# Bail if there is no further context.
4278905a67cSAndy Whitcroft			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
42813214adfSAndy Whitcroft			if ($off >= $len) {
4298905a67cSAndy Whitcroft				last;
4308905a67cSAndy Whitcroft			}
4318905a67cSAndy Whitcroft		}
432cf655043SAndy Whitcroft		$p = $c;
4338905a67cSAndy Whitcroft		$c = substr($blk, $off, 1);
43413214adfSAndy Whitcroft		$remainder = substr($blk, $off);
4358905a67cSAndy Whitcroft
436773647a0SAndy Whitcroft		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
4378905a67cSAndy Whitcroft		# Statement ends at the ';' or a close '}' at the
4388905a67cSAndy Whitcroft		# outermost level.
4398905a67cSAndy Whitcroft		if ($level == 0 && $c eq ';') {
4408905a67cSAndy Whitcroft			last;
4418905a67cSAndy Whitcroft		}
4428905a67cSAndy Whitcroft
44313214adfSAndy Whitcroft		# An else is really a conditional as long as its not else if
444773647a0SAndy Whitcroft		if ($level == 0 && $coff_set == 0 &&
445773647a0SAndy Whitcroft				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
446773647a0SAndy Whitcroft				$remainder =~ /^(else)(?:\s|{)/ &&
447773647a0SAndy Whitcroft				$remainder !~ /^else\s+if\b/) {
448773647a0SAndy Whitcroft			$coff = $off + length($1) - 1;
449773647a0SAndy Whitcroft			$coff_set = 1;
450773647a0SAndy Whitcroft			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
451773647a0SAndy Whitcroft			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
45213214adfSAndy Whitcroft		}
45313214adfSAndy Whitcroft
4548905a67cSAndy Whitcroft		if (($type eq '' || $type eq '(') && $c eq '(') {
4558905a67cSAndy Whitcroft			$level++;
4568905a67cSAndy Whitcroft			$type = '(';
4578905a67cSAndy Whitcroft		}
4588905a67cSAndy Whitcroft		if ($type eq '(' && $c eq ')') {
4598905a67cSAndy Whitcroft			$level--;
4608905a67cSAndy Whitcroft			$type = ($level != 0)? '(' : '';
4618905a67cSAndy Whitcroft
4628905a67cSAndy Whitcroft			if ($level == 0 && $coff < $soff) {
4638905a67cSAndy Whitcroft				$coff = $off;
464773647a0SAndy Whitcroft				$coff_set = 1;
465773647a0SAndy Whitcroft				#warn "CSB: mark coff<$coff>\n";
4668905a67cSAndy Whitcroft			}
4678905a67cSAndy Whitcroft		}
4688905a67cSAndy Whitcroft		if (($type eq '' || $type eq '{') && $c eq '{') {
4698905a67cSAndy Whitcroft			$level++;
4708905a67cSAndy Whitcroft			$type = '{';
4718905a67cSAndy Whitcroft		}
4728905a67cSAndy Whitcroft		if ($type eq '{' && $c eq '}') {
4738905a67cSAndy Whitcroft			$level--;
4748905a67cSAndy Whitcroft			$type = ($level != 0)? '{' : '';
4758905a67cSAndy Whitcroft
4768905a67cSAndy Whitcroft			if ($level == 0) {
4778905a67cSAndy Whitcroft				last;
4788905a67cSAndy Whitcroft			}
4798905a67cSAndy Whitcroft		}
4808905a67cSAndy Whitcroft		$off++;
4818905a67cSAndy Whitcroft	}
482a3bb97a7SAndy Whitcroft	# We are truly at the end, so shuffle to the next line.
48313214adfSAndy Whitcroft	if ($off == $len) {
484a3bb97a7SAndy Whitcroft		$loff = $len + 1;
48513214adfSAndy Whitcroft		$line++;
48613214adfSAndy Whitcroft		$remain--;
48713214adfSAndy Whitcroft	}
4888905a67cSAndy Whitcroft
4898905a67cSAndy Whitcroft	my $statement = substr($blk, $soff, $off - $soff + 1);
4908905a67cSAndy Whitcroft	my $condition = substr($blk, $soff, $coff - $soff + 1);
4918905a67cSAndy Whitcroft
4928905a67cSAndy Whitcroft	#warn "STATEMENT<$statement>\n";
4938905a67cSAndy Whitcroft	#warn "CONDITION<$condition>\n";
4948905a67cSAndy Whitcroft
495773647a0SAndy Whitcroft	#print "coff<$coff> soff<$off> loff<$loff>\n";
49613214adfSAndy Whitcroft
49713214adfSAndy Whitcroft	return ($statement, $condition,
49813214adfSAndy Whitcroft			$line, $remain + 1, $off - $loff + 1, $level);
49913214adfSAndy Whitcroft}
50013214adfSAndy Whitcroft
501cf655043SAndy Whitcroftsub statement_lines {
502cf655043SAndy Whitcroft	my ($stmt) = @_;
503cf655043SAndy Whitcroft
504cf655043SAndy Whitcroft	# Strip the diff line prefixes and rip blank lines at start and end.
505cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
506cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
507cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
508cf655043SAndy Whitcroft
509cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
510cf655043SAndy Whitcroft
511cf655043SAndy Whitcroft	return $#stmt_lines + 2;
512cf655043SAndy Whitcroft}
513cf655043SAndy Whitcroft
514cf655043SAndy Whitcroftsub statement_rawlines {
515cf655043SAndy Whitcroft	my ($stmt) = @_;
516cf655043SAndy Whitcroft
517cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
518cf655043SAndy Whitcroft
519cf655043SAndy Whitcroft	return $#stmt_lines + 2;
520cf655043SAndy Whitcroft}
521cf655043SAndy Whitcroft
522cf655043SAndy Whitcroftsub statement_block_size {
523cf655043SAndy Whitcroft	my ($stmt) = @_;
524cf655043SAndy Whitcroft
525cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
526cf655043SAndy Whitcroft	$stmt =~ s/^\s*{//;
527cf655043SAndy Whitcroft	$stmt =~ s/}\s*$//;
528cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
529cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
530cf655043SAndy Whitcroft
531cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
532cf655043SAndy Whitcroft	my @stmt_statements = ($stmt =~ /;/g);
533cf655043SAndy Whitcroft
534cf655043SAndy Whitcroft	my $stmt_lines = $#stmt_lines + 2;
535cf655043SAndy Whitcroft	my $stmt_statements = $#stmt_statements + 1;
536cf655043SAndy Whitcroft
537cf655043SAndy Whitcroft	if ($stmt_lines > $stmt_statements) {
538cf655043SAndy Whitcroft		return $stmt_lines;
539cf655043SAndy Whitcroft	} else {
540cf655043SAndy Whitcroft		return $stmt_statements;
541cf655043SAndy Whitcroft	}
542cf655043SAndy Whitcroft}
543cf655043SAndy Whitcroft
54413214adfSAndy Whitcroftsub ctx_statement_full {
54513214adfSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
54613214adfSAndy Whitcroft	my ($statement, $condition, $level);
54713214adfSAndy Whitcroft
54813214adfSAndy Whitcroft	my (@chunks);
54913214adfSAndy Whitcroft
550cf655043SAndy Whitcroft	# Grab the first conditional/block pair.
55113214adfSAndy Whitcroft	($statement, $condition, $linenr, $remain, $off, $level) =
55213214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
553773647a0SAndy Whitcroft	#print "F: c<$condition> s<$statement> remain<$remain>\n";
55413214adfSAndy Whitcroft	push(@chunks, [ $condition, $statement ]);
555cf655043SAndy Whitcroft	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
556cf655043SAndy Whitcroft		return ($level, $linenr, @chunks);
557cf655043SAndy Whitcroft	}
558cf655043SAndy Whitcroft
559cf655043SAndy Whitcroft	# Pull in the following conditional/block pairs and see if they
560cf655043SAndy Whitcroft	# could continue the statement.
561cf655043SAndy Whitcroft	for (;;) {
56213214adfSAndy Whitcroft		($statement, $condition, $linenr, $remain, $off, $level) =
56313214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
564cf655043SAndy Whitcroft		#print "C: c<$condition> s<$statement> remain<$remain>\n";
565773647a0SAndy Whitcroft		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
566cf655043SAndy Whitcroft		#print "C: push\n";
567cf655043SAndy Whitcroft		push(@chunks, [ $condition, $statement ]);
56813214adfSAndy Whitcroft	}
56913214adfSAndy Whitcroft
57013214adfSAndy Whitcroft	return ($level, $linenr, @chunks);
5718905a67cSAndy Whitcroft}
5728905a67cSAndy Whitcroft
5734a0df2efSAndy Whitcroftsub ctx_block_get {
574f0a594c1SAndy Whitcroft	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
5754a0df2efSAndy Whitcroft	my $line;
5764a0df2efSAndy Whitcroft	my $start = $linenr - 1;
5774a0df2efSAndy Whitcroft	my $blk = '';
5784a0df2efSAndy Whitcroft	my @o;
5794a0df2efSAndy Whitcroft	my @c;
5804a0df2efSAndy Whitcroft	my @res = ();
5814a0df2efSAndy Whitcroft
582f0a594c1SAndy Whitcroft	my $level = 0;
58300df344fSAndy Whitcroft	for ($line = $start; $remain > 0; $line++) {
58400df344fSAndy Whitcroft		next if ($rawlines[$line] =~ /^-/);
58500df344fSAndy Whitcroft		$remain--;
58600df344fSAndy Whitcroft
58700df344fSAndy Whitcroft		$blk .= $rawlines[$line];
588f0a594c1SAndy Whitcroft		foreach my $c (split(//, $rawlines[$line])) {
589f0a594c1SAndy Whitcroft			##print "C<$c>L<$level><$open$close>O<$off>\n";
590f0a594c1SAndy Whitcroft			if ($off > 0) {
591f0a594c1SAndy Whitcroft				$off--;
592f0a594c1SAndy Whitcroft				next;
593f0a594c1SAndy Whitcroft			}
5944a0df2efSAndy Whitcroft
595f0a594c1SAndy Whitcroft			if ($c eq $close && $level > 0) {
596f0a594c1SAndy Whitcroft				$level--;
597f0a594c1SAndy Whitcroft				last if ($level == 0);
598f0a594c1SAndy Whitcroft			} elsif ($c eq $open) {
599f0a594c1SAndy Whitcroft				$level++;
600f0a594c1SAndy Whitcroft			}
601f0a594c1SAndy Whitcroft		}
6024a0df2efSAndy Whitcroft
603f0a594c1SAndy Whitcroft		if (!$outer || $level <= 1) {
60400df344fSAndy Whitcroft			push(@res, $rawlines[$line]);
6054a0df2efSAndy Whitcroft		}
6064a0df2efSAndy Whitcroft
607f0a594c1SAndy Whitcroft		last if ($level == 0);
6084a0df2efSAndy Whitcroft	}
6094a0df2efSAndy Whitcroft
610f0a594c1SAndy Whitcroft	return ($level, @res);
6114a0df2efSAndy Whitcroft}
6124a0df2efSAndy Whitcroftsub ctx_block_outer {
6134a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
6144a0df2efSAndy Whitcroft
615f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
616f0a594c1SAndy Whitcroft	return @r;
6174a0df2efSAndy Whitcroft}
6184a0df2efSAndy Whitcroftsub ctx_block {
6194a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
6204a0df2efSAndy Whitcroft
621f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
622f0a594c1SAndy Whitcroft	return @r;
623653d4876SAndy Whitcroft}
624653d4876SAndy Whitcroftsub ctx_statement {
625f0a594c1SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
626f0a594c1SAndy Whitcroft
627f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
628f0a594c1SAndy Whitcroft	return @r;
629f0a594c1SAndy Whitcroft}
630f0a594c1SAndy Whitcroftsub ctx_block_level {
631653d4876SAndy Whitcroft	my ($linenr, $remain) = @_;
632653d4876SAndy Whitcroft
633f0a594c1SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
6344a0df2efSAndy Whitcroft}
6359c0ca6f9SAndy Whitcroftsub ctx_statement_level {
6369c0ca6f9SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
6379c0ca6f9SAndy Whitcroft
6389c0ca6f9SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
6399c0ca6f9SAndy Whitcroft}
6404a0df2efSAndy Whitcroft
6414a0df2efSAndy Whitcroftsub ctx_locate_comment {
6424a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
6434a0df2efSAndy Whitcroft
6444a0df2efSAndy Whitcroft	# Catch a comment on the end of the line itself.
645beae6332SAndy Whitcroft	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
6464a0df2efSAndy Whitcroft	return $current_comment if (defined $current_comment);
6474a0df2efSAndy Whitcroft
6484a0df2efSAndy Whitcroft	# Look through the context and try and figure out if there is a
6494a0df2efSAndy Whitcroft	# comment.
6504a0df2efSAndy Whitcroft	my $in_comment = 0;
6514a0df2efSAndy Whitcroft	$current_comment = '';
6524a0df2efSAndy Whitcroft	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
65300df344fSAndy Whitcroft		my $line = $rawlines[$linenr - 1];
65400df344fSAndy Whitcroft		#warn "           $line\n";
6554a0df2efSAndy Whitcroft		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
6564a0df2efSAndy Whitcroft			$in_comment = 1;
6574a0df2efSAndy Whitcroft		}
6584a0df2efSAndy Whitcroft		if ($line =~ m@/\*@) {
6594a0df2efSAndy Whitcroft			$in_comment = 1;
6604a0df2efSAndy Whitcroft		}
6614a0df2efSAndy Whitcroft		if (!$in_comment && $current_comment ne '') {
6624a0df2efSAndy Whitcroft			$current_comment = '';
6634a0df2efSAndy Whitcroft		}
6644a0df2efSAndy Whitcroft		$current_comment .= $line . "\n" if ($in_comment);
6654a0df2efSAndy Whitcroft		if ($line =~ m@\*/@) {
6664a0df2efSAndy Whitcroft			$in_comment = 0;
6674a0df2efSAndy Whitcroft		}
6684a0df2efSAndy Whitcroft	}
6694a0df2efSAndy Whitcroft
6704a0df2efSAndy Whitcroft	chomp($current_comment);
6714a0df2efSAndy Whitcroft	return($current_comment);
6724a0df2efSAndy Whitcroft}
6734a0df2efSAndy Whitcroftsub ctx_has_comment {
6744a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
6754a0df2efSAndy Whitcroft	my $cmt = ctx_locate_comment($first_line, $end_line);
6764a0df2efSAndy Whitcroft
67700df344fSAndy Whitcroft	##print "LINE: $rawlines[$end_line - 1 ]\n";
6784a0df2efSAndy Whitcroft	##print "CMMT: $cmt\n";
6794a0df2efSAndy Whitcroft
6804a0df2efSAndy Whitcroft	return ($cmt ne '');
6814a0df2efSAndy Whitcroft}
6824a0df2efSAndy Whitcroft
6834d001e4dSAndy Whitcroftsub raw_line {
6844d001e4dSAndy Whitcroft	my ($linenr, $cnt) = @_;
6854d001e4dSAndy Whitcroft
6864d001e4dSAndy Whitcroft	my $offset = $linenr - 1;
6874d001e4dSAndy Whitcroft	$cnt++;
6884d001e4dSAndy Whitcroft
6894d001e4dSAndy Whitcroft	my $line;
6904d001e4dSAndy Whitcroft	while ($cnt) {
6914d001e4dSAndy Whitcroft		$line = $rawlines[$offset++];
6924d001e4dSAndy Whitcroft		next if (defined($line) && $line =~ /^-/);
6934d001e4dSAndy Whitcroft		$cnt--;
6944d001e4dSAndy Whitcroft	}
6954d001e4dSAndy Whitcroft
6964d001e4dSAndy Whitcroft	return $line;
6974d001e4dSAndy Whitcroft}
6984d001e4dSAndy Whitcroft
6990a920b5bSAndy Whitcroftsub cat_vet {
7000a920b5bSAndy Whitcroft	my ($vet) = @_;
7019c0ca6f9SAndy Whitcroft	my ($res, $coded);
7020a920b5bSAndy Whitcroft
7039c0ca6f9SAndy Whitcroft	$res = '';
7046c72ffaaSAndy Whitcroft	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
7056c72ffaaSAndy Whitcroft		$res .= $1;
7066c72ffaaSAndy Whitcroft		if ($2 ne '') {
7079c0ca6f9SAndy Whitcroft			$coded = sprintf("^%c", unpack('C', $2) + 64);
7086c72ffaaSAndy Whitcroft			$res .= $coded;
7096c72ffaaSAndy Whitcroft		}
7109c0ca6f9SAndy Whitcroft	}
7119c0ca6f9SAndy Whitcroft	$res =~ s/$/\$/;
7120a920b5bSAndy Whitcroft
7139c0ca6f9SAndy Whitcroft	return $res;
7140a920b5bSAndy Whitcroft}
7150a920b5bSAndy Whitcroft
716c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0;
717cf655043SAndy Whitcroftmy $av_pending;
718c2fdda0dSAndy Whitcroftmy @av_paren_type;
7191f65f947SAndy Whitcroftmy $av_pend_colon;
720c2fdda0dSAndy Whitcroft
721c2fdda0dSAndy Whitcroftsub annotate_reset {
722c2fdda0dSAndy Whitcroft	$av_preprocessor = 0;
723cf655043SAndy Whitcroft	$av_pending = '_';
724cf655043SAndy Whitcroft	@av_paren_type = ('E');
7251f65f947SAndy Whitcroft	$av_pend_colon = 'O';
726c2fdda0dSAndy Whitcroft}
727c2fdda0dSAndy Whitcroft
7286c72ffaaSAndy Whitcroftsub annotate_values {
7296c72ffaaSAndy Whitcroft	my ($stream, $type) = @_;
7306c72ffaaSAndy Whitcroft
7316c72ffaaSAndy Whitcroft	my $res;
7321f65f947SAndy Whitcroft	my $var = '_' x length($stream);
7336c72ffaaSAndy Whitcroft	my $cur = $stream;
7346c72ffaaSAndy Whitcroft
735c2fdda0dSAndy Whitcroft	print "$stream\n" if ($dbg_values > 1);
7366c72ffaaSAndy Whitcroft
7376c72ffaaSAndy Whitcroft	while (length($cur)) {
738773647a0SAndy Whitcroft		@av_paren_type = ('E') if ($#av_paren_type < 0);
739cf655043SAndy Whitcroft		print " <" . join('', @av_paren_type) .
740171ae1a4SAndy Whitcroft				"> <$type> <$av_pending>" if ($dbg_values > 1);
7416c72ffaaSAndy Whitcroft		if ($cur =~ /^(\s+)/o) {
742c2fdda0dSAndy Whitcroft			print "WS($1)\n" if ($dbg_values > 1);
743c2fdda0dSAndy Whitcroft			if ($1 =~ /\n/ && $av_preprocessor) {
744cf655043SAndy Whitcroft				$type = pop(@av_paren_type);
745c2fdda0dSAndy Whitcroft				$av_preprocessor = 0;
7466c72ffaaSAndy Whitcroft			}
7476c72ffaaSAndy Whitcroft
7488ea3eb9aSAndy Whitcroft		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
749c2fdda0dSAndy Whitcroft			print "DECLARE($1)\n" if ($dbg_values > 1);
7506c72ffaaSAndy Whitcroft			$type = 'T';
7516c72ffaaSAndy Whitcroft
752389a2fe5SAndy Whitcroft		} elsif ($cur =~ /^($Modifier)\s*/) {
753389a2fe5SAndy Whitcroft			print "MODIFIER($1)\n" if ($dbg_values > 1);
754389a2fe5SAndy Whitcroft			$type = 'T';
755389a2fe5SAndy Whitcroft
756c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
757171ae1a4SAndy Whitcroft			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
758c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
759171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
760171ae1a4SAndy Whitcroft			if ($2 ne '') {
761cf655043SAndy Whitcroft				$av_pending = 'N';
762171ae1a4SAndy Whitcroft			}
763171ae1a4SAndy Whitcroft			$type = 'E';
764171ae1a4SAndy Whitcroft
765c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
766171ae1a4SAndy Whitcroft			print "UNDEF($1)\n" if ($dbg_values > 1);
767171ae1a4SAndy Whitcroft			$av_preprocessor = 1;
768171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
7696c72ffaaSAndy Whitcroft
770c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
771cf655043SAndy Whitcroft			print "PRE_START($1)\n" if ($dbg_values > 1);
772c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
773cf655043SAndy Whitcroft
774cf655043SAndy Whitcroft			push(@av_paren_type, $type);
775cf655043SAndy Whitcroft			push(@av_paren_type, $type);
776171ae1a4SAndy Whitcroft			$type = 'E';
777cf655043SAndy Whitcroft
778c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
779cf655043SAndy Whitcroft			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
780cf655043SAndy Whitcroft			$av_preprocessor = 1;
781cf655043SAndy Whitcroft
782cf655043SAndy Whitcroft			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
783cf655043SAndy Whitcroft
784171ae1a4SAndy Whitcroft			$type = 'E';
785cf655043SAndy Whitcroft
786c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
787cf655043SAndy Whitcroft			print "PRE_END($1)\n" if ($dbg_values > 1);
788cf655043SAndy Whitcroft
789cf655043SAndy Whitcroft			$av_preprocessor = 1;
790cf655043SAndy Whitcroft
791cf655043SAndy Whitcroft			# Assume all arms of the conditional end as this
792cf655043SAndy Whitcroft			# one does, and continue as if the #endif was not here.
793cf655043SAndy Whitcroft			pop(@av_paren_type);
794cf655043SAndy Whitcroft			push(@av_paren_type, $type);
795171ae1a4SAndy Whitcroft			$type = 'E';
7966c72ffaaSAndy Whitcroft
7976c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\\\n)/o) {
798c2fdda0dSAndy Whitcroft			print "PRECONT($1)\n" if ($dbg_values > 1);
7996c72ffaaSAndy Whitcroft
800171ae1a4SAndy Whitcroft		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
801171ae1a4SAndy Whitcroft			print "ATTR($1)\n" if ($dbg_values > 1);
802171ae1a4SAndy Whitcroft			$av_pending = $type;
803171ae1a4SAndy Whitcroft			$type = 'N';
804171ae1a4SAndy Whitcroft
8056c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
806c2fdda0dSAndy Whitcroft			print "SIZEOF($1)\n" if ($dbg_values > 1);
8076c72ffaaSAndy Whitcroft			if (defined $2) {
808cf655043SAndy Whitcroft				$av_pending = 'V';
8096c72ffaaSAndy Whitcroft			}
8106c72ffaaSAndy Whitcroft			$type = 'N';
8116c72ffaaSAndy Whitcroft
81214b111c1SAndy Whitcroft		} elsif ($cur =~ /^(if|while|for)\b/o) {
813c2fdda0dSAndy Whitcroft			print "COND($1)\n" if ($dbg_values > 1);
81414b111c1SAndy Whitcroft			$av_pending = 'E';
8156c72ffaaSAndy Whitcroft			$type = 'N';
8166c72ffaaSAndy Whitcroft
8171f65f947SAndy Whitcroft		} elsif ($cur =~/^(case)/o) {
8181f65f947SAndy Whitcroft			print "CASE($1)\n" if ($dbg_values > 1);
8191f65f947SAndy Whitcroft			$av_pend_colon = 'C';
8201f65f947SAndy Whitcroft			$type = 'N';
8211f65f947SAndy Whitcroft
82214b111c1SAndy Whitcroft		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
823c2fdda0dSAndy Whitcroft			print "KEYWORD($1)\n" if ($dbg_values > 1);
8246c72ffaaSAndy Whitcroft			$type = 'N';
8256c72ffaaSAndy Whitcroft
8266c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\()/o) {
827c2fdda0dSAndy Whitcroft			print "PAREN('$1')\n" if ($dbg_values > 1);
828cf655043SAndy Whitcroft			push(@av_paren_type, $av_pending);
829cf655043SAndy Whitcroft			$av_pending = '_';
8306c72ffaaSAndy Whitcroft			$type = 'N';
8316c72ffaaSAndy Whitcroft
8326c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\))/o) {
833cf655043SAndy Whitcroft			my $new_type = pop(@av_paren_type);
834cf655043SAndy Whitcroft			if ($new_type ne '_') {
835cf655043SAndy Whitcroft				$type = $new_type;
836c2fdda0dSAndy Whitcroft				print "PAREN('$1') -> $type\n"
837c2fdda0dSAndy Whitcroft							if ($dbg_values > 1);
8386c72ffaaSAndy Whitcroft			} else {
839c2fdda0dSAndy Whitcroft				print "PAREN('$1')\n" if ($dbg_values > 1);
8406c72ffaaSAndy Whitcroft			}
8416c72ffaaSAndy Whitcroft
842c8cb2ca3SAndy Whitcroft		} elsif ($cur =~ /^($Ident)\s*\(/o) {
843c2fdda0dSAndy Whitcroft			print "FUNC($1)\n" if ($dbg_values > 1);
844c8cb2ca3SAndy Whitcroft			$type = 'V';
845cf655043SAndy Whitcroft			$av_pending = 'V';
8466c72ffaaSAndy Whitcroft
8471f65f947SAndy Whitcroft		} elsif ($cur =~ /^($Ident\s*):/) {
8481f65f947SAndy Whitcroft			if ($type eq 'E') {
8491f65f947SAndy Whitcroft				$av_pend_colon = 'L';
8501f65f947SAndy Whitcroft			} elsif ($type eq 'T') {
8511f65f947SAndy Whitcroft				$av_pend_colon = 'B';
8521f65f947SAndy Whitcroft			}
8531f65f947SAndy Whitcroft			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
8541f65f947SAndy Whitcroft			$type = 'V';
8551f65f947SAndy Whitcroft
8566c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Ident|$Constant)/o) {
857c2fdda0dSAndy Whitcroft			print "IDENT($1)\n" if ($dbg_values > 1);
8586c72ffaaSAndy Whitcroft			$type = 'V';
8596c72ffaaSAndy Whitcroft
8606c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Assignment)/o) {
861c2fdda0dSAndy Whitcroft			print "ASSIGN($1)\n" if ($dbg_values > 1);
8626c72ffaaSAndy Whitcroft			$type = 'N';
8636c72ffaaSAndy Whitcroft
864cf655043SAndy Whitcroft		} elsif ($cur =~/^(;|{|})/) {
865c2fdda0dSAndy Whitcroft			print "END($1)\n" if ($dbg_values > 1);
86613214adfSAndy Whitcroft			$type = 'E';
8671f65f947SAndy Whitcroft			$av_pend_colon = 'O';
86813214adfSAndy Whitcroft
8691f65f947SAndy Whitcroft		} elsif ($cur =~ /^(\?)/o) {
8701f65f947SAndy Whitcroft			print "QUESTION($1)\n" if ($dbg_values > 1);
8711f65f947SAndy Whitcroft			$type = 'N';
8721f65f947SAndy Whitcroft
8731f65f947SAndy Whitcroft		} elsif ($cur =~ /^(:)/o) {
8741f65f947SAndy Whitcroft			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
8751f65f947SAndy Whitcroft
8761f65f947SAndy Whitcroft			substr($var, length($res), 1, $av_pend_colon);
8771f65f947SAndy Whitcroft			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
8781f65f947SAndy Whitcroft				$type = 'E';
8791f65f947SAndy Whitcroft			} else {
8801f65f947SAndy Whitcroft				$type = 'N';
8811f65f947SAndy Whitcroft			}
8821f65f947SAndy Whitcroft			$av_pend_colon = 'O';
8831f65f947SAndy Whitcroft
8841f65f947SAndy Whitcroft		} elsif ($cur =~ /^(;|\[)/o) {
88513214adfSAndy Whitcroft			print "CLOSE($1)\n" if ($dbg_values > 1);
8866c72ffaaSAndy Whitcroft			$type = 'N';
8876c72ffaaSAndy Whitcroft
8880d413866SAndy Whitcroft		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
88974048ed8SAndy Whitcroft			my $variant;
89074048ed8SAndy Whitcroft
89174048ed8SAndy Whitcroft			print "OPV($1)\n" if ($dbg_values > 1);
89274048ed8SAndy Whitcroft			if ($type eq 'V') {
89374048ed8SAndy Whitcroft				$variant = 'B';
89474048ed8SAndy Whitcroft			} else {
89574048ed8SAndy Whitcroft				$variant = 'U';
89674048ed8SAndy Whitcroft			}
89774048ed8SAndy Whitcroft
89874048ed8SAndy Whitcroft			substr($var, length($res), 1, $variant);
89974048ed8SAndy Whitcroft			$type = 'N';
90074048ed8SAndy Whitcroft
9016c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Operators)/o) {
902c2fdda0dSAndy Whitcroft			print "OP($1)\n" if ($dbg_values > 1);
9036c72ffaaSAndy Whitcroft			if ($1 ne '++' && $1 ne '--') {
9046c72ffaaSAndy Whitcroft				$type = 'N';
9056c72ffaaSAndy Whitcroft			}
9066c72ffaaSAndy Whitcroft
9076c72ffaaSAndy Whitcroft		} elsif ($cur =~ /(^.)/o) {
908c2fdda0dSAndy Whitcroft			print "C($1)\n" if ($dbg_values > 1);
9096c72ffaaSAndy Whitcroft		}
9106c72ffaaSAndy Whitcroft		if (defined $1) {
9116c72ffaaSAndy Whitcroft			$cur = substr($cur, length($1));
9126c72ffaaSAndy Whitcroft			$res .= $type x length($1);
9136c72ffaaSAndy Whitcroft		}
9146c72ffaaSAndy Whitcroft	}
9156c72ffaaSAndy Whitcroft
9161f65f947SAndy Whitcroft	return ($res, $var);
9176c72ffaaSAndy Whitcroft}
9186c72ffaaSAndy Whitcroft
9198905a67cSAndy Whitcroftsub possible {
92013214adfSAndy Whitcroft	my ($possible, $line) = @_;
9218905a67cSAndy Whitcroft
9220776e594SAndy Whitcroft	print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
9230776e594SAndy Whitcroft	if ($possible !~ /(?:
9240776e594SAndy Whitcroft		^(?:
9250776e594SAndy Whitcroft			$Modifier|
9260776e594SAndy Whitcroft			$Storage|
9270776e594SAndy Whitcroft			$Type|
9280776e594SAndy Whitcroft			DEFINE_\S+|
9290776e594SAndy Whitcroft			goto|
9300776e594SAndy Whitcroft			return|
9310776e594SAndy Whitcroft			case|
9320776e594SAndy Whitcroft			else|
9330776e594SAndy Whitcroft			asm|__asm__|
9340776e594SAndy Whitcroft			do
9350776e594SAndy Whitcroft		)$|
9360776e594SAndy Whitcroft		^(?:typedef|struct|enum)\b
9370776e594SAndy Whitcroft	    )/x) {
938c45dcabdSAndy Whitcroft		# Check for modifiers.
939c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Storage\s*//g;
940c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Sparse\s*//g;
941c45dcabdSAndy Whitcroft		if ($possible =~ /^\s*$/) {
942c45dcabdSAndy Whitcroft
943c45dcabdSAndy Whitcroft		} elsif ($possible =~ /\s/) {
944c45dcabdSAndy Whitcroft			$possible =~ s/\s*$Type\s*//g;
945d2506586SAndy Whitcroft			for my $modifier (split(' ', $possible)) {
946d2506586SAndy Whitcroft				warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
947d2506586SAndy Whitcroft				push(@modifierList, $modifier);
948d2506586SAndy Whitcroft			}
949c45dcabdSAndy Whitcroft
950c45dcabdSAndy Whitcroft		} else {
95113214adfSAndy Whitcroft			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
9528905a67cSAndy Whitcroft			push(@typeList, $possible);
953c45dcabdSAndy Whitcroft		}
9548905a67cSAndy Whitcroft		build_types();
9550776e594SAndy Whitcroft	} else {
9560776e594SAndy Whitcroft		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
9578905a67cSAndy Whitcroft	}
9588905a67cSAndy Whitcroft}
9598905a67cSAndy Whitcroft
9606c72ffaaSAndy Whitcroftmy $prefix = '';
9616c72ffaaSAndy Whitcroft
962f0a594c1SAndy Whitcroftsub report {
963773647a0SAndy Whitcroft	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
964773647a0SAndy Whitcroft		return 0;
965773647a0SAndy Whitcroft	}
9668905a67cSAndy Whitcroft	my $line = $prefix . $_[0];
9678905a67cSAndy Whitcroft
9688905a67cSAndy Whitcroft	$line = (split('\n', $line))[0] . "\n" if ($terse);
9698905a67cSAndy Whitcroft
97013214adfSAndy Whitcroft	push(our @report, $line);
971773647a0SAndy Whitcroft
972773647a0SAndy Whitcroft	return 1;
973f0a594c1SAndy Whitcroft}
974f0a594c1SAndy Whitcroftsub report_dump {
97513214adfSAndy Whitcroft	our @report;
976f0a594c1SAndy Whitcroft}
977de7d4f0eSAndy Whitcroftsub ERROR {
978773647a0SAndy Whitcroft	if (report("ERROR: $_[0]\n")) {
979de7d4f0eSAndy Whitcroft		our $clean = 0;
9806c72ffaaSAndy Whitcroft		our $cnt_error++;
981de7d4f0eSAndy Whitcroft	}
982773647a0SAndy Whitcroft}
983de7d4f0eSAndy Whitcroftsub WARN {
984773647a0SAndy Whitcroft	if (report("WARNING: $_[0]\n")) {
985de7d4f0eSAndy Whitcroft		our $clean = 0;
9866c72ffaaSAndy Whitcroft		our $cnt_warn++;
987de7d4f0eSAndy Whitcroft	}
988773647a0SAndy Whitcroft}
989de7d4f0eSAndy Whitcroftsub CHK {
990773647a0SAndy Whitcroft	if ($check && report("CHECK: $_[0]\n")) {
991de7d4f0eSAndy Whitcroft		our $clean = 0;
9926c72ffaaSAndy Whitcroft		our $cnt_chk++;
9936c72ffaaSAndy Whitcroft	}
994de7d4f0eSAndy Whitcroft}
995de7d4f0eSAndy Whitcroft
9966ecd9674SAndy Whitcroftsub check_absolute_file {
9976ecd9674SAndy Whitcroft	my ($absolute, $herecurr) = @_;
9986ecd9674SAndy Whitcroft	my $file = $absolute;
9996ecd9674SAndy Whitcroft
10006ecd9674SAndy Whitcroft	##print "absolute<$absolute>\n";
10016ecd9674SAndy Whitcroft
10026ecd9674SAndy Whitcroft	# See if any suffix of this path is a path within the tree.
10036ecd9674SAndy Whitcroft	while ($file =~ s@^[^/]*/@@) {
10046ecd9674SAndy Whitcroft		if (-f "$root/$file") {
10056ecd9674SAndy Whitcroft			##print "file<$file>\n";
10066ecd9674SAndy Whitcroft			last;
10076ecd9674SAndy Whitcroft		}
10086ecd9674SAndy Whitcroft	}
10096ecd9674SAndy Whitcroft	if (! -f _)  {
10106ecd9674SAndy Whitcroft		return 0;
10116ecd9674SAndy Whitcroft	}
10126ecd9674SAndy Whitcroft
10136ecd9674SAndy Whitcroft	# It is, so see if the prefix is acceptable.
10146ecd9674SAndy Whitcroft	my $prefix = $absolute;
10156ecd9674SAndy Whitcroft	substr($prefix, -length($file)) = '';
10166ecd9674SAndy Whitcroft
10176ecd9674SAndy Whitcroft	##print "prefix<$prefix>\n";
10186ecd9674SAndy Whitcroft	if ($prefix ne ".../") {
10196ecd9674SAndy Whitcroft		WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
10206ecd9674SAndy Whitcroft	}
10216ecd9674SAndy Whitcroft}
10226ecd9674SAndy Whitcroft
10230a920b5bSAndy Whitcroftsub process {
10240a920b5bSAndy Whitcroft	my $filename = shift;
10250a920b5bSAndy Whitcroft
10260a920b5bSAndy Whitcroft	my $linenr=0;
10270a920b5bSAndy Whitcroft	my $prevline="";
1028c2fdda0dSAndy Whitcroft	my $prevrawline="";
10290a920b5bSAndy Whitcroft	my $stashline="";
1030c2fdda0dSAndy Whitcroft	my $stashrawline="";
10310a920b5bSAndy Whitcroft
10324a0df2efSAndy Whitcroft	my $length;
10330a920b5bSAndy Whitcroft	my $indent;
10340a920b5bSAndy Whitcroft	my $previndent=0;
10350a920b5bSAndy Whitcroft	my $stashindent=0;
10360a920b5bSAndy Whitcroft
1037de7d4f0eSAndy Whitcroft	our $clean = 1;
10380a920b5bSAndy Whitcroft	my $signoff = 0;
10390a920b5bSAndy Whitcroft	my $is_patch = 0;
10400a920b5bSAndy Whitcroft
104113214adfSAndy Whitcroft	our @report = ();
10426c72ffaaSAndy Whitcroft	our $cnt_lines = 0;
10436c72ffaaSAndy Whitcroft	our $cnt_error = 0;
10446c72ffaaSAndy Whitcroft	our $cnt_warn = 0;
10456c72ffaaSAndy Whitcroft	our $cnt_chk = 0;
10466c72ffaaSAndy Whitcroft
10470a920b5bSAndy Whitcroft	# Trace the real file/line as we go.
10480a920b5bSAndy Whitcroft	my $realfile = '';
10490a920b5bSAndy Whitcroft	my $realline = 0;
10500a920b5bSAndy Whitcroft	my $realcnt = 0;
10510a920b5bSAndy Whitcroft	my $here = '';
10520a920b5bSAndy Whitcroft	my $in_comment = 0;
1053c2fdda0dSAndy Whitcroft	my $comment_edge = 0;
10540a920b5bSAndy Whitcroft	my $first_line = 0;
10550a920b5bSAndy Whitcroft
105613214adfSAndy Whitcroft	my $prev_values = 'E';
105713214adfSAndy Whitcroft
105813214adfSAndy Whitcroft	# suppression flags
1059773647a0SAndy Whitcroft	my %suppress_ifbraces;
1060170d3a22SAndy Whitcroft	my %suppress_whiletrailers;
1061653d4876SAndy Whitcroft
1062c2fdda0dSAndy Whitcroft	# Pre-scan the patch sanitizing the lines.
1063de7d4f0eSAndy Whitcroft	# Pre-scan the patch looking for any __setup documentation.
1064c2fdda0dSAndy Whitcroft	#
1065de7d4f0eSAndy Whitcroft	my @setup_docs = ();
1066de7d4f0eSAndy Whitcroft	my $setup_docs = 0;
1067773647a0SAndy Whitcroft
1068773647a0SAndy Whitcroft	sanitise_line_reset();
1069c2fdda0dSAndy Whitcroft	my $line;
1070c2fdda0dSAndy Whitcroft	foreach my $rawline (@rawlines) {
1071773647a0SAndy Whitcroft		$linenr++;
1072773647a0SAndy Whitcroft		$line = $rawline;
1073c2fdda0dSAndy Whitcroft
1074773647a0SAndy Whitcroft		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1075de7d4f0eSAndy Whitcroft			$setup_docs = 0;
1076de7d4f0eSAndy Whitcroft			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1077de7d4f0eSAndy Whitcroft				$setup_docs = 1;
1078de7d4f0eSAndy Whitcroft			}
1079773647a0SAndy Whitcroft			#next;
1080de7d4f0eSAndy Whitcroft		}
1081773647a0SAndy Whitcroft		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1082773647a0SAndy Whitcroft			$realline=$1-1;
1083773647a0SAndy Whitcroft			if (defined $2) {
1084773647a0SAndy Whitcroft				$realcnt=$3+1;
1085773647a0SAndy Whitcroft			} else {
1086773647a0SAndy Whitcroft				$realcnt=1+1;
1087773647a0SAndy Whitcroft			}
1088c45dcabdSAndy Whitcroft			$in_comment = 0;
1089773647a0SAndy Whitcroft
1090773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  Run
1091773647a0SAndy Whitcroft			# the context looking for a comment "edge".  If this
1092773647a0SAndy Whitcroft			# edge is a close comment then we must be in a comment
1093773647a0SAndy Whitcroft			# at context start.
1094773647a0SAndy Whitcroft			my $edge;
109501fa9147SAndy Whitcroft			my $cnt = $realcnt;
109601fa9147SAndy Whitcroft			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
109701fa9147SAndy Whitcroft				next if (defined $rawlines[$ln - 1] &&
109801fa9147SAndy Whitcroft					 $rawlines[$ln - 1] =~ /^-/);
109901fa9147SAndy Whitcroft				$cnt--;
110001fa9147SAndy Whitcroft				#print "RAW<$rawlines[$ln - 1]>\n";
1101721c1cb6SAndy Whitcroft				last if (!defined $rawlines[$ln - 1]);
1102721c1cb6SAndy Whitcroft				($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1103773647a0SAndy Whitcroft				last if (defined $edge);
1104773647a0SAndy Whitcroft			}
1105773647a0SAndy Whitcroft			if (defined $edge && $edge eq '*/') {
1106773647a0SAndy Whitcroft				$in_comment = 1;
1107773647a0SAndy Whitcroft			}
1108773647a0SAndy Whitcroft
1109773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  If this
1110773647a0SAndy Whitcroft			# is the start of a diff block and this line starts
1111773647a0SAndy Whitcroft			# ' *' then it is very likely a comment.
1112773647a0SAndy Whitcroft			if (!defined $edge &&
111383242e0cSAndy Whitcroft			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1114773647a0SAndy Whitcroft			{
1115773647a0SAndy Whitcroft				$in_comment = 1;
1116773647a0SAndy Whitcroft			}
1117773647a0SAndy Whitcroft
1118773647a0SAndy Whitcroft			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1119773647a0SAndy Whitcroft			sanitise_line_reset($in_comment);
1120773647a0SAndy Whitcroft
1121171ae1a4SAndy Whitcroft		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1122773647a0SAndy Whitcroft			# Standardise the strings and chars within the input to
1123171ae1a4SAndy Whitcroft			# simplify matching -- only bother with positive lines.
1124773647a0SAndy Whitcroft			$line = sanitise_line($rawline);
1125773647a0SAndy Whitcroft		}
1126773647a0SAndy Whitcroft		push(@lines, $line);
1127773647a0SAndy Whitcroft
1128773647a0SAndy Whitcroft		if ($realcnt > 1) {
1129773647a0SAndy Whitcroft			$realcnt-- if ($line =~ /^(?:\+| |$)/);
1130773647a0SAndy Whitcroft		} else {
1131773647a0SAndy Whitcroft			$realcnt = 0;
1132773647a0SAndy Whitcroft		}
1133773647a0SAndy Whitcroft
1134773647a0SAndy Whitcroft		#print "==>$rawline\n";
1135773647a0SAndy Whitcroft		#print "-->$line\n";
1136de7d4f0eSAndy Whitcroft
1137de7d4f0eSAndy Whitcroft		if ($setup_docs && $line =~ /^\+/) {
1138de7d4f0eSAndy Whitcroft			push(@setup_docs, $line);
1139de7d4f0eSAndy Whitcroft		}
1140de7d4f0eSAndy Whitcroft	}
1141de7d4f0eSAndy Whitcroft
11426c72ffaaSAndy Whitcroft	$prefix = '';
11436c72ffaaSAndy Whitcroft
1144773647a0SAndy Whitcroft	$realcnt = 0;
1145773647a0SAndy Whitcroft	$linenr = 0;
11460a920b5bSAndy Whitcroft	foreach my $line (@lines) {
11470a920b5bSAndy Whitcroft		$linenr++;
11480a920b5bSAndy Whitcroft
1149c2fdda0dSAndy Whitcroft		my $rawline = $rawlines[$linenr - 1];
115030670854SAndy Whitcroft		my $hunk_line = ($realcnt != 0);
11516c72ffaaSAndy Whitcroft
11520a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied
11536c72ffaaSAndy Whitcroft		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
11540a920b5bSAndy Whitcroft			$is_patch = 1;
11554a0df2efSAndy Whitcroft			$first_line = $linenr + 1;
11560a920b5bSAndy Whitcroft			$realline=$1-1;
11570a920b5bSAndy Whitcroft			if (defined $2) {
11580a920b5bSAndy Whitcroft				$realcnt=$3+1;
11590a920b5bSAndy Whitcroft			} else {
11600a920b5bSAndy Whitcroft				$realcnt=1+1;
11610a920b5bSAndy Whitcroft			}
1162c2fdda0dSAndy Whitcroft			annotate_reset();
116313214adfSAndy Whitcroft			$prev_values = 'E';
116413214adfSAndy Whitcroft
1165773647a0SAndy Whitcroft			%suppress_ifbraces = ();
1166170d3a22SAndy Whitcroft			%suppress_whiletrailers = ();
11670a920b5bSAndy Whitcroft			next;
11680a920b5bSAndy Whitcroft
11694a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that
11704a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely
11714a0df2efSAndy Whitcroft# blank context lines so we need to count that too.
1172773647a0SAndy Whitcroft		} elsif ($line =~ /^( |\+|$)/) {
11730a920b5bSAndy Whitcroft			$realline++;
1174d8aaf121SAndy Whitcroft			$realcnt-- if ($realcnt != 0);
11750a920b5bSAndy Whitcroft
11764a0df2efSAndy Whitcroft			# Measure the line length and indent.
1177c2fdda0dSAndy Whitcroft			($length, $indent) = line_stats($rawline);
11780a920b5bSAndy Whitcroft
11790a920b5bSAndy Whitcroft			# Track the previous line.
11800a920b5bSAndy Whitcroft			($prevline, $stashline) = ($stashline, $line);
11810a920b5bSAndy Whitcroft			($previndent, $stashindent) = ($stashindent, $indent);
1182c2fdda0dSAndy Whitcroft			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1183c2fdda0dSAndy Whitcroft
1184773647a0SAndy Whitcroft			#warn "line<$line>\n";
11856c72ffaaSAndy Whitcroft
1186d8aaf121SAndy Whitcroft		} elsif ($realcnt == 1) {
1187d8aaf121SAndy Whitcroft			$realcnt--;
11880a920b5bSAndy Whitcroft		}
11890a920b5bSAndy Whitcroft
11900a920b5bSAndy Whitcroft#make up the handle for any error we report on this line
1191773647a0SAndy Whitcroft		$prefix = "$filename:$realline: " if ($emacs && $file);
1192773647a0SAndy Whitcroft		$prefix = "$filename:$linenr: " if ($emacs && !$file);
1193773647a0SAndy Whitcroft
11946c72ffaaSAndy Whitcroft		$here = "#$linenr: " if (!$file);
11956c72ffaaSAndy Whitcroft		$here = "#$realline: " if ($file);
1196773647a0SAndy Whitcroft
1197773647a0SAndy Whitcroft		# extract the filename as it passes
1198773647a0SAndy Whitcroft		if ($line=~/^\+\+\+\s+(\S+)/) {
1199773647a0SAndy Whitcroft			$realfile = $1;
1200773647a0SAndy Whitcroft			$realfile =~ s@^[^/]*/@@;
1201773647a0SAndy Whitcroft
1202c1ab3326SAndy Whitcroft			if ($realfile =~ m@^include/asm/@) {
1203773647a0SAndy Whitcroft				ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1204773647a0SAndy Whitcroft			}
1205773647a0SAndy Whitcroft			next;
1206773647a0SAndy Whitcroft		}
1207773647a0SAndy Whitcroft
1208389834b6SRandy Dunlap		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
12090a920b5bSAndy Whitcroft
1210c2fdda0dSAndy Whitcroft		my $hereline = "$here\n$rawline\n";
1211c2fdda0dSAndy Whitcroft		my $herecurr = "$here\n$rawline\n";
1212c2fdda0dSAndy Whitcroft		my $hereprev = "$here\n$prevrawline\n$rawline\n";
12130a920b5bSAndy Whitcroft
12146c72ffaaSAndy Whitcroft		$cnt_lines++ if ($realcnt != 0);
12156c72ffaaSAndy Whitcroft
12160a920b5bSAndy Whitcroft#check the patch for a signoff:
1217d8aaf121SAndy Whitcroft		if ($line =~ /^\s*signed-off-by:/i) {
12184a0df2efSAndy Whitcroft			# This is a signoff, if ugly, so do not double report.
12194a0df2efSAndy Whitcroft			$signoff++;
12200a920b5bSAndy Whitcroft			if (!($line =~ /^\s*Signed-off-by:/)) {
1221de7d4f0eSAndy Whitcroft				WARN("Signed-off-by: is the preferred form\n" .
1222de7d4f0eSAndy Whitcroft					$herecurr);
12230a920b5bSAndy Whitcroft			}
12240a920b5bSAndy Whitcroft			if ($line =~ /^\s*signed-off-by:\S/i) {
1225773647a0SAndy Whitcroft				WARN("space required after Signed-off-by:\n" .
1226de7d4f0eSAndy Whitcroft					$herecurr);
12270a920b5bSAndy Whitcroft			}
12280a920b5bSAndy Whitcroft		}
12290a920b5bSAndy Whitcroft
123000df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file
12318905a67cSAndy Whitcroft		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1232de7d4f0eSAndy Whitcroft			ERROR("patch seems to be corrupt (line wrapped?)\n" .
12336c72ffaaSAndy Whitcroft				$herecurr) if (!$emitted_corrupt++);
1234de7d4f0eSAndy Whitcroft		}
1235de7d4f0eSAndy Whitcroft
12366ecd9674SAndy Whitcroft# Check for absolute kernel paths.
12376ecd9674SAndy Whitcroft		if ($tree) {
12386ecd9674SAndy Whitcroft			while ($line =~ m{(?:^|\s)(/\S*)}g) {
12396ecd9674SAndy Whitcroft				my $file = $1;
12406ecd9674SAndy Whitcroft
12416ecd9674SAndy Whitcroft				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
12426ecd9674SAndy Whitcroft				    check_absolute_file($1, $herecurr)) {
12436ecd9674SAndy Whitcroft					#
12446ecd9674SAndy Whitcroft				} else {
12456ecd9674SAndy Whitcroft					check_absolute_file($file, $herecurr);
12466ecd9674SAndy Whitcroft				}
12476ecd9674SAndy Whitcroft			}
12486ecd9674SAndy Whitcroft		}
12496ecd9674SAndy Whitcroft
1250de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1251de7d4f0eSAndy Whitcroft		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1252171ae1a4SAndy Whitcroft		    $rawline !~ m/^$UTF8*$/) {
1253171ae1a4SAndy Whitcroft			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1254171ae1a4SAndy Whitcroft
1255171ae1a4SAndy Whitcroft			my $blank = copy_spacing($rawline);
1256171ae1a4SAndy Whitcroft			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1257171ae1a4SAndy Whitcroft			my $hereptr = "$hereline$ptr\n";
1258171ae1a4SAndy Whitcroft
1259171ae1a4SAndy Whitcroft			ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
126000df344fSAndy Whitcroft		}
12610a920b5bSAndy Whitcroft
126230670854SAndy Whitcroft# ignore non-hunk lines and lines being removed
126330670854SAndy Whitcroft		next if (!$hunk_line || $line =~ /^-/);
126400df344fSAndy Whitcroft
12650a920b5bSAndy Whitcroft#trailing whitespace
12669c0ca6f9SAndy Whitcroft		if ($line =~ /^\+.*\015/) {
1267c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
12689c0ca6f9SAndy Whitcroft			ERROR("DOS line endings\n" . $herevet);
12699c0ca6f9SAndy Whitcroft
1270c2fdda0dSAndy Whitcroft		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1271c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1272de7d4f0eSAndy Whitcroft			ERROR("trailing whitespace\n" . $herevet);
12730a920b5bSAndy Whitcroft		}
12745368df20SAndy Whitcroft
12755368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk
12765368df20SAndy Whitcroft		next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
12775368df20SAndy Whitcroft
12780a920b5bSAndy Whitcroft#80 column limit
1279c45dcabdSAndy Whitcroft		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1280f4c014c0SAndy Whitcroft		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1281f4c014c0SAndy Whitcroft		    $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1282f4c014c0SAndy Whitcroft		    $length > 80)
1283c45dcabdSAndy Whitcroft		{
1284de7d4f0eSAndy Whitcroft			WARN("line over 80 characters\n" . $herecurr);
12850a920b5bSAndy Whitcroft		}
12860a920b5bSAndy Whitcroft
12878905a67cSAndy Whitcroft# check for adding lines without a newline.
12888905a67cSAndy Whitcroft		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
12898905a67cSAndy Whitcroft			WARN("adding a line without newline at end of file\n" . $herecurr);
12908905a67cSAndy Whitcroft		}
12918905a67cSAndy Whitcroft
1292b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk
1293b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c|pl)$/);
12940a920b5bSAndy Whitcroft
12950a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything
12960a920b5bSAndy Whitcroft# more than 8 must use tabs.
1297c2fdda0dSAndy Whitcroft		if ($rawline =~ /^\+\s* \t\s*\S/ ||
1298c2fdda0dSAndy Whitcroft		    $rawline =~ /^\+\s*        \s*/) {
1299c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1300171ae1a4SAndy Whitcroft			ERROR("code indent should use tabs where possible\n" . $herevet);
13010a920b5bSAndy Whitcroft		}
13020a920b5bSAndy Whitcroft
1303b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk
1304b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c)$/);
1305b9ea10d6SAndy Whitcroft
1306c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers
1307cf655043SAndy Whitcroft		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1308c2fdda0dSAndy Whitcroft			WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1309c2fdda0dSAndy Whitcroft		}
131022f2a2efSAndy Whitcroft
13119c0ca6f9SAndy Whitcroft# Check for potential 'bare' types
1312170d3a22SAndy Whitcroft		my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
13139c9ba34eSAndy Whitcroft		if ($realcnt && $line =~ /.\s*\S/) {
1314170d3a22SAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1315f5fe35ddSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
1316171ae1a4SAndy Whitcroft			$stat =~ s/\n./\n /g;
1317171ae1a4SAndy Whitcroft			$cond =~ s/\n./\n /g;
1318171ae1a4SAndy Whitcroft
1319171ae1a4SAndy Whitcroft			my $s = $stat;
1320171ae1a4SAndy Whitcroft			$s =~ s/{.*$//s;
1321cf655043SAndy Whitcroft
1322c2fdda0dSAndy Whitcroft			# Ignore goto labels.
1323171ae1a4SAndy Whitcroft			if ($s =~ /$Ident:\*$/s) {
1324c2fdda0dSAndy Whitcroft
1325c2fdda0dSAndy Whitcroft			# Ignore functions being called
1326171ae1a4SAndy Whitcroft			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1327c2fdda0dSAndy Whitcroft
1328c45dcabdSAndy Whitcroft			# declarations always start with types
1329d2506586SAndy 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) {
1330c45dcabdSAndy Whitcroft				my $type = $1;
1331c45dcabdSAndy Whitcroft				$type =~ s/\s+/ /g;
1332c45dcabdSAndy Whitcroft				possible($type, "A:" . $s);
1333c45dcabdSAndy Whitcroft
13346c72ffaaSAndy Whitcroft			# definitions in global scope can only start with types
1335a6a84062SAndy Whitcroft			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1336c45dcabdSAndy Whitcroft				possible($1, "B:" . $s);
1337c2fdda0dSAndy Whitcroft			}
13388905a67cSAndy Whitcroft
13396c72ffaaSAndy Whitcroft			# any (foo ... *) is a pointer cast, and foo is a type
1340171ae1a4SAndy Whitcroft			while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1341c45dcabdSAndy Whitcroft				possible($1, "C:" . $s);
13429c0ca6f9SAndy Whitcroft			}
13438905a67cSAndy Whitcroft
13448905a67cSAndy Whitcroft			# Check for any sort of function declaration.
13458905a67cSAndy Whitcroft			# int foo(something bar, other baz);
13468905a67cSAndy Whitcroft			# void (*store_gdt)(x86_descr_ptr *);
1347171ae1a4SAndy Whitcroft			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
13488905a67cSAndy Whitcroft				my ($name_len) = length($1);
13498905a67cSAndy Whitcroft
1350cf655043SAndy Whitcroft				my $ctx = $s;
1351773647a0SAndy Whitcroft				substr($ctx, 0, $name_len + 1, '');
13528905a67cSAndy Whitcroft				$ctx =~ s/\)[^\)]*$//;
1353cf655043SAndy Whitcroft
13548905a67cSAndy Whitcroft				for my $arg (split(/\s*,\s*/, $ctx)) {
1355c45dcabdSAndy Whitcroft					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
13568905a67cSAndy Whitcroft
1357c45dcabdSAndy Whitcroft						possible($1, "D:" . $s);
13588905a67cSAndy Whitcroft					}
13598905a67cSAndy Whitcroft				}
13608905a67cSAndy Whitcroft			}
13618905a67cSAndy Whitcroft
13629c0ca6f9SAndy Whitcroft		}
13639c0ca6f9SAndy Whitcroft
136400df344fSAndy Whitcroft#
136500df344fSAndy Whitcroft# Checks which may be anchored in the context.
136600df344fSAndy Whitcroft#
136700df344fSAndy Whitcroft
136800df344fSAndy Whitcroft# Check for switch () and associated case and default
136900df344fSAndy Whitcroft# statements should be at the same indent.
137000df344fSAndy Whitcroft		if ($line=~/\bswitch\s*\(.*\)/) {
137100df344fSAndy Whitcroft			my $err = '';
137200df344fSAndy Whitcroft			my $sep = '';
137300df344fSAndy Whitcroft			my @ctx = ctx_block_outer($linenr, $realcnt);
137400df344fSAndy Whitcroft			shift(@ctx);
137500df344fSAndy Whitcroft			for my $ctx (@ctx) {
137600df344fSAndy Whitcroft				my ($clen, $cindent) = line_stats($ctx);
137700df344fSAndy Whitcroft				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
137800df344fSAndy Whitcroft							$indent != $cindent) {
137900df344fSAndy Whitcroft					$err .= "$sep$ctx\n";
138000df344fSAndy Whitcroft					$sep = '';
138100df344fSAndy Whitcroft				} else {
138200df344fSAndy Whitcroft					$sep = "[...]\n";
138300df344fSAndy Whitcroft				}
138400df344fSAndy Whitcroft			}
138500df344fSAndy Whitcroft			if ($err ne '') {
13869c0ca6f9SAndy Whitcroft				ERROR("switch and case should be at the same indent\n$hereline$err");
1387de7d4f0eSAndy Whitcroft			}
1388de7d4f0eSAndy Whitcroft		}
1389de7d4f0eSAndy Whitcroft
1390de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop,
1391de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else
1392c45dcabdSAndy Whitcroft		if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1393773647a0SAndy Whitcroft			my $pre_ctx = "$1$2";
1394773647a0SAndy Whitcroft
13959c0ca6f9SAndy Whitcroft			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1396de7d4f0eSAndy Whitcroft			my $ctx_cnt = $realcnt - $#ctx - 1;
1397de7d4f0eSAndy Whitcroft			my $ctx = join("\n", @ctx);
1398de7d4f0eSAndy Whitcroft
1399548596d5SAndy Whitcroft			my $ctx_ln = $linenr;
1400548596d5SAndy Whitcroft			my $ctx_skip = $realcnt;
1401de7d4f0eSAndy Whitcroft
1402548596d5SAndy Whitcroft			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1403548596d5SAndy Whitcroft					defined $lines[$ctx_ln - 1] &&
1404548596d5SAndy Whitcroft					$lines[$ctx_ln - 1] =~ /^-/)) {
1405548596d5SAndy Whitcroft				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1406548596d5SAndy Whitcroft				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1407773647a0SAndy Whitcroft				$ctx_ln++;
1408773647a0SAndy Whitcroft			}
1409548596d5SAndy Whitcroft
141053210168SAndy Whitcroft			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
141153210168SAndy Whitcroft			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1412773647a0SAndy Whitcroft
1413773647a0SAndy Whitcroft			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1414773647a0SAndy Whitcroft				ERROR("that open brace { should be on the previous line\n" .
1415c45dcabdSAndy Whitcroft					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
141600df344fSAndy Whitcroft			}
1417773647a0SAndy Whitcroft			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1418773647a0SAndy Whitcroft			    $ctx =~ /\)\s*\;\s*$/ &&
1419773647a0SAndy Whitcroft			    defined $lines[$ctx_ln - 1])
1420773647a0SAndy Whitcroft			{
14219c0ca6f9SAndy Whitcroft				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
14229c0ca6f9SAndy Whitcroft				if ($nindent > $indent) {
1423773647a0SAndy Whitcroft					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1424c45dcabdSAndy Whitcroft						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
14259c0ca6f9SAndy Whitcroft				}
14269c0ca6f9SAndy Whitcroft			}
142700df344fSAndy Whitcroft		}
142800df344fSAndy Whitcroft
14294d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks.
14304d001e4dSAndy Whitcroft		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
14314d001e4dSAndy Whitcroft			my ($s, $c) = ($stat, $cond);
14324d001e4dSAndy Whitcroft
14334d001e4dSAndy Whitcroft			substr($s, 0, length($c), '');
14344d001e4dSAndy Whitcroft
14354d001e4dSAndy Whitcroft			# Make sure we remove the line prefixes as we have
14364d001e4dSAndy Whitcroft			# none on the first line, and are going to readd them
14374d001e4dSAndy Whitcroft			# where necessary.
14384d001e4dSAndy Whitcroft			$s =~ s/\n./\n/gs;
14394d001e4dSAndy Whitcroft
14404d001e4dSAndy Whitcroft			# Find out how long the conditional actually is.
14416f779c18SAndy Whitcroft			my @newlines = ($c =~ /\n/gs);
14426f779c18SAndy Whitcroft			my $cond_lines = 1 + $#newlines;
14434d001e4dSAndy Whitcroft
14444d001e4dSAndy Whitcroft			# We want to check the first line inside the block
14454d001e4dSAndy Whitcroft			# starting at the end of the conditional, so remove:
14464d001e4dSAndy Whitcroft			#  1) any blank line termination
14474d001e4dSAndy Whitcroft			#  2) any opening brace { on end of the line
14484d001e4dSAndy Whitcroft			#  3) any do (...) {
14494d001e4dSAndy Whitcroft			my $continuation = 0;
14504d001e4dSAndy Whitcroft			my $check = 0;
14514d001e4dSAndy Whitcroft			$s =~ s/^.*\bdo\b//;
14524d001e4dSAndy Whitcroft			$s =~ s/^\s*{//;
14534d001e4dSAndy Whitcroft			if ($s =~ s/^\s*\\//) {
14544d001e4dSAndy Whitcroft				$continuation = 1;
14554d001e4dSAndy Whitcroft			}
14569bd49efeSAndy Whitcroft			if ($s =~ s/^\s*?\n//) {
14574d001e4dSAndy Whitcroft				$check = 1;
14584d001e4dSAndy Whitcroft				$cond_lines++;
14594d001e4dSAndy Whitcroft			}
14604d001e4dSAndy Whitcroft
14614d001e4dSAndy Whitcroft			# Also ignore a loop construct at the end of a
14624d001e4dSAndy Whitcroft			# preprocessor statement.
14634d001e4dSAndy Whitcroft			if (($prevline =~ /^.\s*#\s*define\s/ ||
14644d001e4dSAndy Whitcroft			    $prevline =~ /\\\s*$/) && $continuation == 0) {
14654d001e4dSAndy Whitcroft				$check = 0;
14664d001e4dSAndy Whitcroft			}
14674d001e4dSAndy Whitcroft
14689bd49efeSAndy Whitcroft			my $cond_ptr = -1;
1469740504c6SAndy Whitcroft			$continuation = 0;
14709bd49efeSAndy Whitcroft			while ($cond_ptr != $cond_lines) {
14719bd49efeSAndy Whitcroft				$cond_ptr = $cond_lines;
14724d001e4dSAndy Whitcroft
1473f16fa28fSAndy Whitcroft				# If we see an #else/#elif then the code
1474f16fa28fSAndy Whitcroft				# is not linear.
1475f16fa28fSAndy Whitcroft				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1476f16fa28fSAndy Whitcroft					$check = 0;
1477f16fa28fSAndy Whitcroft				}
1478f16fa28fSAndy Whitcroft
14799bd49efeSAndy Whitcroft				# Ignore:
14809bd49efeSAndy Whitcroft				#  1) blank lines, they should be at 0,
14819bd49efeSAndy Whitcroft				#  2) preprocessor lines, and
14829bd49efeSAndy Whitcroft				#  3) labels.
1483740504c6SAndy Whitcroft				if ($continuation ||
1484740504c6SAndy Whitcroft				    $s =~ /^\s*?\n/ ||
14859bd49efeSAndy Whitcroft				    $s =~ /^\s*#\s*?/ ||
14869bd49efeSAndy Whitcroft				    $s =~ /^\s*$Ident\s*:/) {
1487740504c6SAndy Whitcroft					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
14889bd49efeSAndy Whitcroft					$s =~ s/^.*?\n//;
14899bd49efeSAndy Whitcroft					$cond_lines++;
14909bd49efeSAndy Whitcroft				}
14914d001e4dSAndy Whitcroft			}
14924d001e4dSAndy Whitcroft
14934d001e4dSAndy Whitcroft			my (undef, $sindent) = line_stats("+" . $s);
14944d001e4dSAndy Whitcroft			my $stat_real = raw_line($linenr, $cond_lines);
14954d001e4dSAndy Whitcroft
14964d001e4dSAndy Whitcroft			# Check if either of these lines are modified, else
14974d001e4dSAndy Whitcroft			# this is not this patch's fault.
14984d001e4dSAndy Whitcroft			if (!defined($stat_real) ||
14994d001e4dSAndy Whitcroft			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
15004d001e4dSAndy Whitcroft				$check = 0;
15014d001e4dSAndy Whitcroft			}
15024d001e4dSAndy Whitcroft			if (defined($stat_real) && $cond_lines > 1) {
15034d001e4dSAndy Whitcroft				$stat_real = "[...]\n$stat_real";
15044d001e4dSAndy Whitcroft			}
15054d001e4dSAndy Whitcroft
15069bd49efeSAndy 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";
15074d001e4dSAndy Whitcroft
15084d001e4dSAndy Whitcroft			if ($check && (($sindent % 8) != 0 ||
15094d001e4dSAndy Whitcroft			    ($sindent <= $indent && $s ne ''))) {
15104d001e4dSAndy Whitcroft				WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
15114d001e4dSAndy Whitcroft			}
15124d001e4dSAndy Whitcroft		}
15134d001e4dSAndy Whitcroft
15146c72ffaaSAndy Whitcroft		# Track the 'values' across context and added lines.
15156c72ffaaSAndy Whitcroft		my $opline = $line; $opline =~ s/^./ /;
15161f65f947SAndy Whitcroft		my ($curr_values, $curr_vars) =
15171f65f947SAndy Whitcroft				annotate_values($opline . "\n", $prev_values);
15186c72ffaaSAndy Whitcroft		$curr_values = $prev_values . $curr_values;
1519c2fdda0dSAndy Whitcroft		if ($dbg_values) {
1520c2fdda0dSAndy Whitcroft			my $outline = $opline; $outline =~ s/\t/ /g;
1521cf655043SAndy Whitcroft			print "$linenr > .$outline\n";
1522cf655043SAndy Whitcroft			print "$linenr > $curr_values\n";
15231f65f947SAndy Whitcroft			print "$linenr >  $curr_vars\n";
1524c2fdda0dSAndy Whitcroft		}
15256c72ffaaSAndy Whitcroft		$prev_values = substr($curr_values, -1);
15266c72ffaaSAndy Whitcroft
152700df344fSAndy Whitcroft#ignore lines not being added
152800df344fSAndy Whitcroft		if ($line=~/^[^\+]/) {next;}
152900df344fSAndy Whitcroft
1530653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher.
15317429c690SAndy Whitcroft		if ($dbg_type) {
15327429c690SAndy Whitcroft			if ($line =~ /^.\s*$Declare\s*$/) {
15337429c690SAndy Whitcroft				ERROR("TEST: is type\n" . $herecurr);
15347429c690SAndy Whitcroft			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
15357429c690SAndy Whitcroft				ERROR("TEST: is not type ($1 is)\n". $herecurr);
15367429c690SAndy Whitcroft			}
1537653d4876SAndy Whitcroft			next;
1538653d4876SAndy Whitcroft		}
1539a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher.
1540a1ef277eSAndy Whitcroft		if ($dbg_attr) {
1541a1ef277eSAndy Whitcroft			if ($line =~ /^.\s*$Attribute\s*$/) {
1542a1ef277eSAndy Whitcroft				ERROR("TEST: is attr\n" . $herecurr);
1543a1ef277eSAndy Whitcroft			} elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1544a1ef277eSAndy Whitcroft				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1545a1ef277eSAndy Whitcroft			}
1546a1ef277eSAndy Whitcroft			next;
1547a1ef277eSAndy Whitcroft		}
1548653d4876SAndy Whitcroft
1549f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line
1550f0a594c1SAndy Whitcroft		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1551f0a594c1SAndy Whitcroft		    $line =~ /^.\s*{/) {
1552773647a0SAndy Whitcroft			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1553f0a594c1SAndy Whitcroft		}
1554f0a594c1SAndy Whitcroft
155500df344fSAndy Whitcroft#
155600df344fSAndy Whitcroft# Checks which are anchored on the added line.
155700df344fSAndy Whitcroft#
155800df344fSAndy Whitcroft
1559653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line)
1560c45dcabdSAndy Whitcroft		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1561653d4876SAndy Whitcroft			my $path = $1;
1562653d4876SAndy Whitcroft			if ($path =~ m{//}) {
1563de7d4f0eSAndy Whitcroft				ERROR("malformed #include filename\n" .
1564de7d4f0eSAndy Whitcroft					$herecurr);
1565653d4876SAndy Whitcroft			}
1566653d4876SAndy Whitcroft		}
1567653d4876SAndy Whitcroft
156800df344fSAndy Whitcroft# no C99 // comments
156900df344fSAndy Whitcroft		if ($line =~ m{//}) {
1570de7d4f0eSAndy Whitcroft			ERROR("do not use C99 // comments\n" . $herecurr);
157100df344fSAndy Whitcroft		}
157200df344fSAndy Whitcroft		# Remove C99 comments.
15730a920b5bSAndy Whitcroft		$line =~ s@//.*@@;
15746c72ffaaSAndy Whitcroft		$opline =~ s@//.*@@;
15750a920b5bSAndy Whitcroft
15760a920b5bSAndy Whitcroft#EXPORT_SYMBOL should immediately follow its function closing }.
1577653d4876SAndy Whitcroft		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1578653d4876SAndy Whitcroft		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1579653d4876SAndy Whitcroft			my $name = $1;
158048012058SAndy Whitcroft			if ($prevline !~ /(?:
158148012058SAndy Whitcroft				^.}|
158248012058SAndy Whitcroft				^.DEFINE_$Ident\(\Q$name\E\)|
158348012058SAndy Whitcroft				^.DECLARE_$Ident\(\Q$name\E\)|
158448012058SAndy Whitcroft				^.LIST_HEAD\(\Q$name\E\)|
158548012058SAndy Whitcroft				^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
158648012058SAndy Whitcroft				\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
158748012058SAndy Whitcroft			    )/x) {
1588de7d4f0eSAndy Whitcroft				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
15890a920b5bSAndy Whitcroft			}
15900a920b5bSAndy Whitcroft		}
15910a920b5bSAndy Whitcroft
1592f0a594c1SAndy Whitcroft# check for external initialisers.
1593c45dcabdSAndy Whitcroft		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1594f0a594c1SAndy Whitcroft			ERROR("do not initialise externals to 0 or NULL\n" .
1595f0a594c1SAndy Whitcroft				$herecurr);
1596f0a594c1SAndy Whitcroft		}
15970a920b5bSAndy Whitcroft# check for static initialisers.
15989c9ba34eSAndy Whitcroft		if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1599de7d4f0eSAndy Whitcroft			ERROR("do not initialise statics to 0 or NULL\n" .
1600de7d4f0eSAndy Whitcroft				$herecurr);
16010a920b5bSAndy Whitcroft		}
16020a920b5bSAndy Whitcroft
1603653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations
1604653d4876SAndy Whitcroft# make sense.
1605653d4876SAndy Whitcroft		if ($line =~ /\btypedef\s/ &&
16069c0ca6f9SAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1607c45dcabdSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
16088ed22cadSAndy Whitcroft		    $line !~ /\b$typeTypedefs\b/ &&
1609653d4876SAndy Whitcroft		    $line !~ /\b__bitwise(?:__|)\b/) {
1610de7d4f0eSAndy Whitcroft			WARN("do not add new typedefs\n" . $herecurr);
16110a920b5bSAndy Whitcroft		}
16120a920b5bSAndy Whitcroft
16130a920b5bSAndy Whitcroft# * goes on variable not on type
1614d8aaf121SAndy Whitcroft		if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1615de7d4f0eSAndy Whitcroft			ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1616de7d4f0eSAndy Whitcroft				$herecurr);
1617d8aaf121SAndy Whitcroft
1618d8aaf121SAndy Whitcroft		} elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1619de7d4f0eSAndy Whitcroft			ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1620de7d4f0eSAndy Whitcroft				$herecurr);
1621d8aaf121SAndy Whitcroft
1622234fff65SAndy Whitcroft		} elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1623de7d4f0eSAndy Whitcroft			ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1624de7d4f0eSAndy Whitcroft				$herecurr);
1625d8aaf121SAndy Whitcroft
1626234fff65SAndy Whitcroft		} elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1627de7d4f0eSAndy Whitcroft			ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1628de7d4f0eSAndy Whitcroft				$herecurr);
16290a920b5bSAndy Whitcroft		}
16300a920b5bSAndy Whitcroft
16310a920b5bSAndy Whitcroft# # no BUG() or BUG_ON()
16320a920b5bSAndy Whitcroft# 		if ($line =~ /\b(BUG|BUG_ON)\b/) {
16330a920b5bSAndy Whitcroft# 			print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
16340a920b5bSAndy Whitcroft# 			print "$herecurr";
16350a920b5bSAndy Whitcroft# 			$clean = 0;
16360a920b5bSAndy Whitcroft# 		}
16370a920b5bSAndy Whitcroft
16388905a67cSAndy Whitcroft		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1639c2fdda0dSAndy Whitcroft			WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
16408905a67cSAndy Whitcroft		}
16418905a67cSAndy Whitcroft
164200df344fSAndy Whitcroft# printk should use KERN_* levels.  Note that follow on printk's on the
164300df344fSAndy Whitcroft# same line do not need a level, so we use the current block context
164400df344fSAndy Whitcroft# to try and find and validate the current printk.  In summary the current
164500df344fSAndy Whitcroft# printk includes all preceeding printk's which have no newline on the end.
164600df344fSAndy Whitcroft# we assume the first bad printk is the one to report.
1647f0a594c1SAndy Whitcroft		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
164800df344fSAndy Whitcroft			my $ok = 0;
164900df344fSAndy Whitcroft			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
165000df344fSAndy Whitcroft				#print "CHECK<$lines[$ln - 1]\n";
165100df344fSAndy Whitcroft				# we have a preceeding printk if it ends
165200df344fSAndy Whitcroft				# with "\n" ignore it, else it is to blame
165300df344fSAndy Whitcroft				if ($lines[$ln - 1] =~ m{\bprintk\(}) {
165400df344fSAndy Whitcroft					if ($rawlines[$ln - 1] !~ m{\\n"}) {
165500df344fSAndy Whitcroft						$ok = 1;
165600df344fSAndy Whitcroft					}
165700df344fSAndy Whitcroft					last;
165800df344fSAndy Whitcroft				}
165900df344fSAndy Whitcroft			}
166000df344fSAndy Whitcroft			if ($ok == 0) {
1661de7d4f0eSAndy Whitcroft				WARN("printk() should include KERN_ facility level\n" . $herecurr);
16620a920b5bSAndy Whitcroft			}
166300df344fSAndy Whitcroft		}
16640a920b5bSAndy Whitcroft
1665653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while,
1666653d4876SAndy Whitcroft# or if closed on same line
1667c45dcabdSAndy Whitcroft		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1668c45dcabdSAndy Whitcroft		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1669de7d4f0eSAndy Whitcroft			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
16700a920b5bSAndy Whitcroft		}
1671653d4876SAndy Whitcroft
16728905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line.
16738905a67cSAndy Whitcroft		if ($line =~ /^.\s*{/ &&
16748905a67cSAndy Whitcroft		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
16758905a67cSAndy Whitcroft			ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
16768905a67cSAndy Whitcroft		}
16778905a67cSAndy Whitcroft
16788d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed:
16798d31cfceSAndy Whitcroft#  1. with a type on the left -- int [] a;
1680fe2a7dbcSAndy Whitcroft#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1681fe2a7dbcSAndy Whitcroft#  3. inside a curly brace -- = { [0...10] = 5 }
16828d31cfceSAndy Whitcroft		while ($line =~ /(.*?\s)\[/g) {
16838d31cfceSAndy Whitcroft			my ($where, $prefix) = ($-[1], $1);
16848d31cfceSAndy Whitcroft			if ($prefix !~ /$Type\s+$/ &&
1685fe2a7dbcSAndy Whitcroft			    ($where != 0 || $prefix !~ /^.\s+$/) &&
1686fe2a7dbcSAndy Whitcroft			    $prefix !~ /{\s+$/) {
16878d31cfceSAndy Whitcroft				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
16888d31cfceSAndy Whitcroft			}
16898d31cfceSAndy Whitcroft		}
16908d31cfceSAndy Whitcroft
1691f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses.
16926c72ffaaSAndy Whitcroft		while ($line =~ /($Ident)\s+\(/g) {
1693c2fdda0dSAndy Whitcroft			my $name = $1;
1694773647a0SAndy Whitcroft			my $ctx_before = substr($line, 0, $-[1]);
1695773647a0SAndy Whitcroft			my $ctx = "$ctx_before$name";
1696c2fdda0dSAndy Whitcroft
1697c2fdda0dSAndy Whitcroft			# Ignore those directives where spaces _are_ permitted.
1698773647a0SAndy Whitcroft			if ($name =~ /^(?:
1699773647a0SAndy Whitcroft				if|for|while|switch|return|case|
1700773647a0SAndy Whitcroft				volatile|__volatile__|
1701773647a0SAndy Whitcroft				__attribute__|format|__extension__|
1702773647a0SAndy Whitcroft				asm|__asm__)$/x)
1703773647a0SAndy Whitcroft			{
1704c2fdda0dSAndy Whitcroft
1705c2fdda0dSAndy Whitcroft			# cpp #define statements have non-optional spaces, ie
1706c2fdda0dSAndy Whitcroft			# if there is a space between the name and the open
1707c2fdda0dSAndy Whitcroft			# parenthesis it is simply not a parameter group.
1708c45dcabdSAndy Whitcroft			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1709773647a0SAndy Whitcroft
1710773647a0SAndy Whitcroft			# cpp #elif statement condition may start with a (
1711c45dcabdSAndy Whitcroft			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1712c2fdda0dSAndy Whitcroft
1713c2fdda0dSAndy Whitcroft			# If this whole things ends with a type its most
1714c2fdda0dSAndy Whitcroft			# likely a typedef for a function.
1715773647a0SAndy Whitcroft			} elsif ($ctx =~ /$Type$/) {
1716c2fdda0dSAndy Whitcroft
1717c2fdda0dSAndy Whitcroft			} else {
1718773647a0SAndy Whitcroft				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1719f0a594c1SAndy Whitcroft			}
17206c72ffaaSAndy Whitcroft		}
1721653d4876SAndy Whitcroft# Check operator spacing.
17220a920b5bSAndy Whitcroft		if (!($line=~/\#\s*include/)) {
17239c0ca6f9SAndy Whitcroft			my $ops = qr{
17249c0ca6f9SAndy Whitcroft				<<=|>>=|<=|>=|==|!=|
17259c0ca6f9SAndy Whitcroft				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
17269c0ca6f9SAndy Whitcroft				=>|->|<<|>>|<|>|=|!|~|
17271f65f947SAndy Whitcroft				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
17281f65f947SAndy Whitcroft				\?|:
17299c0ca6f9SAndy Whitcroft			}x;
1730cf655043SAndy Whitcroft			my @elements = split(/($ops|;)/, $opline);
173100df344fSAndy Whitcroft			my $off = 0;
17326c72ffaaSAndy Whitcroft
17336c72ffaaSAndy Whitcroft			my $blank = copy_spacing($opline);
17346c72ffaaSAndy Whitcroft
17350a920b5bSAndy Whitcroft			for (my $n = 0; $n < $#elements; $n += 2) {
17364a0df2efSAndy Whitcroft				$off += length($elements[$n]);
17374a0df2efSAndy Whitcroft
1738773647a0SAndy Whitcroft				# Pick up the preceeding and succeeding characters.
1739773647a0SAndy Whitcroft				my $ca = substr($opline, 0, $off);
1740773647a0SAndy Whitcroft				my $cc = '';
1741773647a0SAndy Whitcroft				if (length($opline) >= ($off + length($elements[$n + 1]))) {
1742773647a0SAndy Whitcroft					$cc = substr($opline, $off + length($elements[$n + 1]));
1743773647a0SAndy Whitcroft				}
1744773647a0SAndy Whitcroft				my $cb = "$ca$;$cc";
1745773647a0SAndy Whitcroft
17464a0df2efSAndy Whitcroft				my $a = '';
17474a0df2efSAndy Whitcroft				$a = 'V' if ($elements[$n] ne '');
17484a0df2efSAndy Whitcroft				$a = 'W' if ($elements[$n] =~ /\s$/);
1749cf655043SAndy Whitcroft				$a = 'C' if ($elements[$n] =~ /$;$/);
17504a0df2efSAndy Whitcroft				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
17514a0df2efSAndy Whitcroft				$a = 'O' if ($elements[$n] eq '');
1752773647a0SAndy Whitcroft				$a = 'E' if ($ca =~ /^\s*$/);
17534a0df2efSAndy Whitcroft
17540a920b5bSAndy Whitcroft				my $op = $elements[$n + 1];
17554a0df2efSAndy Whitcroft
17564a0df2efSAndy Whitcroft				my $c = '';
17570a920b5bSAndy Whitcroft				if (defined $elements[$n + 2]) {
17584a0df2efSAndy Whitcroft					$c = 'V' if ($elements[$n + 2] ne '');
17594a0df2efSAndy Whitcroft					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1760cf655043SAndy Whitcroft					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
17614a0df2efSAndy Whitcroft					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
17624a0df2efSAndy Whitcroft					$c = 'O' if ($elements[$n + 2] eq '');
176322f2a2efSAndy Whitcroft					$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
17644a0df2efSAndy Whitcroft				} else {
17654a0df2efSAndy Whitcroft					$c = 'E';
17660a920b5bSAndy Whitcroft				}
17670a920b5bSAndy Whitcroft
17684a0df2efSAndy Whitcroft				my $ctx = "${a}x${c}";
17694a0df2efSAndy Whitcroft
17704a0df2efSAndy Whitcroft				my $at = "(ctx:$ctx)";
17714a0df2efSAndy Whitcroft
17726c72ffaaSAndy Whitcroft				my $ptr = substr($blank, 0, $off) . "^";
1773de7d4f0eSAndy Whitcroft				my $hereptr = "$hereline$ptr\n";
17740a920b5bSAndy Whitcroft
177574048ed8SAndy Whitcroft				# Pull out the value of this operator.
17766c72ffaaSAndy Whitcroft				my $op_type = substr($curr_values, $off + 1, 1);
17770a920b5bSAndy Whitcroft
17781f65f947SAndy Whitcroft				# Get the full operator variant.
17791f65f947SAndy Whitcroft				my $opv = $op . substr($curr_vars, $off, 1);
17801f65f947SAndy Whitcroft
178113214adfSAndy Whitcroft				# Ignore operators passed as parameters.
178213214adfSAndy Whitcroft				if ($op_type ne 'V' &&
178313214adfSAndy Whitcroft				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {
178413214adfSAndy Whitcroft
1785cf655043SAndy Whitcroft#				# Ignore comments
1786cf655043SAndy Whitcroft#				} elsif ($op =~ /^$;+$/) {
178713214adfSAndy Whitcroft
1788d8aaf121SAndy Whitcroft				# ; should have either the end of line or a space or \ after it
178913214adfSAndy Whitcroft				} elsif ($op eq ';') {
1790cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEBC]/ &&
1791cf655043SAndy Whitcroft					    $cc !~ /^\\/ && $cc !~ /^;/) {
1792773647a0SAndy Whitcroft						ERROR("space required after that '$op' $at\n" . $hereptr);
1793d8aaf121SAndy Whitcroft					}
1794d8aaf121SAndy Whitcroft
1795d8aaf121SAndy Whitcroft				# // is a comment
1796d8aaf121SAndy Whitcroft				} elsif ($op eq '//') {
17970a920b5bSAndy Whitcroft
17981f65f947SAndy Whitcroft				# No spaces for:
17991f65f947SAndy Whitcroft				#   ->
18001f65f947SAndy Whitcroft				#   :   when part of a bitfield
18011f65f947SAndy Whitcroft				} elsif ($op eq '->' || $opv eq ':B') {
18024a0df2efSAndy Whitcroft					if ($ctx =~ /Wx.|.xW/) {
1803773647a0SAndy Whitcroft						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
18040a920b5bSAndy Whitcroft					}
18050a920b5bSAndy Whitcroft
18060a920b5bSAndy Whitcroft				# , must have a space on the right.
18070a920b5bSAndy Whitcroft				} elsif ($op eq ',') {
1808cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1809773647a0SAndy Whitcroft						ERROR("space required after that '$op' $at\n" . $hereptr);
18100a920b5bSAndy Whitcroft					}
18110a920b5bSAndy Whitcroft
18129c0ca6f9SAndy Whitcroft				# '*' as part of a type definition -- reported already.
181374048ed8SAndy Whitcroft				} elsif ($opv eq '*_') {
18149c0ca6f9SAndy Whitcroft					#warn "'*' is part of type\n";
18159c0ca6f9SAndy Whitcroft
18169c0ca6f9SAndy Whitcroft				# unary operators should have a space before and
18179c0ca6f9SAndy Whitcroft				# none after.  May be left adjacent to another
18189c0ca6f9SAndy Whitcroft				# unary operator, or a cast
18199c0ca6f9SAndy Whitcroft				} elsif ($op eq '!' || $op eq '~' ||
182074048ed8SAndy Whitcroft					 $opv eq '*U' || $opv eq '-U' ||
18210d413866SAndy Whitcroft					 $opv eq '&U' || $opv eq '&&U') {
1822cf655043SAndy Whitcroft					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1823773647a0SAndy Whitcroft						ERROR("space required before that '$op' $at\n" . $hereptr);
18240a920b5bSAndy Whitcroft					}
1825171ae1a4SAndy Whitcroft					if ($op eq '*' && $cc =~/\s*const\b/) {
1826171ae1a4SAndy Whitcroft						# A unary '*' may be const
1827171ae1a4SAndy Whitcroft
1828171ae1a4SAndy Whitcroft					} elsif ($ctx =~ /.xW/) {
1829773647a0SAndy Whitcroft						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
18300a920b5bSAndy Whitcroft					}
18310a920b5bSAndy Whitcroft
18320a920b5bSAndy Whitcroft				# unary ++ and unary -- are allowed no space on one side.
18330a920b5bSAndy Whitcroft				} elsif ($op eq '++' or $op eq '--') {
1834773647a0SAndy Whitcroft					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1835773647a0SAndy Whitcroft						ERROR("space required one side of that '$op' $at\n" . $hereptr);
18360a920b5bSAndy Whitcroft					}
1837773647a0SAndy Whitcroft					if ($ctx =~ /Wx[BE]/ ||
1838773647a0SAndy Whitcroft					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1839773647a0SAndy Whitcroft						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1840653d4876SAndy Whitcroft					}
1841773647a0SAndy Whitcroft					if ($ctx =~ /ExW/) {
1842773647a0SAndy Whitcroft						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1843773647a0SAndy Whitcroft					}
1844773647a0SAndy Whitcroft
18450a920b5bSAndy Whitcroft
18460a920b5bSAndy Whitcroft				# << and >> may either have or not have spaces both sides
18479c0ca6f9SAndy Whitcroft				} elsif ($op eq '<<' or $op eq '>>' or
18489c0ca6f9SAndy Whitcroft					 $op eq '&' or $op eq '^' or $op eq '|' or
18499c0ca6f9SAndy Whitcroft					 $op eq '+' or $op eq '-' or
1850c2fdda0dSAndy Whitcroft					 $op eq '*' or $op eq '/' or
1851c2fdda0dSAndy Whitcroft					 $op eq '%')
18520a920b5bSAndy Whitcroft				{
1853773647a0SAndy Whitcroft					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1854de7d4f0eSAndy Whitcroft						ERROR("need consistent spacing around '$op' $at\n" .
1855de7d4f0eSAndy Whitcroft							$hereptr);
18560a920b5bSAndy Whitcroft					}
18570a920b5bSAndy Whitcroft
18581f65f947SAndy Whitcroft				# A colon needs no spaces before when it is
18591f65f947SAndy Whitcroft				# terminating a case value or a label.
18601f65f947SAndy Whitcroft				} elsif ($opv eq ':C' || $opv eq ':L') {
18611f65f947SAndy Whitcroft					if ($ctx =~ /Wx./) {
18621f65f947SAndy Whitcroft						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
18631f65f947SAndy Whitcroft					}
18641f65f947SAndy Whitcroft
18650a920b5bSAndy Whitcroft				# All the others need spaces both sides.
1866cf655043SAndy Whitcroft				} elsif ($ctx !~ /[EWC]x[CWE]/) {
18671f65f947SAndy Whitcroft					my $ok = 0;
18681f65f947SAndy Whitcroft
186922f2a2efSAndy Whitcroft					# Ignore email addresses <foo@bar>
18701f65f947SAndy Whitcroft					if (($op eq '<' &&
18711f65f947SAndy Whitcroft					     $cc =~ /^\S+\@\S+>/) ||
18721f65f947SAndy Whitcroft					    ($op eq '>' &&
18731f65f947SAndy Whitcroft					     $ca =~ /<\S+\@\S+$/))
18741f65f947SAndy Whitcroft					{
18751f65f947SAndy Whitcroft					    	$ok = 1;
18761f65f947SAndy Whitcroft					}
18771f65f947SAndy Whitcroft
18781f65f947SAndy Whitcroft					# Ignore ?:
18791f65f947SAndy Whitcroft					if (($opv eq ':O' && $ca =~ /\?$/) ||
18801f65f947SAndy Whitcroft					    ($op eq '?' && $cc =~ /^:/)) {
18811f65f947SAndy Whitcroft					    	$ok = 1;
18821f65f947SAndy Whitcroft					}
18831f65f947SAndy Whitcroft
18841f65f947SAndy Whitcroft					if ($ok == 0) {
1885773647a0SAndy Whitcroft						ERROR("spaces required around that '$op' $at\n" . $hereptr);
18860a920b5bSAndy Whitcroft					}
188722f2a2efSAndy Whitcroft				}
18884a0df2efSAndy Whitcroft				$off += length($elements[$n + 1]);
18890a920b5bSAndy Whitcroft			}
18900a920b5bSAndy Whitcroft		}
18910a920b5bSAndy Whitcroft
1892f0a594c1SAndy Whitcroft# check for multiple assignments
1893f0a594c1SAndy Whitcroft		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
18946c72ffaaSAndy Whitcroft			CHK("multiple assignments should be avoided\n" . $herecurr);
1895f0a594c1SAndy Whitcroft		}
1896f0a594c1SAndy Whitcroft
189722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration
189822f2a2efSAndy Whitcroft## # continuation.
189922f2a2efSAndy Whitcroft## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
190022f2a2efSAndy Whitcroft## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
190122f2a2efSAndy Whitcroft##
190222f2a2efSAndy Whitcroft## 			# Remove any bracketed sections to ensure we do not
190322f2a2efSAndy Whitcroft## 			# falsly report the parameters of functions.
190422f2a2efSAndy Whitcroft## 			my $ln = $line;
190522f2a2efSAndy Whitcroft## 			while ($ln =~ s/\([^\(\)]*\)//g) {
190622f2a2efSAndy Whitcroft## 			}
190722f2a2efSAndy Whitcroft## 			if ($ln =~ /,/) {
190822f2a2efSAndy Whitcroft## 				WARN("declaring multiple variables together should be avoided\n" . $herecurr);
190922f2a2efSAndy Whitcroft## 			}
191022f2a2efSAndy Whitcroft## 		}
1911f0a594c1SAndy Whitcroft
19120a920b5bSAndy Whitcroft#need space before brace following if, while, etc
191322f2a2efSAndy Whitcroft		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
191422f2a2efSAndy Whitcroft		    $line =~ /do{/) {
1915773647a0SAndy Whitcroft			ERROR("space required before the open brace '{'\n" . $herecurr);
1916de7d4f0eSAndy Whitcroft		}
1917de7d4f0eSAndy Whitcroft
1918de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything
1919de7d4f0eSAndy Whitcroft# on the line
1920de7d4f0eSAndy Whitcroft		if ($line =~ /}(?!(?:,|;|\)))\S/) {
1921773647a0SAndy Whitcroft			ERROR("space required after that close brace '}'\n" . $herecurr);
19220a920b5bSAndy Whitcroft		}
19230a920b5bSAndy Whitcroft
192422f2a2efSAndy Whitcroft# check spacing on square brackets
192522f2a2efSAndy Whitcroft		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1926773647a0SAndy Whitcroft			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
192722f2a2efSAndy Whitcroft		}
192822f2a2efSAndy Whitcroft		if ($line =~ /\s\]/) {
1929773647a0SAndy Whitcroft			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
193022f2a2efSAndy Whitcroft		}
193122f2a2efSAndy Whitcroft
1932c45dcabdSAndy Whitcroft# check spacing on parentheses
19339c0ca6f9SAndy Whitcroft		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
19349c0ca6f9SAndy Whitcroft		    $line !~ /for\s*\(\s+;/) {
1935773647a0SAndy Whitcroft			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
193622f2a2efSAndy Whitcroft		}
193713214adfSAndy Whitcroft		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1938c45dcabdSAndy Whitcroft		    $line !~ /for\s*\(.*;\s+\)/ &&
1939c45dcabdSAndy Whitcroft		    $line !~ /:\s+\)/) {
1940773647a0SAndy Whitcroft			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
194122f2a2efSAndy Whitcroft		}
194222f2a2efSAndy Whitcroft
19430a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however
19444a0df2efSAndy Whitcroft		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
19450a920b5bSAndy Whitcroft		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1946de7d4f0eSAndy Whitcroft			WARN("labels should not be indented\n" . $herecurr);
19470a920b5bSAndy Whitcroft		}
19480a920b5bSAndy Whitcroft
1949c45dcabdSAndy Whitcroft# Return is not a function.
1950c45dcabdSAndy Whitcroft		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1951c45dcabdSAndy Whitcroft			my $spacing = $1;
1952c45dcabdSAndy Whitcroft			my $value = $2;
1953c45dcabdSAndy Whitcroft
1954c45dcabdSAndy Whitcroft			# Flatten any parentheses and braces
1955fee61c47SAndy Whitcroft			$value =~ s/\)\(/\) \(/g;
1956c45dcabdSAndy Whitcroft			while ($value =~ s/\([^\(\)]*\)/1/) {
1957c45dcabdSAndy Whitcroft			}
1958c45dcabdSAndy Whitcroft
1959c45dcabdSAndy Whitcroft			if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1960c45dcabdSAndy Whitcroft				ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1961c45dcabdSAndy Whitcroft
1962c45dcabdSAndy Whitcroft			} elsif ($spacing !~ /\s+/) {
1963c45dcabdSAndy Whitcroft				ERROR("space required before the open parenthesis '('\n" . $herecurr);
1964c45dcabdSAndy Whitcroft			}
1965c45dcabdSAndy Whitcroft		}
1966c45dcabdSAndy Whitcroft
19670a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc
19684a0df2efSAndy Whitcroft		if ($line=~/\b(if|while|for|switch)\(/) {
1969773647a0SAndy Whitcroft			ERROR("space required before the open parenthesis '('\n" . $herecurr);
19700a920b5bSAndy Whitcroft		}
19710a920b5bSAndy Whitcroft
1972f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing
1973f5fe35ddSAndy Whitcroft# statements after the conditional.
1974170d3a22SAndy Whitcroft		if ($line =~ /do\s*(?!{)/) {
1975170d3a22SAndy Whitcroft			my ($stat_next) = ctx_statement_block($line_nr_next,
1976170d3a22SAndy Whitcroft						$remain_next, $off_next);
1977170d3a22SAndy Whitcroft			$stat_next =~ s/\n./\n /g;
1978170d3a22SAndy Whitcroft			##print "stat<$stat> stat_next<$stat_next>\n";
1979170d3a22SAndy Whitcroft
1980170d3a22SAndy Whitcroft			if ($stat_next =~ /^\s*while\b/) {
1981170d3a22SAndy Whitcroft				# If the statement carries leading newlines,
1982170d3a22SAndy Whitcroft				# then count those as offsets.
1983170d3a22SAndy Whitcroft				my ($whitespace) =
1984170d3a22SAndy Whitcroft					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
1985170d3a22SAndy Whitcroft				my $offset =
1986170d3a22SAndy Whitcroft					statement_rawlines($whitespace) - 1;
1987170d3a22SAndy Whitcroft
1988170d3a22SAndy Whitcroft				$suppress_whiletrailers{$line_nr_next +
1989170d3a22SAndy Whitcroft								$offset} = 1;
1990170d3a22SAndy Whitcroft			}
1991170d3a22SAndy Whitcroft		}
1992170d3a22SAndy Whitcroft		if (!defined $suppress_whiletrailers{$linenr} &&
1993170d3a22SAndy Whitcroft		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1994171ae1a4SAndy Whitcroft			my ($s, $c) = ($stat, $cond);
19958905a67cSAndy Whitcroft
19968905a67cSAndy Whitcroft			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1997c2fdda0dSAndy Whitcroft				ERROR("do not use assignment in if condition\n" . $herecurr);
19988905a67cSAndy Whitcroft			}
19998905a67cSAndy Whitcroft
20008905a67cSAndy Whitcroft			# Find out what is on the end of the line after the
20018905a67cSAndy Whitcroft			# conditional.
2002773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
20038905a67cSAndy Whitcroft			$s =~ s/\n.*//g;
200413214adfSAndy Whitcroft			$s =~ s/$;//g; 	# Remove any comments
200553210168SAndy Whitcroft			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
200653210168SAndy Whitcroft			    $c !~ /}\s*while\s*/)
2007773647a0SAndy Whitcroft			{
2008bb44ad39SAndy Whitcroft				# Find out how long the conditional actually is.
2009bb44ad39SAndy Whitcroft				my @newlines = ($c =~ /\n/gs);
2010bb44ad39SAndy Whitcroft				my $cond_lines = 1 + $#newlines;
2011bb44ad39SAndy Whitcroft
2012bb44ad39SAndy Whitcroft				my $stat_real = raw_line($linenr, $cond_lines);
2013bb44ad39SAndy Whitcroft				if (defined($stat_real) && $cond_lines > 1) {
2014bb44ad39SAndy Whitcroft					$stat_real = "[...]\n$stat_real";
2015bb44ad39SAndy Whitcroft				}
2016bb44ad39SAndy Whitcroft
2017bb44ad39SAndy Whitcroft				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
20188905a67cSAndy Whitcroft			}
20198905a67cSAndy Whitcroft		}
20208905a67cSAndy Whitcroft
202113214adfSAndy Whitcroft# Check for bitwise tests written as boolean
202213214adfSAndy Whitcroft		if ($line =~ /
202313214adfSAndy Whitcroft			(?:
202413214adfSAndy Whitcroft				(?:\[|\(|\&\&|\|\|)
202513214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
202613214adfSAndy Whitcroft				(?:\&\&|\|\|)
202713214adfSAndy Whitcroft			|
202813214adfSAndy Whitcroft				(?:\&\&|\|\|)
202913214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
203013214adfSAndy Whitcroft				(?:\&\&|\|\||\)|\])
203113214adfSAndy Whitcroft			)/x)
203213214adfSAndy Whitcroft		{
203313214adfSAndy Whitcroft			WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
203413214adfSAndy Whitcroft		}
203513214adfSAndy Whitcroft
20368905a67cSAndy Whitcroft# if and else should not have general statements after it
203713214adfSAndy Whitcroft		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
203813214adfSAndy Whitcroft			my $s = $1;
203913214adfSAndy Whitcroft			$s =~ s/$;//g; 	# Remove any comments
204013214adfSAndy Whitcroft			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
20418905a67cSAndy Whitcroft				ERROR("trailing statements should be on next line\n" . $herecurr);
20420a920b5bSAndy Whitcroft			}
204313214adfSAndy Whitcroft		}
2044a1080bf8SAndy Whitcroft# case and default should not have general statements after them
2045a1080bf8SAndy Whitcroft		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2046a1080bf8SAndy Whitcroft		    $line !~ /\G(?:
20473fef12d6SAndy Whitcroft			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2048a1080bf8SAndy Whitcroft			\s*return\s+
2049a1080bf8SAndy Whitcroft		    )/xg)
2050a1080bf8SAndy Whitcroft		{
2051a1080bf8SAndy Whitcroft			ERROR("trailing statements should be on next line\n" . $herecurr);
2052a1080bf8SAndy Whitcroft		}
20530a920b5bSAndy Whitcroft
20540a920b5bSAndy Whitcroft		# Check for }<nl>else {, these must be at the same
20550a920b5bSAndy Whitcroft		# indent level to be relevant to each other.
20560a920b5bSAndy Whitcroft		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
20570a920b5bSAndy Whitcroft						$previndent == $indent) {
2058de7d4f0eSAndy Whitcroft			ERROR("else should follow close brace '}'\n" . $hereprev);
20590a920b5bSAndy Whitcroft		}
20600a920b5bSAndy Whitcroft
2061c2fdda0dSAndy Whitcroft		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2062c2fdda0dSAndy Whitcroft						$previndent == $indent) {
2063c2fdda0dSAndy Whitcroft			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2064c2fdda0dSAndy Whitcroft
2065c2fdda0dSAndy Whitcroft			# Find out what is on the end of the line after the
2066c2fdda0dSAndy Whitcroft			# conditional.
2067773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
2068c2fdda0dSAndy Whitcroft			$s =~ s/\n.*//g;
2069c2fdda0dSAndy Whitcroft
2070c2fdda0dSAndy Whitcroft			if ($s =~ /^\s*;/) {
2071c2fdda0dSAndy Whitcroft				ERROR("while should follow close brace '}'\n" . $hereprev);
2072c2fdda0dSAndy Whitcroft			}
2073c2fdda0dSAndy Whitcroft		}
2074c2fdda0dSAndy Whitcroft
20750a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new
20760a920b5bSAndy Whitcroft#		if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
20770a920b5bSAndy Whitcroft#		    print "No studly caps, use _\n";
20780a920b5bSAndy Whitcroft#		    print "$herecurr";
20790a920b5bSAndy Whitcroft#		    $clean = 0;
20800a920b5bSAndy Whitcroft#		}
20810a920b5bSAndy Whitcroft
20820a920b5bSAndy Whitcroft#no spaces allowed after \ in define
2083c45dcabdSAndy Whitcroft		if ($line=~/\#\s*define.*\\\s$/) {
2084de7d4f0eSAndy Whitcroft			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
20850a920b5bSAndy Whitcroft		}
20860a920b5bSAndy Whitcroft
2087653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2088c45dcabdSAndy Whitcroft		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2089e09dec48SAndy Whitcroft			my $file = "$1.h";
2090e09dec48SAndy Whitcroft			my $checkfile = "include/linux/$file";
2091e09dec48SAndy Whitcroft			if (-f "$root/$checkfile" &&
2092e09dec48SAndy Whitcroft			    $realfile ne $checkfile &&
2093c45dcabdSAndy Whitcroft			    $1 ne 'irq')
2094c45dcabdSAndy Whitcroft			{
2095e09dec48SAndy Whitcroft				if ($realfile =~ m{^arch/}) {
2096e09dec48SAndy Whitcroft					CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2097e09dec48SAndy Whitcroft				} else {
2098e09dec48SAndy Whitcroft					WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2099e09dec48SAndy Whitcroft				}
21000a920b5bSAndy Whitcroft			}
21010a920b5bSAndy Whitcroft		}
21020a920b5bSAndy Whitcroft
2103653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the
2104653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed
2105cf655043SAndy Whitcroft# in a known good container
2106b8f96a31SAndy Whitcroft		if ($realfile !~ m@/vmlinux.lds.h$@ &&
2107b8f96a31SAndy Whitcroft		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2108d8aaf121SAndy Whitcroft			my $ln = $linenr;
2109d8aaf121SAndy Whitcroft			my $cnt = $realcnt;
2110c45dcabdSAndy Whitcroft			my ($off, $dstat, $dcond, $rest);
2111c45dcabdSAndy Whitcroft			my $ctx = '';
2112653d4876SAndy Whitcroft
2113c45dcabdSAndy Whitcroft			my $args = defined($1);
2114de7d4f0eSAndy Whitcroft
2115c45dcabdSAndy Whitcroft			# Find the end of the macro and limit our statement
2116c45dcabdSAndy Whitcroft			# search to that.
2117c45dcabdSAndy Whitcroft			while ($cnt > 0 && defined $lines[$ln - 1] &&
2118c45dcabdSAndy Whitcroft				$lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2119c45dcabdSAndy Whitcroft			{
2120c45dcabdSAndy Whitcroft				$ctx .= $rawlines[$ln - 1] . "\n";
2121a3bb97a7SAndy Whitcroft				$cnt-- if ($lines[$ln - 1] !~ /^-/);
2122c45dcabdSAndy Whitcroft				$ln++;
2123de7d4f0eSAndy Whitcroft			}
2124c45dcabdSAndy Whitcroft			$ctx .= $rawlines[$ln - 1];
2125d8aaf121SAndy Whitcroft
2126c45dcabdSAndy Whitcroft			($dstat, $dcond, $ln, $cnt, $off) =
2127c45dcabdSAndy Whitcroft				ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2128c45dcabdSAndy Whitcroft			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2129a3bb97a7SAndy Whitcroft			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2130c45dcabdSAndy Whitcroft
2131c45dcabdSAndy Whitcroft			# Extract the remainder of the define (if any) and
2132c45dcabdSAndy Whitcroft			# rip off surrounding spaces, and trailing \'s.
2133c45dcabdSAndy Whitcroft			$rest = '';
2134636d140aSAndy Whitcroft			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2135636d140aSAndy Whitcroft				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2136a3bb97a7SAndy Whitcroft				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2137c45dcabdSAndy Whitcroft					$rest .= substr($lines[$ln - 1], $off) . "\n";
2138c45dcabdSAndy Whitcroft					$cnt--;
2139a3bb97a7SAndy Whitcroft				}
2140a3bb97a7SAndy Whitcroft				$ln++;
2141c45dcabdSAndy Whitcroft				$off = 0;
2142c45dcabdSAndy Whitcroft			}
2143c45dcabdSAndy Whitcroft			$rest =~ s/\\\n.//g;
2144c45dcabdSAndy Whitcroft			$rest =~ s/^\s*//s;
2145c45dcabdSAndy Whitcroft			$rest =~ s/\s*$//s;
2146c45dcabdSAndy Whitcroft
2147c45dcabdSAndy Whitcroft			# Clean up the original statement.
2148c45dcabdSAndy Whitcroft			if ($args) {
2149c45dcabdSAndy Whitcroft				substr($dstat, 0, length($dcond), '');
2150d8aaf121SAndy Whitcroft			} else {
2151c45dcabdSAndy Whitcroft				$dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2152c45dcabdSAndy Whitcroft			}
2153292f1a9bSAndy Whitcroft			$dstat =~ s/$;//g;
2154c45dcabdSAndy Whitcroft			$dstat =~ s/\\\n.//g;
2155c45dcabdSAndy Whitcroft			$dstat =~ s/^\s*//s;
2156c45dcabdSAndy Whitcroft			$dstat =~ s/\s*$//s;
2157c45dcabdSAndy Whitcroft
2158c45dcabdSAndy Whitcroft			# Flatten any parentheses and braces
2159bf30d6edSAndy Whitcroft			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2160bf30d6edSAndy Whitcroft			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
2161bf30d6edSAndy Whitcroft			       $dstat =~ s/\[[^\{\}]*\]/1/)
2162bf30d6edSAndy Whitcroft			{
2163c45dcabdSAndy Whitcroft			}
2164c45dcabdSAndy Whitcroft
2165c45dcabdSAndy Whitcroft			my $exceptions = qr{
2166c45dcabdSAndy Whitcroft				$Declare|
2167c45dcabdSAndy Whitcroft				module_param_named|
2168c45dcabdSAndy Whitcroft				MODULE_PARAM_DESC|
2169c45dcabdSAndy Whitcroft				DECLARE_PER_CPU|
2170c45dcabdSAndy Whitcroft				DEFINE_PER_CPU|
2171383099fdSAndy Whitcroft				__typeof__\(|
2172383099fdSAndy Whitcroft				\.$Ident\s*=\s*
2173c45dcabdSAndy Whitcroft			}x;
2174383099fdSAndy Whitcroft			#print "REST<$rest> dstat<$dstat>\n";
2175c45dcabdSAndy Whitcroft			if ($rest ne '') {
2176c45dcabdSAndy Whitcroft				if ($rest !~ /while\s*\(/ &&
2177c45dcabdSAndy Whitcroft				    $dstat !~ /$exceptions/)
2178c45dcabdSAndy Whitcroft				{
2179c45dcabdSAndy Whitcroft					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2180c45dcabdSAndy Whitcroft				}
2181c45dcabdSAndy Whitcroft
2182c45dcabdSAndy Whitcroft			} elsif ($ctx !~ /;/) {
2183c45dcabdSAndy Whitcroft				if ($dstat ne '' &&
2184c45dcabdSAndy Whitcroft				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2185c45dcabdSAndy Whitcroft				    $dstat !~ /$exceptions/ &&
2186b132e5d5SAndy Whitcroft				    $dstat !~ /^\.$Ident\s*=/ &&
2187c45dcabdSAndy Whitcroft				    $dstat =~ /$Operators/)
2188c45dcabdSAndy Whitcroft				{
2189de7d4f0eSAndy Whitcroft					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2190d8aaf121SAndy Whitcroft				}
21910a920b5bSAndy Whitcroft			}
2192653d4876SAndy Whitcroft		}
21930a920b5bSAndy Whitcroft
2194f0a594c1SAndy Whitcroft# check for redundant bracing round if etc
219513214adfSAndy Whitcroft		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
219613214adfSAndy Whitcroft			my ($level, $endln, @chunks) =
2197cf655043SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, 1);
219813214adfSAndy Whitcroft			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2199cf655043SAndy Whitcroft			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2200cf655043SAndy Whitcroft			if ($#chunks > 0 && $level == 0) {
220113214adfSAndy Whitcroft				my $allowed = 0;
220213214adfSAndy Whitcroft				my $seen = 0;
2203773647a0SAndy Whitcroft				my $herectx = $here . "\n";
2204cf655043SAndy Whitcroft				my $ln = $linenr - 1;
220513214adfSAndy Whitcroft				for my $chunk (@chunks) {
220613214adfSAndy Whitcroft					my ($cond, $block) = @{$chunk};
220713214adfSAndy Whitcroft
2208773647a0SAndy Whitcroft					# If the condition carries leading newlines, then count those as offsets.
2209773647a0SAndy Whitcroft					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2210773647a0SAndy Whitcroft					my $offset = statement_rawlines($whitespace) - 1;
2211773647a0SAndy Whitcroft
2212773647a0SAndy Whitcroft					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2213773647a0SAndy Whitcroft
2214773647a0SAndy Whitcroft					# We have looked at and allowed this specific line.
2215773647a0SAndy Whitcroft					$suppress_ifbraces{$ln + $offset} = 1;
2216773647a0SAndy Whitcroft
2217773647a0SAndy Whitcroft					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2218cf655043SAndy Whitcroft					$ln += statement_rawlines($block) - 1;
2219cf655043SAndy Whitcroft
2220773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
222113214adfSAndy Whitcroft
222213214adfSAndy Whitcroft					$seen++ if ($block =~ /^\s*{/);
222313214adfSAndy Whitcroft
2224cf655043SAndy Whitcroft					#print "cond<$cond> block<$block> allowed<$allowed>\n";
2225cf655043SAndy Whitcroft					if (statement_lines($cond) > 1) {
2226cf655043SAndy Whitcroft						#print "APW: ALLOWED: cond<$cond>\n";
222713214adfSAndy Whitcroft						$allowed = 1;
222813214adfSAndy Whitcroft					}
222913214adfSAndy Whitcroft					if ($block =~/\b(?:if|for|while)\b/) {
2230cf655043SAndy Whitcroft						#print "APW: ALLOWED: block<$block>\n";
223113214adfSAndy Whitcroft						$allowed = 1;
223213214adfSAndy Whitcroft					}
2233cf655043SAndy Whitcroft					if (statement_block_size($block) > 1) {
2234cf655043SAndy Whitcroft						#print "APW: ALLOWED: lines block<$block>\n";
223513214adfSAndy Whitcroft						$allowed = 1;
223613214adfSAndy Whitcroft					}
223713214adfSAndy Whitcroft				}
223813214adfSAndy Whitcroft				if ($seen && !$allowed) {
2239cf655043SAndy Whitcroft					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
224013214adfSAndy Whitcroft				}
224113214adfSAndy Whitcroft			}
224213214adfSAndy Whitcroft		}
2243773647a0SAndy Whitcroft		if (!defined $suppress_ifbraces{$linenr - 1} &&
224413214adfSAndy Whitcroft					$line =~ /\b(if|while|for|else)\b/) {
2245cf655043SAndy Whitcroft			my $allowed = 0;
2246f0a594c1SAndy Whitcroft
2247cf655043SAndy Whitcroft			# Check the pre-context.
2248cf655043SAndy Whitcroft			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2249cf655043SAndy Whitcroft				#print "APW: ALLOWED: pre<$1>\n";
2250cf655043SAndy Whitcroft				$allowed = 1;
2251f0a594c1SAndy Whitcroft			}
2252773647a0SAndy Whitcroft
2253773647a0SAndy Whitcroft			my ($level, $endln, @chunks) =
2254773647a0SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, $-[0]);
2255773647a0SAndy Whitcroft
2256cf655043SAndy Whitcroft			# Check the condition.
2257cf655043SAndy Whitcroft			my ($cond, $block) = @{$chunks[0]};
2258773647a0SAndy Whitcroft			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2259cf655043SAndy Whitcroft			if (defined $cond) {
2260773647a0SAndy Whitcroft				substr($block, 0, length($cond), '');
2261cf655043SAndy Whitcroft			}
2262cf655043SAndy Whitcroft			if (statement_lines($cond) > 1) {
2263cf655043SAndy Whitcroft				#print "APW: ALLOWED: cond<$cond>\n";
2264cf655043SAndy Whitcroft				$allowed = 1;
2265cf655043SAndy Whitcroft			}
2266cf655043SAndy Whitcroft			if ($block =~/\b(?:if|for|while)\b/) {
2267cf655043SAndy Whitcroft				#print "APW: ALLOWED: block<$block>\n";
2268cf655043SAndy Whitcroft				$allowed = 1;
2269cf655043SAndy Whitcroft			}
2270cf655043SAndy Whitcroft			if (statement_block_size($block) > 1) {
2271cf655043SAndy Whitcroft				#print "APW: ALLOWED: lines block<$block>\n";
2272cf655043SAndy Whitcroft				$allowed = 1;
2273cf655043SAndy Whitcroft			}
2274cf655043SAndy Whitcroft			# Check the post-context.
2275cf655043SAndy Whitcroft			if (defined $chunks[1]) {
2276cf655043SAndy Whitcroft				my ($cond, $block) = @{$chunks[1]};
2277cf655043SAndy Whitcroft				if (defined $cond) {
2278773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
2279cf655043SAndy Whitcroft				}
2280cf655043SAndy Whitcroft				if ($block =~ /^\s*\{/) {
2281cf655043SAndy Whitcroft					#print "APW: ALLOWED: chunk-1 block<$block>\n";
2282cf655043SAndy Whitcroft					$allowed = 1;
2283cf655043SAndy Whitcroft				}
2284cf655043SAndy Whitcroft			}
2285cf655043SAndy Whitcroft			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2286cf655043SAndy Whitcroft				my $herectx = $here . "\n";;
2287f055663cSAndy Whitcroft				my $cnt = statement_rawlines($block);
2288cf655043SAndy Whitcroft
2289f055663cSAndy Whitcroft				for (my $n = 0; $n < $cnt; $n++) {
2290f055663cSAndy Whitcroft					$herectx .= raw_line($linenr, $n) . "\n";;
2291cf655043SAndy Whitcroft				}
2292cf655043SAndy Whitcroft
2293cf655043SAndy Whitcroft				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2294f0a594c1SAndy Whitcroft			}
2295f0a594c1SAndy Whitcroft		}
2296f0a594c1SAndy Whitcroft
2297653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line)
22984a0df2efSAndy Whitcroft		for my $inc (@dep_includes) {
2299c45dcabdSAndy Whitcroft			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2300de7d4f0eSAndy Whitcroft				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
23010a920b5bSAndy Whitcroft			}
23020a920b5bSAndy Whitcroft		}
23030a920b5bSAndy Whitcroft
23044a0df2efSAndy Whitcroft# don't use deprecated functions
23054a0df2efSAndy Whitcroft		for my $func (@dep_functions) {
230600df344fSAndy Whitcroft			if ($line =~ /\b$func\b/) {
2307de7d4f0eSAndy Whitcroft				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
23084a0df2efSAndy Whitcroft			}
23094a0df2efSAndy Whitcroft		}
23104a0df2efSAndy Whitcroft
23114a0df2efSAndy Whitcroft# no volatiles please
23126c72ffaaSAndy Whitcroft		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
23136c72ffaaSAndy Whitcroft		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2314de7d4f0eSAndy Whitcroft			WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
23154a0df2efSAndy Whitcroft		}
23164a0df2efSAndy Whitcroft
23179c0ca6f9SAndy Whitcroft# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
23189c0ca6f9SAndy Whitcroft		if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
23199c0ca6f9SAndy Whitcroft			ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
23209c0ca6f9SAndy Whitcroft		}
23219c0ca6f9SAndy Whitcroft
232200df344fSAndy Whitcroft# warn about #if 0
2323c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2324de7d4f0eSAndy Whitcroft			CHK("if this code is redundant consider removing it\n" .
2325de7d4f0eSAndy Whitcroft				$herecurr);
23264a0df2efSAndy Whitcroft		}
23274a0df2efSAndy Whitcroft
2328f0a594c1SAndy Whitcroft# check for needless kfree() checks
2329f0a594c1SAndy Whitcroft		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2330f0a594c1SAndy Whitcroft			my $expr = $1;
2331f0a594c1SAndy Whitcroft			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
23323c232147SWolfram Sang				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2333f0a594c1SAndy Whitcroft			}
2334f0a594c1SAndy Whitcroft		}
23354c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks
23364c432a8fSGreg Kroah-Hartman		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
23374c432a8fSGreg Kroah-Hartman			my $expr = $1;
23384c432a8fSGreg Kroah-Hartman			if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
23394c432a8fSGreg Kroah-Hartman				WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
23404c432a8fSGreg Kroah-Hartman			}
23414c432a8fSGreg Kroah-Hartman		}
2342f0a594c1SAndy Whitcroft
234300df344fSAndy Whitcroft# warn about #ifdefs in C files
2344c45dcabdSAndy Whitcroft#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
234500df344fSAndy Whitcroft#			print "#ifdef in C files should be avoided\n";
234600df344fSAndy Whitcroft#			print "$herecurr";
234700df344fSAndy Whitcroft#			$clean = 0;
234800df344fSAndy Whitcroft#		}
234900df344fSAndy Whitcroft
235022f2a2efSAndy Whitcroft# warn about spacing in #ifdefs
2351c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
235222f2a2efSAndy Whitcroft			ERROR("exactly one space required after that #$1\n" . $herecurr);
235322f2a2efSAndy Whitcroft		}
235422f2a2efSAndy Whitcroft
23554a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment.
2356171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2357171ae1a4SAndy Whitcroft		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
23584a0df2efSAndy Whitcroft			my $which = $1;
23594a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
2360de7d4f0eSAndy Whitcroft				CHK("$1 definition without comment\n" . $herecurr);
23614a0df2efSAndy Whitcroft			}
23624a0df2efSAndy Whitcroft		}
23634a0df2efSAndy Whitcroft# check for memory barriers without a comment.
23644a0df2efSAndy Whitcroft		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
23654a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
2366de7d4f0eSAndy Whitcroft				CHK("memory barrier without comment\n" . $herecurr);
23674a0df2efSAndy Whitcroft			}
23684a0df2efSAndy Whitcroft		}
23694a0df2efSAndy Whitcroft# check of hardware specific defines
2370c45dcabdSAndy Whitcroft		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2371de7d4f0eSAndy Whitcroft			CHK("architecture specific defines should be avoided\n" .  $herecurr);
23720a920b5bSAndy Whitcroft		}
2373653d4876SAndy Whitcroft
2374de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between
2375de7d4f0eSAndy Whitcroft# storage class and type.
23769c0ca6f9SAndy Whitcroft		if ($line =~ /\b$Type\s+$Inline\b/ ||
23779c0ca6f9SAndy Whitcroft		    $line =~ /\b$Inline\s+$Storage\b/) {
2378de7d4f0eSAndy Whitcroft			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2379de7d4f0eSAndy Whitcroft		}
2380de7d4f0eSAndy Whitcroft
23818905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline
23828905a67cSAndy Whitcroft		if ($line =~ /\b(__inline__|__inline)\b/) {
23838905a67cSAndy Whitcroft			WARN("plain inline is preferred over $1\n" . $herecurr);
23848905a67cSAndy Whitcroft		}
23858905a67cSAndy Whitcroft
2386de7d4f0eSAndy Whitcroft# check for new externs in .c files.
2387171ae1a4SAndy Whitcroft		if ($realfile =~ /\.c$/ && defined $stat &&
2388c45dcabdSAndy Whitcroft		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2389171ae1a4SAndy Whitcroft		{
2390c45dcabdSAndy Whitcroft			my $function_name = $1;
2391c45dcabdSAndy Whitcroft			my $paren_space = $2;
2392171ae1a4SAndy Whitcroft
2393171ae1a4SAndy Whitcroft			my $s = $stat;
2394171ae1a4SAndy Whitcroft			if (defined $cond) {
2395171ae1a4SAndy Whitcroft				substr($s, 0, length($cond), '');
2396171ae1a4SAndy Whitcroft			}
2397c45dcabdSAndy Whitcroft			if ($s =~ /^\s*;/ &&
2398c45dcabdSAndy Whitcroft			    $function_name ne 'uninitialized_var')
2399c45dcabdSAndy Whitcroft			{
2400de7d4f0eSAndy Whitcroft				WARN("externs should be avoided in .c files\n" .  $herecurr);
2401de7d4f0eSAndy Whitcroft			}
2402de7d4f0eSAndy Whitcroft
2403171ae1a4SAndy Whitcroft			if ($paren_space =~ /\n/) {
2404171ae1a4SAndy Whitcroft				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2405171ae1a4SAndy Whitcroft			}
24069c9ba34eSAndy Whitcroft
24079c9ba34eSAndy Whitcroft		} elsif ($realfile =~ /\.c$/ && defined $stat &&
24089c9ba34eSAndy Whitcroft		    $stat =~ /^.\s*extern\s+/)
24099c9ba34eSAndy Whitcroft		{
24109c9ba34eSAndy Whitcroft			WARN("externs should be avoided in .c files\n" .  $herecurr);
2411171ae1a4SAndy Whitcroft		}
2412171ae1a4SAndy Whitcroft
2413de7d4f0eSAndy Whitcroft# checks for new __setup's
2414de7d4f0eSAndy Whitcroft		if ($rawline =~ /\b__setup\("([^"]*)"/) {
2415de7d4f0eSAndy Whitcroft			my $name = $1;
2416de7d4f0eSAndy Whitcroft
2417de7d4f0eSAndy Whitcroft			if (!grep(/$name/, @setup_docs)) {
2418de7d4f0eSAndy Whitcroft				CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2419de7d4f0eSAndy Whitcroft			}
2420653d4876SAndy Whitcroft		}
24219c0ca6f9SAndy Whitcroft
24229c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return
24239c0ca6f9SAndy Whitcroft		if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
24249c0ca6f9SAndy Whitcroft			WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
24259c0ca6f9SAndy Whitcroft		}
242613214adfSAndy Whitcroft
242713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__
242813214adfSAndy Whitcroft		if ($line =~ /__FUNCTION__/) {
242913214adfSAndy Whitcroft			WARN("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
243013214adfSAndy Whitcroft		}
2431773647a0SAndy Whitcroft
2432773647a0SAndy Whitcroft# check for semaphores used as mutexes
2433171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2434773647a0SAndy Whitcroft			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2435773647a0SAndy Whitcroft		}
2436773647a0SAndy Whitcroft# check for semaphores used as mutexes
2437171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2438773647a0SAndy Whitcroft			WARN("consider using a completion\n" . $herecurr);
2439773647a0SAndy Whitcroft		}
2440773647a0SAndy Whitcroft# recommend strict_strto* over simple_strto*
2441773647a0SAndy Whitcroft		if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2442773647a0SAndy Whitcroft			WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2443773647a0SAndy Whitcroft		}
2444f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please
2445f3db6639SMichael Ellerman		if ($line =~ /^.\s*__initcall\s*\(/) {
2446f3db6639SMichael Ellerman			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2447f3db6639SMichael Ellerman		}
2448773647a0SAndy Whitcroft
2449773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong
2450773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right
2451773647a0SAndy Whitcroft		if ($line =~ /\bNR_CPUS\b/ &&
2452c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2453c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2454171ae1a4SAndy Whitcroft		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2455171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2456171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2457773647a0SAndy Whitcroft		{
2458773647a0SAndy Whitcroft			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2459773647a0SAndy Whitcroft		}
24609c9ba34eSAndy Whitcroft
24619c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings
24629c9ba34eSAndy Whitcroft		my $string;
24639c9ba34eSAndy Whitcroft		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
24649c9ba34eSAndy Whitcroft			$string = substr($rawline, $-[1], $+[1] - $-[1]);
24652a1bc5d5SAndy Whitcroft			$string =~ s/%%/__/g;
24669c9ba34eSAndy Whitcroft			if ($string =~ /(?<!%)%L[udi]/) {
24679c9ba34eSAndy Whitcroft				WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
24689c9ba34eSAndy Whitcroft				last;
24699c9ba34eSAndy Whitcroft			}
24709c9ba34eSAndy Whitcroft		}
2471691d77b6SAndy Whitcroft
2472691d77b6SAndy Whitcroft# whine mightly about in_atomic
2473691d77b6SAndy Whitcroft		if ($line =~ /\bin_atomic\s*\(/) {
2474691d77b6SAndy Whitcroft			if ($realfile =~ m@^drivers/@) {
2475691d77b6SAndy Whitcroft				ERROR("do not use in_atomic in drivers\n" . $herecurr);
2476691d77b6SAndy Whitcroft			} else {
2477691d77b6SAndy Whitcroft				WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2478691d77b6SAndy Whitcroft			}
2479691d77b6SAndy Whitcroft		}
248013214adfSAndy Whitcroft	}
248113214adfSAndy Whitcroft
248213214adfSAndy Whitcroft	# If we have no input at all, then there is nothing to report on
248313214adfSAndy Whitcroft	# so just keep quiet.
248413214adfSAndy Whitcroft	if ($#rawlines == -1) {
248513214adfSAndy Whitcroft		exit(0);
24860a920b5bSAndy Whitcroft	}
24870a920b5bSAndy Whitcroft
24888905a67cSAndy Whitcroft	# In mailback mode only produce a report in the negative, for
24898905a67cSAndy Whitcroft	# things that appear to be patches.
24908905a67cSAndy Whitcroft	if ($mailback && ($clean == 1 || !$is_patch)) {
24918905a67cSAndy Whitcroft		exit(0);
24928905a67cSAndy Whitcroft	}
24938905a67cSAndy Whitcroft
24948905a67cSAndy Whitcroft	# This is not a patch, and we are are in 'no-patch' mode so
24958905a67cSAndy Whitcroft	# just keep quiet.
24968905a67cSAndy Whitcroft	if (!$chk_patch && !$is_patch) {
24978905a67cSAndy Whitcroft		exit(0);
24988905a67cSAndy Whitcroft	}
24998905a67cSAndy Whitcroft
25008905a67cSAndy Whitcroft	if (!$is_patch) {
2501de7d4f0eSAndy Whitcroft		ERROR("Does not appear to be a unified-diff format patch\n");
25020a920b5bSAndy Whitcroft	}
25030a920b5bSAndy Whitcroft	if ($is_patch && $chk_signoff && $signoff == 0) {
2504de7d4f0eSAndy Whitcroft		ERROR("Missing Signed-off-by: line(s)\n");
25050a920b5bSAndy Whitcroft	}
25060a920b5bSAndy Whitcroft
2507f0a594c1SAndy Whitcroft	print report_dump();
250813214adfSAndy Whitcroft	if ($summary && !($clean == 1 && $quiet == 1)) {
250913214adfSAndy Whitcroft		print "$filename " if ($summary_file);
25106c72ffaaSAndy Whitcroft		print "total: $cnt_error errors, $cnt_warn warnings, " .
25116c72ffaaSAndy Whitcroft			(($check)? "$cnt_chk checks, " : "") .
25126c72ffaaSAndy Whitcroft			"$cnt_lines lines checked\n";
25138905a67cSAndy Whitcroft		print "\n" if ($quiet == 0);
25146c72ffaaSAndy Whitcroft	}
25158905a67cSAndy Whitcroft
25160a920b5bSAndy Whitcroft	if ($clean == 1 && $quiet == 0) {
2517c2fdda0dSAndy Whitcroft		print "$vname has no obvious style problems and is ready for submission.\n"
25180a920b5bSAndy Whitcroft	}
25190a920b5bSAndy Whitcroft	if ($clean == 0 && $quiet == 0) {
2520c2fdda0dSAndy Whitcroft		print "$vname has style problems, please review.  If any of these errors\n";
25210a920b5bSAndy Whitcroft		print "are false positives report them to the maintainer, see\n";
25220a920b5bSAndy Whitcroft		print "CHECKPATCH in MAINTAINERS.\n";
25230a920b5bSAndy Whitcroft	}
252413214adfSAndy Whitcroft
25250a920b5bSAndy Whitcroft	return $clean;
25260a920b5bSAndy Whitcroft}
2527