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