xref: /openbmc/qemu/scripts/checkpatch.pl (revision a4d50b1d) 
1#!/usr/bin/perl -w
2# (c) 2001, Dave Jones. (the file handling bit)
3# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
11$P =~ s@.*/@@g;
12
13my $V = '0.31';
14
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
21my $tst_only;
22my $emacs = 0;
23my $terse = 0;
24my $file = 0;
25my $no_warnings = 0;
26my $summary = 1;
27my $mailback = 0;
28my $summary_file = 0;
29my $root;
30my %debug;
31my $help = 0;
32
33sub help {
34	my ($exitcode) = @_;
35
36	print << "EOM";
37Usage: $P [OPTION]... [FILE]...
38Version: $V
39
40Options:
41  -q, --quiet                quiet
42  --no-tree                  run without a kernel tree
43  --no-signoff               do not check for 'Signed-off-by' line
44  --patch                    treat FILE as patchfile (default)
45  --emacs                    emacs compile window format
46  --terse                    one line per report
47  -f, --file                 treat FILE as regular source file
48  --strict                   fail if only warnings are found
49  --root=PATH                PATH to the kernel tree root
50  --no-summary               suppress the per-file summary
51  --mailback                 only produce a report in case of warnings/errors
52  --summary-file             include the filename in summary
53  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
54                             'values', 'possible', 'type', and 'attr' (default
55                             is all off)
56  --test-only=WORD           report only warnings/errors containing WORD
57                             literally
58  -h, --help, --version      display this help and exit
59
60When FILE is - read standard input.
61EOM
62
63	exit($exitcode);
64}
65
66GetOptions(
67	'q|quiet+'	=> \$quiet,
68	'tree!'		=> \$tree,
69	'signoff!'	=> \$chk_signoff,
70	'patch!'	=> \$chk_patch,
71	'emacs!'	=> \$emacs,
72	'terse!'	=> \$terse,
73	'f|file!'	=> \$file,
74	'strict!'	=> \$no_warnings,
75	'root=s'	=> \$root,
76	'summary!'	=> \$summary,
77	'mailback!'	=> \$mailback,
78	'summary-file!'	=> \$summary_file,
79
80	'debug=s'	=> \%debug,
81	'test-only=s'	=> \$tst_only,
82	'h|help'	=> \$help,
83	'version'	=> \$help
84) or help(1);
85
86help(0) if ($help);
87
88my $exit = 0;
89
90if ($#ARGV < 0) {
91	print "$P: no input files\n";
92	exit(1);
93}
94
95my $dbg_values = 0;
96my $dbg_possible = 0;
97my $dbg_type = 0;
98my $dbg_attr = 0;
99my $dbg_adv_dcs = 0;
100my $dbg_adv_checking = 0;
101my $dbg_adv_apw = 0;
102for my $key (keys %debug) {
103	## no critic
104	eval "\${dbg_$key} = '$debug{$key}';";
105	die "$@" if ($@);
106}
107
108my $rpt_cleaners = 0;
109
110if ($terse) {
111	$emacs = 1;
112	$quiet++;
113}
114
115if ($tree) {
116	if (defined $root) {
117		if (!top_of_kernel_tree($root)) {
118			die "$P: $root: --root does not point at a valid tree\n";
119		}
120	} else {
121		if (top_of_kernel_tree('.')) {
122			$root = '.';
123		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
124						top_of_kernel_tree($1)) {
125			$root = $1;
126		}
127	}
128
129	if (!defined $root) {
130		print "Must be run from the top-level dir. of a kernel tree\n";
131		exit(2);
132	}
133}
134
135my $emitted_corrupt = 0;
136
137our $Ident	= qr{
138			[A-Za-z_][A-Za-z\d_]*
139			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
140		}x;
141our $Storage	= qr{extern|static|asmlinkage};
142our $Sparse	= qr{
143			__force
144		}x;
145
146# Notes to $Attribute:
147our $Attribute	= qr{
148			const|
149			volatile|
150			QEMU_NORETURN|
151			QEMU_WARN_UNUSED_RESULT|
152			QEMU_SENTINEL|
153			QEMU_ARTIFICIAL|
154			QEMU_PACKED|
155			GCC_FMT_ATTR
156		  }x;
157our $Modifier;
158our $Inline	= qr{inline};
159our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
160our $Lval	= qr{$Ident(?:$Member)*};
161
162our $Constant	= qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
163our $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
164our $Compare    = qr{<=|>=|==|!=|<|>};
165our $Operators	= qr{
166			<=|>=|==|!=|
167			=>|->|<<|>>|<|>|!|~|
168			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
169		  }x;
170
171our $NonptrType;
172our $Type;
173our $Declare;
174
175our $UTF8	= qr {
176	[\x09\x0A\x0D\x20-\x7E]              # ASCII
177	| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
178	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
179	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
180	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
181	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
182	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
183	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
184}x;
185
186# There are still some false positives, but this catches most
187# common cases.
188our $typeTypedefs = qr{(?x:
189        [A-Z][A-Z\d_]*[a-z][A-Za-z\d_]*     # camelcase
190        | [A-Z][A-Z\d_]*AIOCB               # all uppercase
191        | [A-Z][A-Z\d_]*CPU                 # all uppercase
192        | QEMUBH                            # all uppercase
193)};
194
195our @typeList = (
196	qr{void},
197	qr{(?:unsigned\s+)?char},
198	qr{(?:unsigned\s+)?short},
199	qr{(?:unsigned\s+)?int},
200	qr{(?:unsigned\s+)?long},
201	qr{(?:unsigned\s+)?long\s+int},
202	qr{(?:unsigned\s+)?long\s+long},
203	qr{(?:unsigned\s+)?long\s+long\s+int},
204	qr{unsigned},
205	qr{float},
206	qr{double},
207	qr{bool},
208	qr{struct\s+$Ident},
209	qr{union\s+$Ident},
210	qr{enum\s+$Ident},
211	qr{${Ident}_t},
212	qr{${Ident}_handler},
213	qr{${Ident}_handler_fn},
214	qr{target_(?:u)?long},
215);
216
217# This can be modified by sub possible.  Since it can be empty, be careful
218# about regexes that always match, because they can cause infinite loops.
219our @modifierList = (
220);
221
222sub build_types {
223	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
224	if (@modifierList > 0) {
225		my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
226		$Modifier = qr{(?:$Attribute|$Sparse|$mods)};
227	} else {
228		$Modifier = qr{(?:$Attribute|$Sparse)};
229	}
230	$NonptrType	= qr{
231			(?:$Modifier\s+|const\s+)*
232			(?:
233				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
234				(?:$typeTypedefs\b)|
235				(?:${all}\b)
236			)
237			(?:\s+$Modifier|\s+const)*
238		  }x;
239	$Type	= qr{
240			$NonptrType
241			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
242			(?:\s+$Inline|\s+$Modifier)*
243		  }x;
244	$Declare	= qr{(?:$Storage\s+)?$Type};
245}
246build_types();
247
248$chk_signoff = 0 if ($file);
249
250my @rawlines = ();
251my @lines = ();
252my $vname;
253for my $filename (@ARGV) {
254	my $FILE;
255	if ($file) {
256		open($FILE, '-|', "diff -u /dev/null $filename") ||
257			die "$P: $filename: diff failed - $!\n";
258	} elsif ($filename eq '-') {
259		open($FILE, '<&STDIN');
260	} else {
261		open($FILE, '<', "$filename") ||
262			die "$P: $filename: open failed - $!\n";
263	}
264	if ($filename eq '-') {
265		$vname = 'Your patch';
266	} else {
267		$vname = $filename;
268	}
269	while (<$FILE>) {
270		chomp;
271		push(@rawlines, $_);
272	}
273	close($FILE);
274	if (!process($filename)) {
275		$exit = 1;
276	}
277	@rawlines = ();
278	@lines = ();
279}
280
281exit($exit);
282
283sub top_of_kernel_tree {
284	my ($root) = @_;
285
286	my @tree_check = (
287		"COPYING", "MAINTAINERS", "Makefile",
288		"README", "docs", "VERSION",
289		"vl.c"
290	);
291
292	foreach my $check (@tree_check) {
293		if (! -e $root . '/' . $check) {
294			return 0;
295		}
296	}
297	return 1;
298}
299
300sub expand_tabs {
301	my ($str) = @_;
302
303	my $res = '';
304	my $n = 0;
305	for my $c (split(//, $str)) {
306		if ($c eq "\t") {
307			$res .= ' ';
308			$n++;
309			for (; ($n % 8) != 0; $n++) {
310				$res .= ' ';
311			}
312			next;
313		}
314		$res .= $c;
315		$n++;
316	}
317
318	return $res;
319}
320sub copy_spacing {
321	(my $res = shift) =~ tr/\t/ /c;
322	return $res;
323}
324
325sub line_stats {
326	my ($line) = @_;
327
328	# Drop the diff line leader and expand tabs
329	$line =~ s/^.//;
330	$line = expand_tabs($line);
331
332	# Pick the indent from the front of the line.
333	my ($white) = ($line =~ /^(\s*)/);
334
335	return (length($line), length($white));
336}
337
338my $sanitise_quote = '';
339
340sub sanitise_line_reset {
341	my ($in_comment) = @_;
342
343	if ($in_comment) {
344		$sanitise_quote = '*/';
345	} else {
346		$sanitise_quote = '';
347	}
348}
349sub sanitise_line {
350	my ($line) = @_;
351
352	my $res = '';
353	my $l = '';
354
355	my $qlen = 0;
356	my $off = 0;
357	my $c;
358
359	# Always copy over the diff marker.
360	$res = substr($line, 0, 1);
361
362	for ($off = 1; $off < length($line); $off++) {
363		$c = substr($line, $off, 1);
364
365		# Comments we are wacking completely including the begin
366		# and end, all to $;.
367		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
368			$sanitise_quote = '*/';
369
370			substr($res, $off, 2, "$;$;");
371			$off++;
372			next;
373		}
374		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
375			$sanitise_quote = '';
376			substr($res, $off, 2, "$;$;");
377			$off++;
378			next;
379		}
380		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
381			$sanitise_quote = '//';
382
383			substr($res, $off, 2, $sanitise_quote);
384			$off++;
385			next;
386		}
387
388		# A \ in a string means ignore the next character.
389		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
390		    $c eq "\\") {
391			substr($res, $off, 2, 'XX');
392			$off++;
393			next;
394		}
395		# Regular quotes.
396		if ($c eq "'" || $c eq '"') {
397			if ($sanitise_quote eq '') {
398				$sanitise_quote = $c;
399
400				substr($res, $off, 1, $c);
401				next;
402			} elsif ($sanitise_quote eq $c) {
403				$sanitise_quote = '';
404			}
405		}
406
407		#print "c<$c> SQ<$sanitise_quote>\n";
408		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
409			substr($res, $off, 1, $;);
410		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
411			substr($res, $off, 1, $;);
412		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
413			substr($res, $off, 1, 'X');
414		} else {
415			substr($res, $off, 1, $c);
416		}
417	}
418
419	if ($sanitise_quote eq '//') {
420		$sanitise_quote = '';
421	}
422
423	# The pathname on a #include may be surrounded by '<' and '>'.
424	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
425		my $clean = 'X' x length($1);
426		$res =~ s@\<.*\>@<$clean>@;
427
428	# The whole of a #error is a string.
429	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
430		my $clean = 'X' x length($1);
431		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
432	}
433
434	return $res;
435}
436
437sub ctx_statement_block {
438	my ($linenr, $remain, $off) = @_;
439	my $line = $linenr - 1;
440	my $blk = '';
441	my $soff = $off;
442	my $coff = $off - 1;
443	my $coff_set = 0;
444
445	my $loff = 0;
446
447	my $type = '';
448	my $level = 0;
449	my @stack = ();
450	my $p;
451	my $c;
452	my $len = 0;
453
454	my $remainder;
455	while (1) {
456		@stack = (['', 0]) if ($#stack == -1);
457
458		#warn "CSB: blk<$blk> remain<$remain>\n";
459		# If we are about to drop off the end, pull in more
460		# context.
461		if ($off >= $len) {
462			for (; $remain > 0; $line++) {
463				last if (!defined $lines[$line]);
464				next if ($lines[$line] =~ /^-/);
465				$remain--;
466				$loff = $len;
467				$blk .= $lines[$line] . "\n";
468				$len = length($blk);
469				$line++;
470				last;
471			}
472			# Bail if there is no further context.
473			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
474			if ($off >= $len) {
475				last;
476			}
477		}
478		$p = $c;
479		$c = substr($blk, $off, 1);
480		$remainder = substr($blk, $off);
481
482		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
483
484		# Handle nested #if/#else.
485		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
486			push(@stack, [ $type, $level ]);
487		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
488			($type, $level) = @{$stack[$#stack - 1]};
489		} elsif ($remainder =~ /^#\s*endif\b/) {
490			($type, $level) = @{pop(@stack)};
491		}
492
493		# Statement ends at the ';' or a close '}' at the
494		# outermost level.
495		if ($level == 0 && $c eq ';') {
496			last;
497		}
498
499		# An else is really a conditional as long as its not else if
500		if ($level == 0 && $coff_set == 0 &&
501				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
502				$remainder =~ /^(else)(?:\s|{)/ &&
503				$remainder !~ /^else\s+if\b/) {
504			$coff = $off + length($1) - 1;
505			$coff_set = 1;
506			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
507			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
508		}
509
510		if (($type eq '' || $type eq '(') && $c eq '(') {
511			$level++;
512			$type = '(';
513		}
514		if ($type eq '(' && $c eq ')') {
515			$level--;
516			$type = ($level != 0)? '(' : '';
517
518			if ($level == 0 && $coff < $soff) {
519				$coff = $off;
520				$coff_set = 1;
521				#warn "CSB: mark coff<$coff>\n";
522			}
523		}
524		if (($type eq '' || $type eq '{') && $c eq '{') {
525			$level++;
526			$type = '{';
527		}
528		if ($type eq '{' && $c eq '}') {
529			$level--;
530			$type = ($level != 0)? '{' : '';
531
532			if ($level == 0) {
533				if (substr($blk, $off + 1, 1) eq ';') {
534					$off++;
535				}
536				last;
537			}
538		}
539		$off++;
540	}
541	# We are truly at the end, so shuffle to the next line.
542	if ($off == $len) {
543		$loff = $len + 1;
544		$line++;
545		$remain--;
546	}
547
548	my $statement = substr($blk, $soff, $off - $soff + 1);
549	my $condition = substr($blk, $soff, $coff - $soff + 1);
550
551	#warn "STATEMENT<$statement>\n";
552	#warn "CONDITION<$condition>\n";
553
554	#print "coff<$coff> soff<$off> loff<$loff>\n";
555
556	return ($statement, $condition,
557			$line, $remain + 1, $off - $loff + 1, $level);
558}
559
560sub statement_lines {
561	my ($stmt) = @_;
562
563	# Strip the diff line prefixes and rip blank lines at start and end.
564	$stmt =~ s/(^|\n)./$1/g;
565	$stmt =~ s/^\s*//;
566	$stmt =~ s/\s*$//;
567
568	my @stmt_lines = ($stmt =~ /\n/g);
569
570	return $#stmt_lines + 2;
571}
572
573sub statement_rawlines {
574	my ($stmt) = @_;
575
576	my @stmt_lines = ($stmt =~ /\n/g);
577
578	return $#stmt_lines + 2;
579}
580
581sub statement_block_size {
582	my ($stmt) = @_;
583
584	$stmt =~ s/(^|\n)./$1/g;
585	$stmt =~ s/^\s*\{//;
586	$stmt =~ s/}\s*$//;
587	$stmt =~ s/^\s*//;
588	$stmt =~ s/\s*$//;
589
590	my @stmt_lines = ($stmt =~ /\n/g);
591	my @stmt_statements = ($stmt =~ /;/g);
592
593	my $stmt_lines = $#stmt_lines + 2;
594	my $stmt_statements = $#stmt_statements + 1;
595
596	if ($stmt_lines > $stmt_statements) {
597		return $stmt_lines;
598	} else {
599		return $stmt_statements;
600	}
601}
602
603sub ctx_statement_full {
604	my ($linenr, $remain, $off) = @_;
605	my ($statement, $condition, $level);
606
607	my (@chunks);
608
609	# Grab the first conditional/block pair.
610	($statement, $condition, $linenr, $remain, $off, $level) =
611				ctx_statement_block($linenr, $remain, $off);
612	#print "F: c<$condition> s<$statement> remain<$remain>\n";
613	push(@chunks, [ $condition, $statement ]);
614	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
615		return ($level, $linenr, @chunks);
616	}
617
618	# Pull in the following conditional/block pairs and see if they
619	# could continue the statement.
620	for (;;) {
621		($statement, $condition, $linenr, $remain, $off, $level) =
622				ctx_statement_block($linenr, $remain, $off);
623		#print "C: c<$condition> s<$statement> remain<$remain>\n";
624		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
625		#print "C: push\n";
626		push(@chunks, [ $condition, $statement ]);
627	}
628
629	return ($level, $linenr, @chunks);
630}
631
632sub ctx_block_get {
633	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
634	my $line;
635	my $start = $linenr - 1;
636	my $blk = '';
637	my @o;
638	my @c;
639	my @res = ();
640
641	my $level = 0;
642	my @stack = ($level);
643	for ($line = $start; $remain > 0; $line++) {
644		next if ($rawlines[$line] =~ /^-/);
645		$remain--;
646
647		$blk .= $rawlines[$line];
648
649		# Handle nested #if/#else.
650		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
651			push(@stack, $level);
652		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
653			$level = $stack[$#stack - 1];
654		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
655			$level = pop(@stack);
656		}
657
658		foreach my $c (split(//, $lines[$line])) {
659			##print "C<$c>L<$level><$open$close>O<$off>\n";
660			if ($off > 0) {
661				$off--;
662				next;
663			}
664
665			if ($c eq $close && $level > 0) {
666				$level--;
667				last if ($level == 0);
668			} elsif ($c eq $open) {
669				$level++;
670			}
671		}
672
673		if (!$outer || $level <= 1) {
674			push(@res, $rawlines[$line]);
675		}
676
677		last if ($level == 0);
678	}
679
680	return ($level, @res);
681}
682sub ctx_block_outer {
683	my ($linenr, $remain) = @_;
684
685	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
686	return @r;
687}
688sub ctx_block {
689	my ($linenr, $remain) = @_;
690
691	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
692	return @r;
693}
694sub ctx_statement {
695	my ($linenr, $remain, $off) = @_;
696
697	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
698	return @r;
699}
700sub ctx_block_level {
701	my ($linenr, $remain) = @_;
702
703	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
704}
705sub ctx_statement_level {
706	my ($linenr, $remain, $off) = @_;
707
708	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
709}
710
711sub ctx_locate_comment {
712	my ($first_line, $end_line) = @_;
713
714	# Catch a comment on the end of the line itself.
715	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
716	return $current_comment if (defined $current_comment);
717
718	# Look through the context and try and figure out if there is a
719	# comment.
720	my $in_comment = 0;
721	$current_comment = '';
722	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
723		my $line = $rawlines[$linenr - 1];
724		#warn "           $line\n";
725		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
726			$in_comment = 1;
727		}
728		if ($line =~ m@/\*@) {
729			$in_comment = 1;
730		}
731		if (!$in_comment && $current_comment ne '') {
732			$current_comment = '';
733		}
734		$current_comment .= $line . "\n" if ($in_comment);
735		if ($line =~ m@\*/@) {
736			$in_comment = 0;
737		}
738	}
739
740	chomp($current_comment);
741	return($current_comment);
742}
743sub ctx_has_comment {
744	my ($first_line, $end_line) = @_;
745	my $cmt = ctx_locate_comment($first_line, $end_line);
746
747	##print "LINE: $rawlines[$end_line - 1 ]\n";
748	##print "CMMT: $cmt\n";
749
750	return ($cmt ne '');
751}
752
753sub raw_line {
754	my ($linenr, $cnt) = @_;
755
756	my $offset = $linenr - 1;
757	$cnt++;
758
759	my $line;
760	while ($cnt) {
761		$line = $rawlines[$offset++];
762		next if (defined($line) && $line =~ /^-/);
763		$cnt--;
764	}
765
766	return $line;
767}
768
769sub cat_vet {
770	my ($vet) = @_;
771	my ($res, $coded);
772
773	$res = '';
774	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
775		$res .= $1;
776		if ($2 ne '') {
777			$coded = sprintf("^%c", unpack('C', $2) + 64);
778			$res .= $coded;
779		}
780	}
781	$res =~ s/$/\$/;
782
783	return $res;
784}
785
786my $av_preprocessor = 0;
787my $av_pending;
788my @av_paren_type;
789my $av_pend_colon;
790
791sub annotate_reset {
792	$av_preprocessor = 0;
793	$av_pending = '_';
794	@av_paren_type = ('E');
795	$av_pend_colon = 'O';
796}
797
798sub annotate_values {
799	my ($stream, $type) = @_;
800
801	my $res;
802	my $var = '_' x length($stream);
803	my $cur = $stream;
804
805	print "$stream\n" if ($dbg_values > 1);
806
807	while (length($cur)) {
808		@av_paren_type = ('E') if ($#av_paren_type < 0);
809		print " <" . join('', @av_paren_type) .
810				"> <$type> <$av_pending>" if ($dbg_values > 1);
811		if ($cur =~ /^(\s+)/o) {
812			print "WS($1)\n" if ($dbg_values > 1);
813			if ($1 =~ /\n/ && $av_preprocessor) {
814				$type = pop(@av_paren_type);
815				$av_preprocessor = 0;
816			}
817
818		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
819			print "CAST($1)\n" if ($dbg_values > 1);
820			push(@av_paren_type, $type);
821			$type = 'C';
822
823		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
824			print "DECLARE($1)\n" if ($dbg_values > 1);
825			$type = 'T';
826
827		} elsif ($cur =~ /^($Modifier)\s*/) {
828			print "MODIFIER($1)\n" if ($dbg_values > 1);
829			$type = 'T';
830
831		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
832			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
833			$av_preprocessor = 1;
834			push(@av_paren_type, $type);
835			if ($2 ne '') {
836				$av_pending = 'N';
837			}
838			$type = 'E';
839
840		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
841			print "UNDEF($1)\n" if ($dbg_values > 1);
842			$av_preprocessor = 1;
843			push(@av_paren_type, $type);
844
845		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
846			print "PRE_START($1)\n" if ($dbg_values > 1);
847			$av_preprocessor = 1;
848
849			push(@av_paren_type, $type);
850			push(@av_paren_type, $type);
851			$type = 'E';
852
853		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
854			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
855			$av_preprocessor = 1;
856
857			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
858
859			$type = 'E';
860
861		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
862			print "PRE_END($1)\n" if ($dbg_values > 1);
863
864			$av_preprocessor = 1;
865
866			# Assume all arms of the conditional end as this
867			# one does, and continue as if the #endif was not here.
868			pop(@av_paren_type);
869			push(@av_paren_type, $type);
870			$type = 'E';
871
872		} elsif ($cur =~ /^(\\\n)/o) {
873			print "PRECONT($1)\n" if ($dbg_values > 1);
874
875		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
876			print "ATTR($1)\n" if ($dbg_values > 1);
877			$av_pending = $type;
878			$type = 'N';
879
880		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
881			print "SIZEOF($1)\n" if ($dbg_values > 1);
882			if (defined $2) {
883				$av_pending = 'V';
884			}
885			$type = 'N';
886
887		} elsif ($cur =~ /^(if|while|for)\b/o) {
888			print "COND($1)\n" if ($dbg_values > 1);
889			$av_pending = 'E';
890			$type = 'N';
891
892		} elsif ($cur =~/^(case)/o) {
893			print "CASE($1)\n" if ($dbg_values > 1);
894			$av_pend_colon = 'C';
895			$type = 'N';
896
897		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
898			print "KEYWORD($1)\n" if ($dbg_values > 1);
899			$type = 'N';
900
901		} elsif ($cur =~ /^(\()/o) {
902			print "PAREN('$1')\n" if ($dbg_values > 1);
903			push(@av_paren_type, $av_pending);
904			$av_pending = '_';
905			$type = 'N';
906
907		} elsif ($cur =~ /^(\))/o) {
908			my $new_type = pop(@av_paren_type);
909			if ($new_type ne '_') {
910				$type = $new_type;
911				print "PAREN('$1') -> $type\n"
912							if ($dbg_values > 1);
913			} else {
914				print "PAREN('$1')\n" if ($dbg_values > 1);
915			}
916
917		} elsif ($cur =~ /^($Ident)\s*\(/o) {
918			print "FUNC($1)\n" if ($dbg_values > 1);
919			$type = 'V';
920			$av_pending = 'V';
921
922		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
923			if (defined $2 && $type eq 'C' || $type eq 'T') {
924				$av_pend_colon = 'B';
925			} elsif ($type eq 'E') {
926				$av_pend_colon = 'L';
927			}
928			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
929			$type = 'V';
930
931		} elsif ($cur =~ /^($Ident|$Constant)/o) {
932			print "IDENT($1)\n" if ($dbg_values > 1);
933			$type = 'V';
934
935		} elsif ($cur =~ /^($Assignment)/o) {
936			print "ASSIGN($1)\n" if ($dbg_values > 1);
937			$type = 'N';
938
939		} elsif ($cur =~/^(;|{|})/) {
940			print "END($1)\n" if ($dbg_values > 1);
941			$type = 'E';
942			$av_pend_colon = 'O';
943
944		} elsif ($cur =~/^(,)/) {
945			print "COMMA($1)\n" if ($dbg_values > 1);
946			$type = 'C';
947
948		} elsif ($cur =~ /^(\?)/o) {
949			print "QUESTION($1)\n" if ($dbg_values > 1);
950			$type = 'N';
951
952		} elsif ($cur =~ /^(:)/o) {
953			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
954
955			substr($var, length($res), 1, $av_pend_colon);
956			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
957				$type = 'E';
958			} else {
959				$type = 'N';
960			}
961			$av_pend_colon = 'O';
962
963		} elsif ($cur =~ /^(\[)/o) {
964			print "CLOSE($1)\n" if ($dbg_values > 1);
965			$type = 'N';
966
967		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
968			my $variant;
969
970			print "OPV($1)\n" if ($dbg_values > 1);
971			if ($type eq 'V') {
972				$variant = 'B';
973			} else {
974				$variant = 'U';
975			}
976
977			substr($var, length($res), 1, $variant);
978			$type = 'N';
979
980		} elsif ($cur =~ /^($Operators)/o) {
981			print "OP($1)\n" if ($dbg_values > 1);
982			if ($1 ne '++' && $1 ne '--') {
983				$type = 'N';
984			}
985
986		} elsif ($cur =~ /(^.)/o) {
987			print "C($1)\n" if ($dbg_values > 1);
988		}
989		if (defined $1) {
990			$cur = substr($cur, length($1));
991			$res .= $type x length($1);
992		}
993	}
994
995	return ($res, $var);
996}
997
998sub possible {
999	my ($possible, $line) = @_;
1000	my $notPermitted = qr{(?:
1001		^(?:
1002			$Modifier|
1003			$Storage|
1004			$Type|
1005			DEFINE_\S+
1006		)$|
1007		^(?:
1008			goto|
1009			return|
1010			case|
1011			else|
1012			asm|__asm__|
1013			do|
1014			\#|
1015			\#\#
1016		)(?:\s|$)|
1017		^(?:typedef|struct|enum)\b
1018	    )}x;
1019	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1020	if ($possible !~ $notPermitted) {
1021		# Check for modifiers.
1022		$possible =~ s/\s*$Storage\s*//g;
1023		$possible =~ s/\s*$Sparse\s*//g;
1024		if ($possible =~ /^\s*$/) {
1025
1026		} elsif ($possible =~ /\s/) {
1027			$possible =~ s/\s*$Type\s*//g;
1028			for my $modifier (split(' ', $possible)) {
1029				if ($modifier !~ $notPermitted) {
1030					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1031					push(@modifierList, $modifier);
1032				}
1033			}
1034
1035		} else {
1036			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1037			push(@typeList, $possible);
1038		}
1039		build_types();
1040	} else {
1041		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1042	}
1043}
1044
1045my $prefix = '';
1046
1047sub report {
1048	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1049		return 0;
1050	}
1051	my $line = $prefix . $_[0];
1052
1053	$line = (split('\n', $line))[0] . "\n" if ($terse);
1054
1055	push(our @report, $line);
1056
1057	return 1;
1058}
1059sub report_dump {
1060	our @report;
1061}
1062sub ERROR {
1063	if (report("ERROR: $_[0]\n")) {
1064		our $clean = 0;
1065		our $cnt_error++;
1066	}
1067}
1068sub WARN {
1069	if (report("WARNING: $_[0]\n")) {
1070		our $clean = 0;
1071		our $cnt_warn++;
1072	}
1073}
1074
1075sub process {
1076	my $filename = shift;
1077
1078	my $linenr=0;
1079	my $prevline="";
1080	my $prevrawline="";
1081	my $stashline="";
1082	my $stashrawline="";
1083
1084	my $length;
1085	my $indent;
1086	my $previndent=0;
1087	my $stashindent=0;
1088
1089	our $clean = 1;
1090	my $signoff = 0;
1091	my $is_patch = 0;
1092
1093	our @report = ();
1094	our $cnt_lines = 0;
1095	our $cnt_error = 0;
1096	our $cnt_warn = 0;
1097	our $cnt_chk = 0;
1098
1099	# Trace the real file/line as we go.
1100	my $realfile = '';
1101	my $realline = 0;
1102	my $realcnt = 0;
1103	my $here = '';
1104	my $in_comment = 0;
1105	my $comment_edge = 0;
1106	my $first_line = 0;
1107	my $p1_prefix = '';
1108
1109	my $prev_values = 'E';
1110
1111	# suppression flags
1112	my %suppress_ifbraces;
1113	my %suppress_whiletrailers;
1114	my %suppress_export;
1115
1116	# Pre-scan the patch sanitizing the lines.
1117
1118	sanitise_line_reset();
1119	my $line;
1120	foreach my $rawline (@rawlines) {
1121		$linenr++;
1122		$line = $rawline;
1123
1124		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1125			$realline=$1-1;
1126			if (defined $2) {
1127				$realcnt=$3+1;
1128			} else {
1129				$realcnt=1+1;
1130			}
1131			$in_comment = 0;
1132
1133			# Guestimate if this is a continuing comment.  Run
1134			# the context looking for a comment "edge".  If this
1135			# edge is a close comment then we must be in a comment
1136			# at context start.
1137			my $edge;
1138			my $cnt = $realcnt;
1139			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1140				next if (defined $rawlines[$ln - 1] &&
1141					 $rawlines[$ln - 1] =~ /^-/);
1142				$cnt--;
1143				#print "RAW<$rawlines[$ln - 1]>\n";
1144				last if (!defined $rawlines[$ln - 1]);
1145				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1146				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1147					($edge) = $1;
1148					last;
1149				}
1150			}
1151			if (defined $edge && $edge eq '*/') {
1152				$in_comment = 1;
1153			}
1154
1155			# Guestimate if this is a continuing comment.  If this
1156			# is the start of a diff block and this line starts
1157			# ' *' then it is very likely a comment.
1158			if (!defined $edge &&
1159			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1160			{
1161				$in_comment = 1;
1162			}
1163
1164			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1165			sanitise_line_reset($in_comment);
1166
1167		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1168			# Standardise the strings and chars within the input to
1169			# simplify matching -- only bother with positive lines.
1170			$line = sanitise_line($rawline);
1171		}
1172		push(@lines, $line);
1173
1174		if ($realcnt > 1) {
1175			$realcnt-- if ($line =~ /^(?:\+| |$)/);
1176		} else {
1177			$realcnt = 0;
1178		}
1179
1180		#print "==>$rawline\n";
1181		#print "-->$line\n";
1182	}
1183
1184	$prefix = '';
1185
1186	$realcnt = 0;
1187	$linenr = 0;
1188	foreach my $line (@lines) {
1189		$linenr++;
1190
1191		my $rawline = $rawlines[$linenr - 1];
1192
1193#extract the line range in the file after the patch is applied
1194		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1195			$is_patch = 1;
1196			$first_line = $linenr + 1;
1197			$realline=$1-1;
1198			if (defined $2) {
1199				$realcnt=$3+1;
1200			} else {
1201				$realcnt=1+1;
1202			}
1203			annotate_reset();
1204			$prev_values = 'E';
1205
1206			%suppress_ifbraces = ();
1207			%suppress_whiletrailers = ();
1208			%suppress_export = ();
1209			next;
1210
1211# track the line number as we move through the hunk, note that
1212# new versions of GNU diff omit the leading space on completely
1213# blank context lines so we need to count that too.
1214		} elsif ($line =~ /^( |\+|$)/) {
1215			$realline++;
1216			$realcnt-- if ($realcnt != 0);
1217
1218			# Measure the line length and indent.
1219			($length, $indent) = line_stats($rawline);
1220
1221			# Track the previous line.
1222			($prevline, $stashline) = ($stashline, $line);
1223			($previndent, $stashindent) = ($stashindent, $indent);
1224			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1225
1226			#warn "line<$line>\n";
1227
1228		} elsif ($realcnt == 1) {
1229			$realcnt--;
1230		}
1231
1232		my $hunk_line = ($realcnt != 0);
1233
1234#make up the handle for any error we report on this line
1235		$prefix = "$filename:$realline: " if ($emacs && $file);
1236		$prefix = "$filename:$linenr: " if ($emacs && !$file);
1237
1238		$here = "#$linenr: " if (!$file);
1239		$here = "#$realline: " if ($file);
1240
1241		# extract the filename as it passes
1242		if ($line =~ /^diff --git.*?(\S+)$/) {
1243			$realfile = $1;
1244			$realfile =~ s@^([^/]*)/@@;
1245
1246		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1247			$realfile = $1;
1248			$realfile =~ s@^([^/]*)/@@;
1249
1250			$p1_prefix = $1;
1251			if (!$file && $tree && $p1_prefix ne '' &&
1252			    -e "$root/$p1_prefix") {
1253				WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1254			}
1255
1256			next;
1257		}
1258
1259		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1260
1261		my $hereline = "$here\n$rawline\n";
1262		my $herecurr = "$here\n$rawline\n";
1263		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1264
1265		$cnt_lines++ if ($realcnt != 0);
1266
1267# Check for incorrect file permissions
1268		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1269			my $permhere = $here . "FILE: $realfile\n";
1270			if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) {
1271				ERROR("do not set execute permissions for source files\n" . $permhere);
1272			}
1273		}
1274
1275# Accept git diff extended headers as valid patches
1276		if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\.\-]+\s*$/) {
1277			$is_patch = 1;
1278		}
1279
1280#check the patch for a signoff:
1281		if ($line =~ /^\s*signed-off-by:/i) {
1282			# This is a signoff, if ugly, so do not double report.
1283			$signoff++;
1284			if (!($line =~ /^\s*Signed-off-by:/)) {
1285				ERROR("The correct form is \"Signed-off-by\"\n" .
1286					$herecurr);
1287			}
1288			if ($line =~ /^\s*signed-off-by:\S/i) {
1289				ERROR("space required after Signed-off-by:\n" .
1290					$herecurr);
1291			}
1292		}
1293
1294# Check for wrappage within a valid hunk of the file
1295		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1296			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1297				$herecurr) if (!$emitted_corrupt++);
1298		}
1299
1300# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1301		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1302		    $rawline !~ m/^$UTF8*$/) {
1303			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1304
1305			my $blank = copy_spacing($rawline);
1306			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1307			my $hereptr = "$hereline$ptr\n";
1308
1309			ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1310		}
1311
1312# ignore non-hunk lines and lines being removed
1313		next if (!$hunk_line || $line =~ /^-/);
1314
1315# ignore files that are being periodically imported from Linux
1316		next if ($realfile =~ /^(linux-headers|include\/standard-headers)\//);
1317
1318#trailing whitespace
1319		if ($line =~ /^\+.*\015/) {
1320			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1321			ERROR("DOS line endings\n" . $herevet);
1322
1323		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1324			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1325			ERROR("trailing whitespace\n" . $herevet);
1326			$rpt_cleaners = 1;
1327		}
1328
1329# check we are in a valid source file if not then ignore this hunk
1330		next if ($realfile !~ /\.(h|c|cpp|s|S|pl|py|sh)$/);
1331
1332#90 column limit
1333		if ($line =~ /^\+/ &&
1334		    !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1335		    $length > 80)
1336		{
1337			if ($length > 90) {
1338				ERROR("line over 90 characters\n" . $herecurr);
1339			} else {
1340				WARN("line over 80 characters\n" . $herecurr);
1341			}
1342		}
1343
1344# check for spaces before a quoted newline
1345		if ($rawline =~ /^.*\".*\s\\n/) {
1346			ERROR("unnecessary whitespace before a quoted newline\n" . $herecurr);
1347		}
1348
1349# check for adding lines without a newline.
1350		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1351			ERROR("adding a line without newline at end of file\n" . $herecurr);
1352		}
1353
1354# check for RCS/CVS revision markers
1355		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|\b)/) {
1356			ERROR("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1357		}
1358
1359# tabs are only allowed in assembly source code, and in
1360# some scripts we imported from other projects.
1361		next if ($realfile =~ /\.(s|S)$/);
1362		next if ($realfile =~ /(checkpatch|get_maintainer|texi2pod)\.pl$/);
1363
1364		if ($rawline =~ /^\+.*\t/) {
1365			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1366			ERROR("code indent should never use tabs\n" . $herevet);
1367			$rpt_cleaners = 1;
1368		}
1369
1370# check we are in a valid C source file if not then ignore this hunk
1371		next if ($realfile !~ /\.(h|c|cpp)$/);
1372
1373# Check for potential 'bare' types
1374		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1375		    $realline_next);
1376		if ($realcnt && $line =~ /.\s*\S/) {
1377			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1378				ctx_statement_block($linenr, $realcnt, 0);
1379			$stat =~ s/\n./\n /g;
1380			$cond =~ s/\n./\n /g;
1381
1382			# Find the real next line.
1383			$realline_next = $line_nr_next;
1384			if (defined $realline_next &&
1385			    (!defined $lines[$realline_next - 1] ||
1386			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1387				$realline_next++;
1388			}
1389
1390			my $s = $stat;
1391			$s =~ s/{.*$//s;
1392
1393			# Ignore goto labels.
1394			if ($s =~ /$Ident:\*$/s) {
1395
1396			# Ignore functions being called
1397			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1398
1399			} elsif ($s =~ /^.\s*else\b/s) {
1400
1401			# declarations always start with types
1402			} 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) {
1403				my $type = $1;
1404				$type =~ s/\s+/ /g;
1405				possible($type, "A:" . $s);
1406
1407			# definitions in global scope can only start with types
1408			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1409				possible($1, "B:" . $s);
1410			}
1411
1412			# any (foo ... *) is a pointer cast, and foo is a type
1413			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1414				possible($1, "C:" . $s);
1415			}
1416
1417			# Check for any sort of function declaration.
1418			# int foo(something bar, other baz);
1419			# void (*store_gdt)(x86_descr_ptr *);
1420			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1421				my ($name_len) = length($1);
1422
1423				my $ctx = $s;
1424				substr($ctx, 0, $name_len + 1, '');
1425				$ctx =~ s/\)[^\)]*$//;
1426
1427				for my $arg (split(/\s*,\s*/, $ctx)) {
1428					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1429
1430						possible($1, "D:" . $s);
1431					}
1432				}
1433			}
1434
1435		}
1436
1437#
1438# Checks which may be anchored in the context.
1439#
1440
1441# Check for switch () and associated case and default
1442# statements should be at the same indent.
1443		if ($line=~/\bswitch\s*\(.*\)/) {
1444			my $err = '';
1445			my $sep = '';
1446			my @ctx = ctx_block_outer($linenr, $realcnt);
1447			shift(@ctx);
1448			for my $ctx (@ctx) {
1449				my ($clen, $cindent) = line_stats($ctx);
1450				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1451							$indent != $cindent) {
1452					$err .= "$sep$ctx\n";
1453					$sep = '';
1454				} else {
1455					$sep = "[...]\n";
1456				}
1457			}
1458			if ($err ne '') {
1459				ERROR("switch and case should be at the same indent\n$hereline$err");
1460			}
1461		}
1462
1463# if/while/etc brace do not go on next line, unless defining a do while loop,
1464# or if that brace on the next line is for something else
1465		if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1466			my $pre_ctx = "$1$2";
1467
1468			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1469			my $ctx_cnt = $realcnt - $#ctx - 1;
1470			my $ctx = join("\n", @ctx);
1471
1472			my $ctx_ln = $linenr;
1473			my $ctx_skip = $realcnt;
1474
1475			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1476					defined $lines[$ctx_ln - 1] &&
1477					$lines[$ctx_ln - 1] =~ /^-/)) {
1478				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1479				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1480				$ctx_ln++;
1481			}
1482
1483			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1484			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1485
1486			# The length of the "previous line" is checked against 80 because it
1487			# includes the + at the beginning of the line (if the actual line has
1488			# 79 or 80 characters, it is no longer possible to add a space and an
1489			# opening brace there)
1490			if ($#ctx == 0 && $ctx !~ /{\s*/ &&
1491			    defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ &&
1492			    defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) {
1493				ERROR("that open brace { should be on the previous line\n" .
1494					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1495			}
1496			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1497			    $ctx =~ /\)\s*\;\s*$/ &&
1498			    defined $lines[$ctx_ln - 1])
1499			{
1500				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1501				if ($nindent > $indent) {
1502					ERROR("trailing semicolon indicates no statements, indent implies otherwise\n" .
1503						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1504				}
1505			}
1506		}
1507
1508# Check relative indent for conditionals and blocks.
1509		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1510			my ($s, $c) = ($stat, $cond);
1511
1512			substr($s, 0, length($c), '');
1513
1514			# Make sure we remove the line prefixes as we have
1515			# none on the first line, and are going to readd them
1516			# where necessary.
1517			$s =~ s/\n./\n/gs;
1518
1519			# Find out how long the conditional actually is.
1520			my @newlines = ($c =~ /\n/gs);
1521			my $cond_lines = 1 + $#newlines;
1522
1523			# We want to check the first line inside the block
1524			# starting at the end of the conditional, so remove:
1525			#  1) any blank line termination
1526			#  2) any opening brace { on end of the line
1527			#  3) any do (...) {
1528			my $continuation = 0;
1529			my $check = 0;
1530			$s =~ s/^.*\bdo\b//;
1531			$s =~ s/^\s*\{//;
1532			if ($s =~ s/^\s*\\//) {
1533				$continuation = 1;
1534			}
1535			if ($s =~ s/^\s*?\n//) {
1536				$check = 1;
1537				$cond_lines++;
1538			}
1539
1540			# Also ignore a loop construct at the end of a
1541			# preprocessor statement.
1542			if (($prevline =~ /^.\s*#\s*define\s/ ||
1543			    $prevline =~ /\\\s*$/) && $continuation == 0) {
1544				$check = 0;
1545			}
1546
1547			my $cond_ptr = -1;
1548			$continuation = 0;
1549			while ($cond_ptr != $cond_lines) {
1550				$cond_ptr = $cond_lines;
1551
1552				# If we see an #else/#elif then the code
1553				# is not linear.
1554				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1555					$check = 0;
1556				}
1557
1558				# Ignore:
1559				#  1) blank lines, they should be at 0,
1560				#  2) preprocessor lines, and
1561				#  3) labels.
1562				if ($continuation ||
1563				    $s =~ /^\s*?\n/ ||
1564				    $s =~ /^\s*#\s*?/ ||
1565				    $s =~ /^\s*$Ident\s*:/) {
1566					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1567					if ($s =~ s/^.*?\n//) {
1568						$cond_lines++;
1569					}
1570				}
1571			}
1572
1573			my (undef, $sindent) = line_stats("+" . $s);
1574			my $stat_real = raw_line($linenr, $cond_lines);
1575
1576			# Check if either of these lines are modified, else
1577			# this is not this patch's fault.
1578			if (!defined($stat_real) ||
1579			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1580				$check = 0;
1581			}
1582			if (defined($stat_real) && $cond_lines > 1) {
1583				$stat_real = "[...]\n$stat_real";
1584			}
1585
1586			#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";
1587
1588			if ($check && (($sindent % 4) != 0 ||
1589			    ($sindent <= $indent && $s ne ''))) {
1590				ERROR("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1591			}
1592		}
1593
1594		# Track the 'values' across context and added lines.
1595		my $opline = $line; $opline =~ s/^./ /;
1596		my ($curr_values, $curr_vars) =
1597				annotate_values($opline . "\n", $prev_values);
1598		$curr_values = $prev_values . $curr_values;
1599		if ($dbg_values) {
1600			my $outline = $opline; $outline =~ s/\t/ /g;
1601			print "$linenr > .$outline\n";
1602			print "$linenr > $curr_values\n";
1603			print "$linenr >  $curr_vars\n";
1604		}
1605		$prev_values = substr($curr_values, -1);
1606
1607#ignore lines not being added
1608		if ($line=~/^[^\+]/) {next;}
1609
1610# TEST: allow direct testing of the type matcher.
1611		if ($dbg_type) {
1612			if ($line =~ /^.\s*$Declare\s*$/) {
1613				ERROR("TEST: is type\n" . $herecurr);
1614			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1615				ERROR("TEST: is not type ($1 is)\n". $herecurr);
1616			}
1617			next;
1618		}
1619# TEST: allow direct testing of the attribute matcher.
1620		if ($dbg_attr) {
1621			if ($line =~ /^.\s*$Modifier\s*$/) {
1622				ERROR("TEST: is attr\n" . $herecurr);
1623			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1624				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1625			}
1626			next;
1627		}
1628
1629# check for initialisation to aggregates open brace on the next line
1630		if ($line =~ /^.\s*\{/ &&
1631		    $prevline =~ /(?:^|[^=])=\s*$/) {
1632			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1633		}
1634
1635#
1636# Checks which are anchored on the added line.
1637#
1638
1639# check for malformed paths in #include statements (uses RAW line)
1640		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1641			my $path = $1;
1642			if ($path =~ m{//}) {
1643				ERROR("malformed #include filename\n" .
1644					$herecurr);
1645			}
1646		}
1647
1648# no C99 // comments
1649		if ($line =~ m{//}) {
1650			ERROR("do not use C99 // comments\n" . $herecurr);
1651		}
1652		# Remove C99 comments.
1653		$line =~ s@//.*@@;
1654		$opline =~ s@//.*@@;
1655
1656# check for global initialisers.
1657		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1658			ERROR("do not initialise globals to 0 or NULL\n" .
1659				$herecurr);
1660		}
1661# check for static initialisers.
1662		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1663			ERROR("do not initialise statics to 0 or NULL\n" .
1664				$herecurr);
1665		}
1666
1667# * goes on variable not on type
1668		# (char*[ const])
1669		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1670			my ($from, $to) = ($1, $1);
1671
1672			# Should start with a space.
1673			$to =~ s/^(\S)/ $1/;
1674			# Should not end with a space.
1675			$to =~ s/\s+$//;
1676			# '*'s should not have spaces between.
1677			while ($to =~ s/\*\s+\*/\*\*/) {
1678			}
1679
1680			#print "from<$from> to<$to>\n";
1681			if ($from ne $to) {
1682				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
1683			}
1684		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1685			my ($from, $to, $ident) = ($1, $1, $2);
1686
1687			# Should start with a space.
1688			$to =~ s/^(\S)/ $1/;
1689			# Should not end with a space.
1690			$to =~ s/\s+$//;
1691			# '*'s should not have spaces between.
1692			while ($to =~ s/\*\s+\*/\*\*/) {
1693			}
1694			# Modifiers should have spaces.
1695			$to =~ s/(\b$Modifier$)/$1 /;
1696
1697			#print "from<$from> to<$to> ident<$ident>\n";
1698			if ($from ne $to && $ident !~ /^$Modifier$/) {
1699				ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
1700			}
1701		}
1702
1703# function brace can't be on same line, except for #defines of do while,
1704# or if closed on same line
1705		if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and
1706		    !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
1707			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1708		}
1709
1710# open braces for enum, union and struct go on the same line.
1711		if ($line =~ /^.\s*\{/ &&
1712		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1713			ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1714		}
1715
1716# missing space after union, struct or enum definition
1717		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
1718		    ERROR("missing space after $1 definition\n" . $herecurr);
1719		}
1720
1721# check for spacing round square brackets; allowed:
1722#  1. with a type on the left -- int [] a;
1723#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1724#  3. inside a curly brace -- = { [0...10] = 5 }
1725#  4. after a comma -- [1] = 5, [2] = 6
1726#  5. in a macro definition -- #define abc(x) [x] = y
1727		while ($line =~ /(.*?\s)\[/g) {
1728			my ($where, $prefix) = ($-[1], $1);
1729			if ($prefix !~ /$Type\s+$/ &&
1730			    ($where != 0 || $prefix !~ /^.\s+$/) &&
1731			    $prefix !~ /{\s+$/ &&
1732			    $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ &&
1733			    $prefix !~ /,\s+$/) {
1734				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1735			}
1736		}
1737
1738# check for spaces between functions and their parentheses.
1739		while ($line =~ /($Ident)\s+\(/g) {
1740			my $name = $1;
1741			my $ctx_before = substr($line, 0, $-[1]);
1742			my $ctx = "$ctx_before$name";
1743
1744			# Ignore those directives where spaces _are_ permitted.
1745			if ($name =~ /^(?:
1746				if|for|while|switch|return|case|
1747				volatile|__volatile__|
1748				__attribute__|format|__extension__|
1749				asm|__asm__)$/x)
1750			{
1751
1752			# Ignore 'catch (...)' in C++
1753			} elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) {
1754
1755			# cpp #define statements have non-optional spaces, ie
1756			# if there is a space between the name and the open
1757			# parenthesis it is simply not a parameter group.
1758			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1759
1760			# cpp #elif statement condition may start with a (
1761			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1762
1763			# If this whole things ends with a type its most
1764			# likely a typedef for a function.
1765			} elsif ($ctx =~ /$Type$/) {
1766
1767			} else {
1768				ERROR("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1769			}
1770		}
1771# Check operator spacing.
1772		if (!($line=~/\#\s*include/)) {
1773			my $ops = qr{
1774				<<=|>>=|<=|>=|==|!=|
1775				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1776				=>|->|<<|>>|<|>|=|!|~|
1777				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1778				\?|::|:
1779			}x;
1780			my @elements = split(/($ops|;)/, $opline);
1781			my $off = 0;
1782
1783			my $blank = copy_spacing($opline);
1784
1785			for (my $n = 0; $n < $#elements; $n += 2) {
1786				$off += length($elements[$n]);
1787
1788				# Pick up the preceding and succeeding characters.
1789				my $ca = substr($opline, 0, $off);
1790				my $cc = '';
1791				if (length($opline) >= ($off + length($elements[$n + 1]))) {
1792					$cc = substr($opline, $off + length($elements[$n + 1]));
1793				}
1794				my $cb = "$ca$;$cc";
1795
1796				my $a = '';
1797				$a = 'V' if ($elements[$n] ne '');
1798				$a = 'W' if ($elements[$n] =~ /\s$/);
1799				$a = 'C' if ($elements[$n] =~ /$;$/);
1800				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1801				$a = 'O' if ($elements[$n] eq '');
1802				$a = 'E' if ($ca =~ /^\s*$/);
1803
1804				my $op = $elements[$n + 1];
1805
1806				my $c = '';
1807				if (defined $elements[$n + 2]) {
1808					$c = 'V' if ($elements[$n + 2] ne '');
1809					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1810					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1811					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1812					$c = 'O' if ($elements[$n + 2] eq '');
1813					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1814				} else {
1815					$c = 'E';
1816				}
1817
1818				my $ctx = "${a}x${c}";
1819
1820				my $at = "(ctx:$ctx)";
1821
1822				my $ptr = substr($blank, 0, $off) . "^";
1823				my $hereptr = "$hereline$ptr\n";
1824
1825				# Pull out the value of this operator.
1826				my $op_type = substr($curr_values, $off + 1, 1);
1827
1828				# Get the full operator variant.
1829				my $opv = $op . substr($curr_vars, $off, 1);
1830
1831				# Ignore operators passed as parameters.
1832				if ($op_type ne 'V' &&
1833				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1834
1835#				# Ignore comments
1836#				} elsif ($op =~ /^$;+$/) {
1837
1838				# ; should have either the end of line or a space or \ after it
1839				} elsif ($op eq ';') {
1840					if ($ctx !~ /.x[WEBC]/ &&
1841					    $cc !~ /^\\/ && $cc !~ /^;/) {
1842						ERROR("space required after that '$op' $at\n" . $hereptr);
1843					}
1844
1845				# // is a comment
1846				} elsif ($op eq '//') {
1847
1848				# Ignore : used in class declaration in C++
1849				} elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ &&
1850						 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) {
1851
1852				# No spaces for:
1853				#   ->
1854				#   :   when part of a bitfield
1855				} elsif ($op eq '->' || $opv eq ':B') {
1856					if ($ctx =~ /Wx.|.xW/) {
1857						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1858					}
1859
1860				# , must have a space on the right.
1861                                # not required when having a single },{ on one line
1862				} elsif ($op eq ',') {
1863					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
1864                                            ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") {
1865						ERROR("space required after that '$op' $at\n" . $hereptr);
1866					}
1867
1868				# '*' as part of a type definition -- reported already.
1869				} elsif ($opv eq '*_') {
1870					#warn "'*' is part of type\n";
1871
1872				# unary operators should have a space before and
1873				# none after.  May be left adjacent to another
1874				# unary operator, or a cast
1875				} elsif ($op eq '!' || $op eq '~' ||
1876					 $opv eq '*U' || $opv eq '-U' ||
1877					 $opv eq '&U' || $opv eq '&&U') {
1878					if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) {
1879						# '~' used as a name of Destructor
1880
1881					} elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1882						ERROR("space required before that '$op' $at\n" . $hereptr);
1883					}
1884					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
1885						# A unary '*' may be const
1886
1887					} elsif ($ctx =~ /.xW/) {
1888						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1889					}
1890
1891				# unary ++ and unary -- are allowed no space on one side.
1892				} elsif ($op eq '++' or $op eq '--') {
1893					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1894						ERROR("space required one side of that '$op' $at\n" . $hereptr);
1895					}
1896					if ($ctx =~ /Wx[BE]/ ||
1897					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1898						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1899					}
1900					if ($ctx =~ /ExW/) {
1901						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1902					}
1903
1904				# A colon needs no spaces before when it is
1905				# terminating a case value or a label.
1906				} elsif ($opv eq ':C' || $opv eq ':L') {
1907					if ($ctx =~ /Wx./) {
1908						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1909					}
1910
1911				# All the others need spaces both sides.
1912				} elsif ($ctx !~ /[EWC]x[CWE]/) {
1913					my $ok = 0;
1914
1915					if ($realfile =~ /\.cpp|\.h$/) {
1916						# Ignore template arguments <...> in C++
1917						if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) {
1918							$ok = 1;
1919						}
1920
1921						# Ignore :: in C++
1922						if ($op eq '::') {
1923							$ok = 1;
1924						}
1925					}
1926
1927					# Ignore email addresses <foo@bar>
1928					if (($op eq '<' &&
1929					     $cc =~ /^\S+\@\S+>/) ||
1930					    ($op eq '>' &&
1931					     $ca =~ /<\S+\@\S+$/))
1932					{
1933						$ok = 1;
1934					}
1935
1936					# Ignore ?:
1937					if (($opv eq ':O' && $ca =~ /\?$/) ||
1938					    ($op eq '?' && $cc =~ /^:/)) {
1939						$ok = 1;
1940					}
1941
1942					if ($ok == 0) {
1943						ERROR("spaces required around that '$op' $at\n" . $hereptr);
1944					}
1945				}
1946				$off += length($elements[$n + 1]);
1947			}
1948		}
1949
1950#need space before brace following if, while, etc
1951		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
1952		    $line =~ /do\{/) {
1953			ERROR("space required before the open brace '{'\n" . $herecurr);
1954		}
1955
1956# closing brace should have a space following it when it has anything
1957# on the line
1958		if ($line =~ /}(?!(?:,|;|\)))\S/) {
1959			ERROR("space required after that close brace '}'\n" . $herecurr);
1960		}
1961
1962# check spacing on square brackets
1963		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1964			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1965		}
1966		if ($line =~ /\s\]/) {
1967			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1968		}
1969
1970# check spacing on parentheses
1971		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1972		    $line !~ /for\s*\(\s+;/) {
1973			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1974		}
1975		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1976		    $line !~ /for\s*\(.*;\s+\)/ &&
1977		    $line !~ /:\s+\)/) {
1978			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1979		}
1980
1981# Return is not a function.
1982		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1983			my $spacing = $1;
1984			my $value = $2;
1985
1986			# Flatten any parentheses
1987			$value =~ s/\(/ \(/g;
1988			$value =~ s/\)/\) /g;
1989			while ($value =~ s/\[[^\{\}]*\]/1/ ||
1990			       $value !~ /(?:$Ident|-?$Constant)\s*
1991					     $Compare\s*
1992					     (?:$Ident|-?$Constant)/x &&
1993			       $value =~ s/\([^\(\)]*\)/1/) {
1994			}
1995#print "value<$value>\n";
1996			if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
1997				ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1998
1999			} elsif ($spacing !~ /\s+/) {
2000				ERROR("space required before the open parenthesis '('\n" . $herecurr);
2001			}
2002		}
2003# Return of what appears to be an errno should normally be -'ve
2004		if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2005			my $name = $1;
2006			if ($name ne 'EOF' && $name ne 'ERROR') {
2007				ERROR("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2008			}
2009		}
2010
2011# Need a space before open parenthesis after if, while etc
2012		if ($line=~/\b(if|while|for|switch)\(/) {
2013			ERROR("space required before the open parenthesis '('\n" . $herecurr);
2014		}
2015
2016# Check for illegal assignment in if conditional -- and check for trailing
2017# statements after the conditional.
2018		if ($line =~ /do\s*(?!{)/) {
2019			my ($stat_next) = ctx_statement_block($line_nr_next,
2020						$remain_next, $off_next);
2021			$stat_next =~ s/\n./\n /g;
2022			##print "stat<$stat> stat_next<$stat_next>\n";
2023
2024			if ($stat_next =~ /^\s*while\b/) {
2025				# If the statement carries leading newlines,
2026				# then count those as offsets.
2027				my ($whitespace) =
2028					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2029				my $offset =
2030					statement_rawlines($whitespace) - 1;
2031
2032				$suppress_whiletrailers{$line_nr_next +
2033								$offset} = 1;
2034			}
2035		}
2036		if (!defined $suppress_whiletrailers{$linenr} &&
2037		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2038			my ($s, $c) = ($stat, $cond);
2039
2040			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2041				ERROR("do not use assignment in if condition\n" . $herecurr);
2042			}
2043
2044			# Find out what is on the end of the line after the
2045			# conditional.
2046			substr($s, 0, length($c), '');
2047			$s =~ s/\n.*//g;
2048			$s =~ s/$;//g; 	# Remove any comments
2049			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2050			    $c !~ /}\s*while\s*/)
2051			{
2052				# Find out how long the conditional actually is.
2053				my @newlines = ($c =~ /\n/gs);
2054				my $cond_lines = 1 + $#newlines;
2055				my $stat_real = '';
2056
2057				$stat_real = raw_line($linenr, $cond_lines)
2058							. "\n" if ($cond_lines);
2059				if (defined($stat_real) && $cond_lines > 1) {
2060					$stat_real = "[...]\n$stat_real";
2061				}
2062
2063				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2064			}
2065		}
2066
2067# Check for bitwise tests written as boolean
2068		if ($line =~ /
2069			(?:
2070				(?:\[|\(|\&\&|\|\|)
2071				\s*0[xX][0-9]+\s*
2072				(?:\&\&|\|\|)
2073			|
2074				(?:\&\&|\|\|)
2075				\s*0[xX][0-9]+\s*
2076				(?:\&\&|\|\||\)|\])
2077			)/x)
2078		{
2079			ERROR("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2080		}
2081
2082# if and else should not have general statements after it
2083		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2084			my $s = $1;
2085			$s =~ s/$;//g; 	# Remove any comments
2086			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2087				ERROR("trailing statements should be on next line\n" . $herecurr);
2088			}
2089		}
2090# if should not continue a brace
2091		if ($line =~ /}\s*if\b/) {
2092			ERROR("trailing statements should be on next line\n" .
2093				$herecurr);
2094		}
2095# case and default should not have general statements after them
2096		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2097		    $line !~ /\G(?:
2098			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2099			\s*return\s+
2100		    )/xg)
2101		{
2102			ERROR("trailing statements should be on next line\n" . $herecurr);
2103		}
2104
2105		# Check for }<nl>else {, these must be at the same
2106		# indent level to be relevant to each other.
2107		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2108						$previndent == $indent) {
2109			ERROR("else should follow close brace '}'\n" . $hereprev);
2110		}
2111
2112		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2113						$previndent == $indent) {
2114			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2115
2116			# Find out what is on the end of the line after the
2117			# conditional.
2118			substr($s, 0, length($c), '');
2119			$s =~ s/\n.*//g;
2120
2121			if ($s =~ /^\s*;/) {
2122				ERROR("while should follow close brace '}'\n" . $hereprev);
2123			}
2124		}
2125
2126#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2127#		if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2128#		    print "No studly caps, use _\n";
2129#		    print "$herecurr";
2130#		    $clean = 0;
2131#		}
2132
2133#no spaces allowed after \ in define
2134		if ($line=~/\#\s*define.*\\\s$/) {
2135			ERROR("Whitespace after \\ makes next lines useless\n" . $herecurr);
2136		}
2137
2138# multi-statement macros should be enclosed in a do while loop, grab the
2139# first statement and ensure its the whole macro if its not enclosed
2140# in a known good container
2141		if ($realfile !~ m@/vmlinux.lds.h$@ &&
2142		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2143			my $ln = $linenr;
2144			my $cnt = $realcnt;
2145			my ($off, $dstat, $dcond, $rest);
2146			my $ctx = '';
2147
2148			my $args = defined($1);
2149
2150			# Find the end of the macro and limit our statement
2151			# search to that.
2152			while ($cnt > 0 && defined $lines[$ln - 1] &&
2153				$lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2154			{
2155				$ctx .= $rawlines[$ln - 1] . "\n";
2156				$cnt-- if ($lines[$ln - 1] !~ /^-/);
2157				$ln++;
2158			}
2159			$ctx .= $rawlines[$ln - 1];
2160
2161			($dstat, $dcond, $ln, $cnt, $off) =
2162				ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2163			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2164			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2165
2166			# Extract the remainder of the define (if any) and
2167			# rip off surrounding spaces, and trailing \'s.
2168			$rest = '';
2169			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2170				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2171				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2172					$rest .= substr($lines[$ln - 1], $off) . "\n";
2173					$cnt--;
2174				}
2175				$ln++;
2176				$off = 0;
2177			}
2178			$rest =~ s/\\\n.//g;
2179			$rest =~ s/^\s*//s;
2180			$rest =~ s/\s*$//s;
2181
2182			# Clean up the original statement.
2183			if ($args) {
2184				substr($dstat, 0, length($dcond), '');
2185			} else {
2186				$dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2187			}
2188			$dstat =~ s/$;//g;
2189			$dstat =~ s/\\\n.//g;
2190			$dstat =~ s/^\s*//s;
2191			$dstat =~ s/\s*$//s;
2192
2193			# Flatten any parentheses and braces
2194			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2195			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
2196			       $dstat =~ s/\[[^\{\}]*\]/1/)
2197			{
2198			}
2199
2200			my $exceptions = qr{
2201				$Declare|
2202				module_param_named|
2203				MODULE_PARAM_DESC|
2204				DECLARE_PER_CPU|
2205				DEFINE_PER_CPU|
2206				__typeof__\(|
2207				union|
2208				struct|
2209				\.$Ident\s*=\s*|
2210				^\"|\"$
2211			}x;
2212			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2213			if ($rest ne '' && $rest ne ',') {
2214				if ($rest !~ /while\s*\(/ &&
2215				    $dstat !~ /$exceptions/)
2216				{
2217					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2218				}
2219
2220			} elsif ($ctx !~ /;/) {
2221				if ($dstat ne '' &&
2222				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2223				    $dstat !~ /$exceptions/ &&
2224				    $dstat !~ /^\.$Ident\s*=/ &&
2225				    $dstat =~ /$Operators/)
2226				{
2227					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2228				}
2229			}
2230		}
2231
2232# check for missing bracing round if etc
2233		if ($line =~ /(^.*)\bif\b/ && $line !~ /\#\s*if/) {
2234			my ($level, $endln, @chunks) =
2235				ctx_statement_full($linenr, $realcnt, 1);
2236                        if ($dbg_adv_apw) {
2237                            print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2238                            print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"
2239                                if $#chunks >= 1;
2240                        }
2241			if ($#chunks >= 0 && $level == 0) {
2242				my $allowed = 0;
2243				my $seen = 0;
2244				my $herectx = $here . "\n";
2245				my $ln = $linenr - 1;
2246				for my $chunk (@chunks) {
2247					my ($cond, $block) = @{$chunk};
2248
2249					# If the condition carries leading newlines, then count those as offsets.
2250					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2251					my $offset = statement_rawlines($whitespace) - 1;
2252
2253					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2254
2255					# We have looked at and allowed this specific line.
2256					$suppress_ifbraces{$ln + $offset} = 1;
2257
2258					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2259					$ln += statement_rawlines($block) - 1;
2260
2261					substr($block, 0, length($cond), '');
2262
2263					my $spaced_block = $block;
2264					$spaced_block =~ s/\n\+/ /g;
2265
2266					$seen++ if ($spaced_block =~ /^\s*\{/);
2267
2268                                        print "APW: cond<$cond> block<$block> allowed<$allowed>\n"
2269                                            if $dbg_adv_apw;
2270					if (statement_lines($cond) > 1) {
2271                                            print "APW: ALLOWED: cond<$cond>\n"
2272                                                if $dbg_adv_apw;
2273                                            $allowed = 1;
2274					}
2275					if ($block =~/\b(?:if|for|while)\b/) {
2276                                            print "APW: ALLOWED: block<$block>\n"
2277                                                if $dbg_adv_apw;
2278                                            $allowed = 1;
2279					}
2280					if (statement_block_size($block) > 1) {
2281                                            print "APW: ALLOWED: lines block<$block>\n"
2282                                                if $dbg_adv_apw;
2283                                            $allowed = 1;
2284					}
2285				}
2286				if ($seen != ($#chunks + 1)) {
2287					ERROR("braces {} are necessary for all arms of this statement\n" . $herectx);
2288				}
2289			}
2290		}
2291		if (!defined $suppress_ifbraces{$linenr - 1} &&
2292					$line =~ /\b(if|while|for|else)\b/ &&
2293					$line !~ /\#\s*if/ &&
2294					$line !~ /\#\s*else/) {
2295			my $allowed = 0;
2296
2297                        # Check the pre-context.
2298                        if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2299                            my $pre = $1;
2300
2301                            if ($line !~ /else/) {
2302                                print "APW: ALLOWED: pre<$pre> line<$line>\n"
2303                                    if $dbg_adv_apw;
2304                                $allowed = 1;
2305                            }
2306                        }
2307
2308			my ($level, $endln, @chunks) =
2309				ctx_statement_full($linenr, $realcnt, $-[0]);
2310
2311			# Check the condition.
2312			my ($cond, $block) = @{$chunks[0]};
2313                        print "CHECKING<$linenr> cond<$cond> block<$block>\n"
2314                            if $dbg_adv_checking;
2315			if (defined $cond) {
2316				substr($block, 0, length($cond), '');
2317			}
2318			if (statement_lines($cond) > 1) {
2319                            print "APW: ALLOWED: cond<$cond>\n"
2320                                if $dbg_adv_apw;
2321                            $allowed = 1;
2322			}
2323			if ($block =~/\b(?:if|for|while)\b/) {
2324                            print "APW: ALLOWED: block<$block>\n"
2325                                if $dbg_adv_apw;
2326                            $allowed = 1;
2327			}
2328			if (statement_block_size($block) > 1) {
2329                            print "APW: ALLOWED: lines block<$block>\n"
2330                                if $dbg_adv_apw;
2331                            $allowed = 1;
2332			}
2333			# Check the post-context.
2334			if (defined $chunks[1]) {
2335				my ($cond, $block) = @{$chunks[1]};
2336				if (defined $cond) {
2337					substr($block, 0, length($cond), '');
2338				}
2339				if ($block =~ /^\s*\{/) {
2340                                    print "APW: ALLOWED: chunk-1 block<$block>\n"
2341                                        if $dbg_adv_apw;
2342                                    $allowed = 1;
2343				}
2344			}
2345                        print "DCS: level=$level block<$block> allowed=$allowed\n"
2346                            if $dbg_adv_dcs;
2347			if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
2348				my $herectx = $here . "\n";;
2349				my $cnt = statement_rawlines($block);
2350
2351				for (my $n = 0; $n < $cnt; $n++) {
2352					$herectx .= raw_line($linenr, $n) . "\n";;
2353				}
2354
2355				ERROR("braces {} are necessary even for single statement blocks\n" . $herectx);
2356			}
2357		}
2358
2359# no volatiles please
2360		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2361		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2362			ERROR("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2363		}
2364
2365# warn about #if 0
2366		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2367			ERROR("if this code is redundant consider removing it\n" .
2368				$herecurr);
2369		}
2370
2371# check for needless g_free() checks
2372		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2373			my $expr = $1;
2374			if ($line =~ /\bg_free\(\Q$expr\E\);/) {
2375				ERROR("g_free(NULL) is safe this check is probably not required\n" . $hereprev);
2376			}
2377		}
2378
2379# warn about #ifdefs in C files
2380#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2381#			print "#ifdef in C files should be avoided\n";
2382#			print "$herecurr";
2383#			$clean = 0;
2384#		}
2385
2386# warn about spacing in #ifdefs
2387		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2388			ERROR("exactly one space required after that #$1\n" . $herecurr);
2389		}
2390# check for memory barriers without a comment.
2391		if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2392			if (!ctx_has_comment($first_line, $linenr)) {
2393				ERROR("memory barrier without comment\n" . $herecurr);
2394			}
2395		}
2396# check of hardware specific defines
2397# we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases
2398# where they might be necessary.
2399		if ($line =~ m@^.\s*\#\s*if.*\b__@) {
2400			ERROR("architecture specific defines should be avoided\n" .  $herecurr);
2401		}
2402
2403# Check that the storage class is at the beginning of a declaration
2404		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2405			ERROR("storage class should be at the beginning of the declaration\n" . $herecurr)
2406		}
2407
2408# check the location of the inline attribute, that it is between
2409# storage class and type.
2410		if ($line =~ /\b$Type\s+$Inline\b/ ||
2411		    $line =~ /\b$Inline\s+$Storage\b/) {
2412			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2413		}
2414
2415# check for sizeof(&)
2416		if ($line =~ /\bsizeof\s*\(\s*\&/) {
2417			ERROR("sizeof(& should be avoided\n" . $herecurr);
2418		}
2419
2420# check for new externs in .c files.
2421		if ($realfile =~ /\.c$/ && defined $stat &&
2422		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2423		{
2424			my $function_name = $1;
2425			my $paren_space = $2;
2426
2427			my $s = $stat;
2428			if (defined $cond) {
2429				substr($s, 0, length($cond), '');
2430			}
2431			if ($s =~ /^\s*;/ &&
2432			    $function_name ne 'uninitialized_var')
2433			{
2434				ERROR("externs should be avoided in .c files\n" .  $herecurr);
2435			}
2436
2437			if ($paren_space =~ /\n/) {
2438				ERROR("arguments for function declarations should follow identifier\n" . $herecurr);
2439			}
2440
2441		} elsif ($realfile =~ /\.c$/ && defined $stat &&
2442		    $stat =~ /^.\s*extern\s+/)
2443		{
2444			ERROR("externs should be avoided in .c files\n" .  $herecurr);
2445		}
2446
2447# check for pointless casting of g_malloc return
2448		if ($line =~ /\*\s*\)\s*g_(try)?(m|re)alloc(0?)(_n)?\b/) {
2449			if ($2 == 'm') {
2450				ERROR("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr);
2451			} else {
2452				ERROR("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr);
2453			}
2454		}
2455
2456# check for gcc specific __FUNCTION__
2457		if ($line =~ /__FUNCTION__/) {
2458			ERROR("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
2459		}
2460
2461# recommend qemu_strto* over strto* for numeric conversions
2462		if ($line =~ /\b(strto[^kd].*?)\s*\(/) {
2463			ERROR("consider using qemu_$1 in preference to $1\n" . $herecurr);
2464		}
2465# check for module_init(), use category-specific init macros explicitly please
2466		if ($line =~ /^module_init\s*\(/) {
2467			ERROR("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr);
2468		}
2469# check for various ops structs, ensure they are const.
2470		my $struct_ops = qr{AIOCBInfo|
2471				BdrvActionOps|
2472				BlockDevOps|
2473				BlockJobDriver|
2474				DisplayChangeListenerOps|
2475				GraphicHwOps|
2476				IDEDMAOps|
2477				KVMCapabilityInfo|
2478				MemoryRegionIOMMUOps|
2479				MemoryRegionOps|
2480				MemoryRegionPortio|
2481				QEMUFileOps|
2482				SCSIBusInfo|
2483				SCSIReqOps|
2484				Spice[A-Z][a-zA-Z0-9]*Interface|
2485				TPMDriverOps|
2486				USBDesc[A-Z][a-zA-Z0-9]*|
2487				VhostOps|
2488				VMStateDescription|
2489				VMStateInfo}x;
2490		if ($line !~ /\bconst\b/ &&
2491		    $line =~ /\b($struct_ops)\b/) {
2492			ERROR("struct $1 should normally be const\n" .
2493				$herecurr);
2494		}
2495
2496# check for %L{u,d,i} in strings
2497		my $string;
2498		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2499			$string = substr($rawline, $-[1], $+[1] - $-[1]);
2500			$string =~ s/%%/__/g;
2501			if ($string =~ /(?<!%)%L[udi]/) {
2502				ERROR("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2503				last;
2504			}
2505		}
2506
2507# QEMU specific tests
2508		if ($rawline =~ /\b(?:Qemu|QEmu)\b/) {
2509			ERROR("use QEMU instead of Qemu or QEmu\n" . $herecurr);
2510		}
2511
2512# Qemu error function tests
2513
2514	# Find newlines in error messages
2515	my $qemu_error_funcs = qr{error_setg|
2516				error_setg_errno|
2517				error_setg_win32|
2518				error_setg_file_open|
2519				error_set|
2520				error_prepend|
2521				error_reportf_err|
2522				error_vreport|
2523				error_report}x;
2524
2525	if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
2526		ERROR("Error messages should not contain newlines\n" . $herecurr);
2527	}
2528
2529	# Continue checking for error messages that contains newlines. This
2530	# check handles cases where string literals are spread over multiple lines.
2531	# Example:
2532	# error_report("Error msg line #1"
2533	#              "Error msg line #2\n");
2534	my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
2535	my $continued_str_literal = qr{\+\s*\".*\"};
2536
2537	if ($rawline =~ /$quoted_newline_regex/) {
2538		# Backtrack to first line that does not contain only a quoted literal
2539		# and assume that it is the start of the statement.
2540		my $i = $linenr - 2;
2541
2542		while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
2543			$i--;
2544		}
2545
2546		if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
2547			ERROR("Error messages should not contain newlines\n" . $herecurr);
2548		}
2549	}
2550
2551# check for non-portable libc calls that have portable alternatives in QEMU
2552		if ($line =~ /\bffs\(/) {
2553			ERROR("use ctz32() instead of ffs()\n" . $herecurr);
2554		}
2555		if ($line =~ /\bffsl\(/) {
2556			ERROR("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr);
2557		}
2558		if ($line =~ /\bffsll\(/) {
2559			ERROR("use ctz64() instead of ffsll()\n" . $herecurr);
2560		}
2561		if ($line =~ /\bbzero\(/) {
2562			ERROR("use memset() instead of bzero()\n" . $herecurr);
2563		}
2564	}
2565
2566	# If we have no input at all, then there is nothing to report on
2567	# so just keep quiet.
2568	if ($#rawlines == -1) {
2569		exit(0);
2570	}
2571
2572	# In mailback mode only produce a report in the negative, for
2573	# things that appear to be patches.
2574	if ($mailback && ($clean == 1 || !$is_patch)) {
2575		exit(0);
2576	}
2577
2578	# This is not a patch, and we are are in 'no-patch' mode so
2579	# just keep quiet.
2580	if (!$chk_patch && !$is_patch) {
2581		exit(0);
2582	}
2583
2584	if (!$is_patch) {
2585		ERROR("Does not appear to be a unified-diff format patch\n");
2586	}
2587	if ($is_patch && $chk_signoff && $signoff == 0) {
2588		ERROR("Missing Signed-off-by: line(s)\n");
2589	}
2590
2591	print report_dump();
2592	if ($summary && !($clean == 1 && $quiet == 1)) {
2593		print "$filename " if ($summary_file);
2594		print "total: $cnt_error errors, $cnt_warn warnings, " .
2595			"$cnt_lines lines checked\n";
2596		print "\n" if ($quiet == 0);
2597	}
2598
2599	if ($quiet == 0) {
2600		# If there were whitespace errors which cleanpatch can fix
2601		# then suggest that.
2602#		if ($rpt_cleaners) {
2603#			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2604#			print "      scripts/cleanfile\n\n";
2605#		}
2606	}
2607
2608	if ($clean == 1 && $quiet == 0) {
2609		print "$vname has no obvious style problems and is ready for submission.\n"
2610	}
2611	if ($clean == 0 && $quiet == 0) {
2612		print "$vname has style problems, please review.  If any of these errors\n";
2613		print "are false positives report them to the maintainer, see\n";
2614		print "CHECKPATCH in MAINTAINERS.\n";
2615	}
2616
2617	return ($no_warnings ? $clean : $cnt_error == 0);
2618}
2619