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