xref: /linux-6.15/scripts/checkpatch.pl (revision cbec18af)
10a920b5bSAndy Whitcroft#!/usr/bin/perl -w
2dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit)
300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit)
42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite)
5015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]>
60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2
70a920b5bSAndy Whitcroft
80a920b5bSAndy Whitcroftuse strict;
9c707a81dSJoe Perchesuse POSIX;
100a920b5bSAndy Whitcroft
110a920b5bSAndy Whitcroftmy $P = $0;
1200df344fSAndy Whitcroft$P =~ s@.*/@@g;
130a920b5bSAndy Whitcroft
14000d1cc1SJoe Perchesmy $V = '0.32';
150a920b5bSAndy Whitcroft
160a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev);
170a920b5bSAndy Whitcroft
180a920b5bSAndy Whitcroftmy $quiet = 0;
190a920b5bSAndy Whitcroftmy $tree = 1;
200a920b5bSAndy Whitcroftmy $chk_signoff = 1;
210a920b5bSAndy Whitcroftmy $chk_patch = 1;
22773647a0SAndy Whitcroftmy $tst_only;
236c72ffaaSAndy Whitcroftmy $emacs = 0;
248905a67cSAndy Whitcroftmy $terse = 0;
256c72ffaaSAndy Whitcroftmy $file = 0;
266c72ffaaSAndy Whitcroftmy $check = 0;
278905a67cSAndy Whitcroftmy $summary = 1;
288905a67cSAndy Whitcroftmy $mailback = 0;
2913214adfSAndy Whitcroftmy $summary_file = 0;
30000d1cc1SJoe Perchesmy $show_types = 0;
313705ce5bSJoe Perchesmy $fix = 0;
329624b8d6SJoe Perchesmy $fix_inplace = 0;
336c72ffaaSAndy Whitcroftmy $root;
34c2fdda0dSAndy Whitcroftmy %debug;
353445686aSJoe Perchesmy %camelcase = ();
3691bfe484SJoe Perchesmy %use_type = ();
3791bfe484SJoe Perchesmy @use = ();
3891bfe484SJoe Perchesmy %ignore_type = ();
39000d1cc1SJoe Perchesmy @ignore = ();
4077f5b10aSHannes Edermy $help = 0;
41000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf";
426cd7f386SJoe Perchesmy $max_line_length = 80;
43d62a201fSDave Hansenmy $ignore_perl_version = 0;
44d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0;
4577f5b10aSHannes Eder
4677f5b10aSHannes Edersub help {
4777f5b10aSHannes Eder	my ($exitcode) = @_;
4877f5b10aSHannes Eder
4977f5b10aSHannes Eder	print << "EOM";
5077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]...
5177f5b10aSHannes EderVersion: $V
5277f5b10aSHannes Eder
5377f5b10aSHannes EderOptions:
5477f5b10aSHannes Eder  -q, --quiet                quiet
5577f5b10aSHannes Eder  --no-tree                  run without a kernel tree
5677f5b10aSHannes Eder  --no-signoff               do not check for 'Signed-off-by' line
5777f5b10aSHannes Eder  --patch                    treat FILE as patchfile (default)
5877f5b10aSHannes Eder  --emacs                    emacs compile window format
5977f5b10aSHannes Eder  --terse                    one line per report
6077f5b10aSHannes Eder  -f, --file                 treat FILE as regular source file
6177f5b10aSHannes Eder  --subjective, --strict     enable more subjective tests
6291bfe484SJoe Perches  --types TYPE(,TYPE2...)    show only these comma separated message types
63000d1cc1SJoe Perches  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
646cd7f386SJoe Perches  --max-line-length=n        set the maximum line length, if exceeded, warn
65000d1cc1SJoe Perches  --show-types               show the message "types" in the output
6677f5b10aSHannes Eder  --root=PATH                PATH to the kernel tree root
6777f5b10aSHannes Eder  --no-summary               suppress the per-file summary
6877f5b10aSHannes Eder  --mailback                 only produce a report in case of warnings/errors
6977f5b10aSHannes Eder  --summary-file             include the filename in summary
7077f5b10aSHannes Eder  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
7177f5b10aSHannes Eder                             'values', 'possible', 'type', and 'attr' (default
7277f5b10aSHannes Eder                             is all off)
7377f5b10aSHannes Eder  --test-only=WORD           report only warnings/errors containing WORD
7477f5b10aSHannes Eder                             literally
753705ce5bSJoe Perches  --fix                      EXPERIMENTAL - may create horrible results
763705ce5bSJoe Perches                             If correctable single-line errors exist, create
773705ce5bSJoe Perches                             "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
783705ce5bSJoe Perches                             with potential errors corrected to the preferred
793705ce5bSJoe Perches                             checkpatch style
809624b8d6SJoe Perches  --fix-inplace              EXPERIMENTAL - may create horrible results
819624b8d6SJoe Perches                             Is the same as --fix, but overwrites the input
829624b8d6SJoe Perches                             file.  It's your fault if there's no backup or git
83d62a201fSDave Hansen  --ignore-perl-version      override checking of perl version.  expect
84d62a201fSDave Hansen                             runtime errors.
8577f5b10aSHannes Eder  -h, --help, --version      display this help and exit
8677f5b10aSHannes Eder
8777f5b10aSHannes EderWhen FILE is - read standard input.
8877f5b10aSHannes EderEOM
8977f5b10aSHannes Eder
9077f5b10aSHannes Eder	exit($exitcode);
9177f5b10aSHannes Eder}
9277f5b10aSHannes Eder
93000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file);
94000d1cc1SJoe Perchesif (-f $conf) {
95000d1cc1SJoe Perches	my @conf_args;
96000d1cc1SJoe Perches	open(my $conffile, '<', "$conf")
97000d1cc1SJoe Perches	    or warn "$P: Can't find a readable $configuration_file file $!\n";
98000d1cc1SJoe Perches
99000d1cc1SJoe Perches	while (<$conffile>) {
100000d1cc1SJoe Perches		my $line = $_;
101000d1cc1SJoe Perches
102000d1cc1SJoe Perches		$line =~ s/\s*\n?$//g;
103000d1cc1SJoe Perches		$line =~ s/^\s*//g;
104000d1cc1SJoe Perches		$line =~ s/\s+/ /g;
105000d1cc1SJoe Perches
106000d1cc1SJoe Perches		next if ($line =~ m/^\s*#/);
107000d1cc1SJoe Perches		next if ($line =~ m/^\s*$/);
108000d1cc1SJoe Perches
109000d1cc1SJoe Perches		my @words = split(" ", $line);
110000d1cc1SJoe Perches		foreach my $word (@words) {
111000d1cc1SJoe Perches			last if ($word =~ m/^#/);
112000d1cc1SJoe Perches			push (@conf_args, $word);
113000d1cc1SJoe Perches		}
114000d1cc1SJoe Perches	}
115000d1cc1SJoe Perches	close($conffile);
116000d1cc1SJoe Perches	unshift(@ARGV, @conf_args) if @conf_args;
117000d1cc1SJoe Perches}
118000d1cc1SJoe Perches
1190a920b5bSAndy WhitcroftGetOptions(
1206c72ffaaSAndy Whitcroft	'q|quiet+'	=> \$quiet,
1210a920b5bSAndy Whitcroft	'tree!'		=> \$tree,
1220a920b5bSAndy Whitcroft	'signoff!'	=> \$chk_signoff,
1230a920b5bSAndy Whitcroft	'patch!'	=> \$chk_patch,
1246c72ffaaSAndy Whitcroft	'emacs!'	=> \$emacs,
1258905a67cSAndy Whitcroft	'terse!'	=> \$terse,
12677f5b10aSHannes Eder	'f|file!'	=> \$file,
1276c72ffaaSAndy Whitcroft	'subjective!'	=> \$check,
1286c72ffaaSAndy Whitcroft	'strict!'	=> \$check,
129000d1cc1SJoe Perches	'ignore=s'	=> \@ignore,
13091bfe484SJoe Perches	'types=s'	=> \@use,
131000d1cc1SJoe Perches	'show-types!'	=> \$show_types,
1326cd7f386SJoe Perches	'max-line-length=i' => \$max_line_length,
1336c72ffaaSAndy Whitcroft	'root=s'	=> \$root,
1348905a67cSAndy Whitcroft	'summary!'	=> \$summary,
1358905a67cSAndy Whitcroft	'mailback!'	=> \$mailback,
13613214adfSAndy Whitcroft	'summary-file!'	=> \$summary_file,
1373705ce5bSJoe Perches	'fix!'		=> \$fix,
1389624b8d6SJoe Perches	'fix-inplace!'	=> \$fix_inplace,
139d62a201fSDave Hansen	'ignore-perl-version!' => \$ignore_perl_version,
140c2fdda0dSAndy Whitcroft	'debug=s'	=> \%debug,
141773647a0SAndy Whitcroft	'test-only=s'	=> \$tst_only,
14277f5b10aSHannes Eder	'h|help'	=> \$help,
14377f5b10aSHannes Eder	'version'	=> \$help
14477f5b10aSHannes Eder) or help(1);
14577f5b10aSHannes Eder
14677f5b10aSHannes Ederhelp(0) if ($help);
1470a920b5bSAndy Whitcroft
1489624b8d6SJoe Perches$fix = 1 if ($fix_inplace);
1499624b8d6SJoe Perches
1500a920b5bSAndy Whitcroftmy $exit = 0;
1510a920b5bSAndy Whitcroft
152d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) {
153d62a201fSDave Hansen	printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
154d62a201fSDave Hansen	if (!$ignore_perl_version) {
155d62a201fSDave Hansen		exit(1);
156d62a201fSDave Hansen	}
157d62a201fSDave Hansen}
158d62a201fSDave Hansen
1590a920b5bSAndy Whitcroftif ($#ARGV < 0) {
16077f5b10aSHannes Eder	print "$P: no input files\n";
1610a920b5bSAndy Whitcroft	exit(1);
1620a920b5bSAndy Whitcroft}
1630a920b5bSAndy Whitcroft
16491bfe484SJoe Perchessub hash_save_array_words {
16591bfe484SJoe Perches	my ($hashRef, $arrayRef) = @_;
16691bfe484SJoe Perches
16791bfe484SJoe Perches	my @array = split(/,/, join(',', @$arrayRef));
16891bfe484SJoe Perches	foreach my $word (@array) {
169000d1cc1SJoe Perches		$word =~ s/\s*\n?$//g;
170000d1cc1SJoe Perches		$word =~ s/^\s*//g;
171000d1cc1SJoe Perches		$word =~ s/\s+/ /g;
172000d1cc1SJoe Perches		$word =~ tr/[a-z]/[A-Z]/;
173000d1cc1SJoe Perches
174000d1cc1SJoe Perches		next if ($word =~ m/^\s*#/);
175000d1cc1SJoe Perches		next if ($word =~ m/^\s*$/);
176000d1cc1SJoe Perches
17791bfe484SJoe Perches		$hashRef->{$word}++;
178000d1cc1SJoe Perches	}
17991bfe484SJoe Perches}
18091bfe484SJoe Perches
18191bfe484SJoe Perchessub hash_show_words {
18291bfe484SJoe Perches	my ($hashRef, $prefix) = @_;
18391bfe484SJoe Perches
18458cb3cf6SJoe Perches	if ($quiet == 0 && keys %$hashRef) {
18591bfe484SJoe Perches		print "NOTE: $prefix message types:";
18658cb3cf6SJoe Perches		foreach my $word (sort keys %$hashRef) {
18791bfe484SJoe Perches			print " $word";
18891bfe484SJoe Perches		}
18991bfe484SJoe Perches		print "\n\n";
19091bfe484SJoe Perches	}
19191bfe484SJoe Perches}
19291bfe484SJoe Perches
19391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore);
19491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use);
195000d1cc1SJoe Perches
196c2fdda0dSAndy Whitcroftmy $dbg_values = 0;
197c2fdda0dSAndy Whitcroftmy $dbg_possible = 0;
1987429c690SAndy Whitcroftmy $dbg_type = 0;
199a1ef277eSAndy Whitcroftmy $dbg_attr = 0;
200c2fdda0dSAndy Whitcroftfor my $key (keys %debug) {
20121caa13cSAndy Whitcroft	## no critic
20221caa13cSAndy Whitcroft	eval "\${dbg_$key} = '$debug{$key}';";
20321caa13cSAndy Whitcroft	die "$@" if ($@);
204c2fdda0dSAndy Whitcroft}
205c2fdda0dSAndy Whitcroft
206d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0;
207d2c0a235SAndy Whitcroft
2088905a67cSAndy Whitcroftif ($terse) {
2098905a67cSAndy Whitcroft	$emacs = 1;
2108905a67cSAndy Whitcroft	$quiet++;
2118905a67cSAndy Whitcroft}
2128905a67cSAndy Whitcroft
2136c72ffaaSAndy Whitcroftif ($tree) {
2146c72ffaaSAndy Whitcroft	if (defined $root) {
2156c72ffaaSAndy Whitcroft		if (!top_of_kernel_tree($root)) {
2166c72ffaaSAndy Whitcroft			die "$P: $root: --root does not point at a valid tree\n";
2176c72ffaaSAndy Whitcroft		}
2186c72ffaaSAndy Whitcroft	} else {
2196c72ffaaSAndy Whitcroft		if (top_of_kernel_tree('.')) {
2206c72ffaaSAndy Whitcroft			$root = '.';
2216c72ffaaSAndy Whitcroft		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
2226c72ffaaSAndy Whitcroft						top_of_kernel_tree($1)) {
2236c72ffaaSAndy Whitcroft			$root = $1;
2246c72ffaaSAndy Whitcroft		}
2256c72ffaaSAndy Whitcroft	}
2266c72ffaaSAndy Whitcroft
2276c72ffaaSAndy Whitcroft	if (!defined $root) {
2280a920b5bSAndy Whitcroft		print "Must be run from the top-level dir. of a kernel tree\n";
2290a920b5bSAndy Whitcroft		exit(2);
2300a920b5bSAndy Whitcroft	}
2316c72ffaaSAndy Whitcroft}
2326c72ffaaSAndy Whitcroft
2336c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0;
2346c72ffaaSAndy Whitcroft
2352ceb532bSAndy Whitcroftour $Ident	= qr{
2362ceb532bSAndy Whitcroft			[A-Za-z_][A-Za-z\d_]*
2372ceb532bSAndy Whitcroft			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
2382ceb532bSAndy Whitcroft		}x;
2396c72ffaaSAndy Whitcroftour $Storage	= qr{extern|static|asmlinkage};
2406c72ffaaSAndy Whitcroftour $Sparse	= qr{
2416c72ffaaSAndy Whitcroft			__user|
2426c72ffaaSAndy Whitcroft			__kernel|
2436c72ffaaSAndy Whitcroft			__force|
2446c72ffaaSAndy Whitcroft			__iomem|
2456c72ffaaSAndy Whitcroft			__must_check|
2466c72ffaaSAndy Whitcroft			__init_refok|
247417495edSAndy Whitcroft			__kprobes|
248165e72a6SSven Eckelmann			__ref|
249165e72a6SSven Eckelmann			__rcu
2506c72ffaaSAndy Whitcroft		}x;
251e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
252e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
253e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
254e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
255e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
2568716de38SJoe Perches
25752131292SWolfram Sang# Notes to $Attribute:
25852131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
2596c72ffaaSAndy Whitcroftour $Attribute	= qr{
2606c72ffaaSAndy Whitcroft			const|
26103f1df7dSJoe Perches			__percpu|
26203f1df7dSJoe Perches			__nocast|
26303f1df7dSJoe Perches			__safe|
26403f1df7dSJoe Perches			__bitwise__|
26503f1df7dSJoe Perches			__packed__|
26603f1df7dSJoe Perches			__packed2__|
26703f1df7dSJoe Perches			__naked|
26803f1df7dSJoe Perches			__maybe_unused|
26903f1df7dSJoe Perches			__always_unused|
27003f1df7dSJoe Perches			__noreturn|
27103f1df7dSJoe Perches			__used|
27203f1df7dSJoe Perches			__cold|
27303f1df7dSJoe Perches			__noclone|
27403f1df7dSJoe Perches			__deprecated|
2756c72ffaaSAndy Whitcroft			__read_mostly|
2766c72ffaaSAndy Whitcroft			__kprobes|
2778716de38SJoe Perches			$InitAttribute|
27824e1d81aSAndy Whitcroft			____cacheline_aligned|
27924e1d81aSAndy Whitcroft			____cacheline_aligned_in_smp|
2805fe3af11SAndy Whitcroft			____cacheline_internodealigned_in_smp|
2815fe3af11SAndy Whitcroft			__weak
2826c72ffaaSAndy Whitcroft		  }x;
283c45dcabdSAndy Whitcroftour $Modifier;
2846c72ffaaSAndy Whitcroftour $Inline	= qr{inline|__always_inline|noinline};
2856c72ffaaSAndy Whitcroftour $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
2866c72ffaaSAndy Whitcroftour $Lval	= qr{$Ident(?:$Member)*};
2876c72ffaaSAndy Whitcroft
28895e2c602SJoe Perchesour $Int_type	= qr{(?i)llu|ull|ll|lu|ul|l|u};
28995e2c602SJoe Perchesour $Binary	= qr{(?i)0b[01]+$Int_type?};
29095e2c602SJoe Perchesour $Hex	= qr{(?i)0x[0-9a-f]+$Int_type?};
29195e2c602SJoe Perchesour $Int	= qr{[0-9]+$Int_type?};
2922435880fSJoe Perchesour $Octal	= qr{0[0-7]+$Int_type?};
293326b1ffcSJoe Perchesour $Float_hex	= qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
294326b1ffcSJoe Perchesour $Float_dec	= qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
295326b1ffcSJoe Perchesour $Float_int	= qr{(?i)[0-9]+e-?[0-9]+[fl]?};
29674349bccSJoe Perchesour $Float	= qr{$Float_hex|$Float_dec|$Float_int};
2972435880fSJoe Perchesour $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
298326b1ffcSJoe Perchesour $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
299447432f3SJoe Perchesour $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
30023f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%};
3016c72ffaaSAndy Whitcroftour $Operators	= qr{
3026c72ffaaSAndy Whitcroft			<=|>=|==|!=|
3036c72ffaaSAndy Whitcroft			=>|->|<<|>>|<|>|!|~|
30423f780c9SJoe Perches			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
3056c72ffaaSAndy Whitcroft		  }x;
3066c72ffaaSAndy Whitcroft
3078905a67cSAndy Whitcroftour $NonptrType;
3088716de38SJoe Perchesour $NonptrTypeWithAttr;
3098905a67cSAndy Whitcroftour $Type;
3108905a67cSAndy Whitcroftour $Declare;
3118905a67cSAndy Whitcroft
31215662b3eSJoe Perchesour $NON_ASCII_UTF8	= qr{
31315662b3eSJoe Perches	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
314171ae1a4SAndy Whitcroft	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
315171ae1a4SAndy Whitcroft	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
316171ae1a4SAndy Whitcroft	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
317171ae1a4SAndy Whitcroft	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
318171ae1a4SAndy Whitcroft	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
319171ae1a4SAndy Whitcroft	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
320171ae1a4SAndy Whitcroft}x;
321171ae1a4SAndy Whitcroft
32215662b3eSJoe Perchesour $UTF8	= qr{
32315662b3eSJoe Perches	[\x09\x0A\x0D\x20-\x7E]              # ASCII
32415662b3eSJoe Perches	| $NON_ASCII_UTF8
32515662b3eSJoe Perches}x;
32615662b3eSJoe Perches
3278ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x:
328fb9e9096SAndy Whitcroft	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
3298ed22cadSAndy Whitcroft	atomic_t
3308ed22cadSAndy Whitcroft)};
3318ed22cadSAndy Whitcroft
332691e669bSJoe Perchesour $logFunctions = qr{(?x:
3336e60c02eSJoe Perches	printk(?:_ratelimited|_once|)|
3347d0b6594SJacob Keller	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
3356e60c02eSJoe Perches	WARN(?:_RATELIMIT|_ONCE|)|
336b0531722SJoe Perches	panic|
33706668727SJoe Perches	MODULE_[A-Z_]+|
33806668727SJoe Perches	seq_vprintf|seq_printf|seq_puts
339691e669bSJoe Perches)};
340691e669bSJoe Perches
34120112475SJoe Perchesour $signature_tags = qr{(?xi:
34220112475SJoe Perches	Signed-off-by:|
34320112475SJoe Perches	Acked-by:|
34420112475SJoe Perches	Tested-by:|
34520112475SJoe Perches	Reviewed-by:|
34620112475SJoe Perches	Reported-by:|
3478543ae12SMugunthan V N	Suggested-by:|
34820112475SJoe Perches	To:|
34920112475SJoe Perches	Cc:
35020112475SJoe Perches)};
35120112475SJoe Perches
3528905a67cSAndy Whitcroftour @typeList = (
3538905a67cSAndy Whitcroft	qr{void},
354c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?char},
355c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?short},
356c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?int},
357c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long},
358c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+int},
359c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+long},
360c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+long\s+int},
3618905a67cSAndy Whitcroft	qr{unsigned},
3628905a67cSAndy Whitcroft	qr{float},
3638905a67cSAndy Whitcroft	qr{double},
3648905a67cSAndy Whitcroft	qr{bool},
3658905a67cSAndy Whitcroft	qr{struct\s+$Ident},
3668905a67cSAndy Whitcroft	qr{union\s+$Ident},
3678905a67cSAndy Whitcroft	qr{enum\s+$Ident},
3688905a67cSAndy Whitcroft	qr{${Ident}_t},
3698905a67cSAndy Whitcroft	qr{${Ident}_handler},
3708905a67cSAndy Whitcroft	qr{${Ident}_handler_fn},
3718905a67cSAndy Whitcroft);
3728716de38SJoe Perchesour @typeListWithAttr = (
3738716de38SJoe Perches	@typeList,
3748716de38SJoe Perches	qr{struct\s+$InitAttribute\s+$Ident},
3758716de38SJoe Perches	qr{union\s+$InitAttribute\s+$Ident},
3768716de38SJoe Perches);
3778716de38SJoe Perches
378c45dcabdSAndy Whitcroftour @modifierList = (
379c45dcabdSAndy Whitcroft	qr{fastcall},
380c45dcabdSAndy Whitcroft);
3818905a67cSAndy Whitcroft
3822435880fSJoe Perchesour @mode_permission_funcs = (
3832435880fSJoe Perches	["module_param", 3],
3842435880fSJoe Perches	["module_param_(?:array|named|string)", 4],
3852435880fSJoe Perches	["module_param_array_named", 5],
3862435880fSJoe Perches	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
3872435880fSJoe Perches	["proc_create(?:_data|)", 2],
3882435880fSJoe Perches	["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
3892435880fSJoe Perches);
3902435880fSJoe Perches
3917840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x:
3927840a94cSWolfram Sang	irq|
3937840a94cSWolfram Sang	memory
3947840a94cSWolfram Sang)};
3957840a94cSWolfram Sang# memory.h: ARM has a custom one
3967840a94cSWolfram Sang
3978905a67cSAndy Whitcroftsub build_types {
398d2172eb5SAndy Whitcroft	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
399d2172eb5SAndy Whitcroft	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
4008716de38SJoe Perches	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
401c8cb2ca3SAndy Whitcroft	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
4028905a67cSAndy Whitcroft	$NonptrType	= qr{
403d2172eb5SAndy Whitcroft			(?:$Modifier\s+|const\s+)*
404cf655043SAndy Whitcroft			(?:
4056b48db24SAndy Whitcroft				(?:typeof|__typeof__)\s*\([^\)]*\)|
4068ed22cadSAndy Whitcroft				(?:$typeTypedefs\b)|
407c45dcabdSAndy Whitcroft				(?:${all}\b)
408cf655043SAndy Whitcroft			)
409c8cb2ca3SAndy Whitcroft			(?:\s+$Modifier|\s+const)*
4108905a67cSAndy Whitcroft		  }x;
4118716de38SJoe Perches	$NonptrTypeWithAttr	= qr{
4128716de38SJoe Perches			(?:$Modifier\s+|const\s+)*
4138716de38SJoe Perches			(?:
4148716de38SJoe Perches				(?:typeof|__typeof__)\s*\([^\)]*\)|
4158716de38SJoe Perches				(?:$typeTypedefs\b)|
4168716de38SJoe Perches				(?:${allWithAttr}\b)
4178716de38SJoe Perches			)
4188716de38SJoe Perches			(?:\s+$Modifier|\s+const)*
4198716de38SJoe Perches		  }x;
4208905a67cSAndy Whitcroft	$Type	= qr{
421c45dcabdSAndy Whitcroft			$NonptrType
422b337d8b8SAndy Whitcroft			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
423c8cb2ca3SAndy Whitcroft			(?:\s+$Inline|\s+$Modifier)*
4248905a67cSAndy Whitcroft		  }x;
4258905a67cSAndy Whitcroft	$Declare	= qr{(?:$Storage\s+)?$Type};
4268905a67cSAndy Whitcroft}
4278905a67cSAndy Whitcroftbuild_types();
4286c72ffaaSAndy Whitcroft
4297d2367afSJoe Perchesour $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
430d1fe9c09SJoe Perches
431d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg
432d1fe9c09SJoe Perches# requires at least perl version v5.10.0
433d1fe9c09SJoe Perches# Any use must be runtime checked with $^V
434d1fe9c09SJoe Perches
435d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
4362435880fSJoe Perchesour $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
437d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
4387d2367afSJoe Perches
4397d2367afSJoe Perchessub deparenthesize {
4407d2367afSJoe Perches	my ($string) = @_;
4417d2367afSJoe Perches	return "" if (!defined($string));
4427d2367afSJoe Perches	$string =~ s@^\s*\(\s*@@g;
4437d2367afSJoe Perches	$string =~ s@\s*\)\s*$@@g;
4447d2367afSJoe Perches	$string =~ s@\s+@ @g;
4457d2367afSJoe Perches	return $string;
4467d2367afSJoe Perches}
4477d2367afSJoe Perches
4483445686aSJoe Perchessub seed_camelcase_file {
4493445686aSJoe Perches	my ($file) = @_;
4503445686aSJoe Perches
4513445686aSJoe Perches	return if (!(-f $file));
4523445686aSJoe Perches
4533445686aSJoe Perches	local $/;
4543445686aSJoe Perches
4553445686aSJoe Perches	open(my $include_file, '<', "$file")
4563445686aSJoe Perches	    or warn "$P: Can't read '$file' $!\n";
4573445686aSJoe Perches	my $text = <$include_file>;
4583445686aSJoe Perches	close($include_file);
4593445686aSJoe Perches
4603445686aSJoe Perches	my @lines = split('\n', $text);
4613445686aSJoe Perches
4623445686aSJoe Perches	foreach my $line (@lines) {
4633445686aSJoe Perches		next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
4643445686aSJoe Perches		if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
4653445686aSJoe Perches			$camelcase{$1} = 1;
46611ea516aSJoe Perches		} elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
46711ea516aSJoe Perches			$camelcase{$1} = 1;
46811ea516aSJoe Perches		} elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
4693445686aSJoe Perches			$camelcase{$1} = 1;
4703445686aSJoe Perches		}
4713445686aSJoe Perches	}
4723445686aSJoe Perches}
4733445686aSJoe Perches
4743445686aSJoe Perchesmy $camelcase_seeded = 0;
4753445686aSJoe Perchessub seed_camelcase_includes {
4763445686aSJoe Perches	return if ($camelcase_seeded);
4773445686aSJoe Perches
4783445686aSJoe Perches	my $files;
479c707a81dSJoe Perches	my $camelcase_cache = "";
480c707a81dSJoe Perches	my @include_files = ();
481c707a81dSJoe Perches
482c707a81dSJoe Perches	$camelcase_seeded = 1;
483351b2a1fSJoe Perches
4843645e328SRichard Genoud	if (-e ".git") {
485351b2a1fSJoe Perches		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
486351b2a1fSJoe Perches		chomp $git_last_include_commit;
487c707a81dSJoe Perches		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
488c707a81dSJoe Perches	} else {
489c707a81dSJoe Perches		my $last_mod_date = 0;
490c707a81dSJoe Perches		$files = `find $root/include -name "*.h"`;
491c707a81dSJoe Perches		@include_files = split('\n', $files);
492c707a81dSJoe Perches		foreach my $file (@include_files) {
493c707a81dSJoe Perches			my $date = POSIX::strftime("%Y%m%d%H%M",
494c707a81dSJoe Perches						   localtime((stat $file)[9]));
495c707a81dSJoe Perches			$last_mod_date = $date if ($last_mod_date < $date);
496c707a81dSJoe Perches		}
497c707a81dSJoe Perches		$camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
498c707a81dSJoe Perches	}
499c707a81dSJoe Perches
500c707a81dSJoe Perches	if ($camelcase_cache ne "" && -f $camelcase_cache) {
501c707a81dSJoe Perches		open(my $camelcase_file, '<', "$camelcase_cache")
502c707a81dSJoe Perches		    or warn "$P: Can't read '$camelcase_cache' $!\n";
503351b2a1fSJoe Perches		while (<$camelcase_file>) {
504351b2a1fSJoe Perches			chomp;
505351b2a1fSJoe Perches			$camelcase{$_} = 1;
506351b2a1fSJoe Perches		}
507351b2a1fSJoe Perches		close($camelcase_file);
508351b2a1fSJoe Perches
509351b2a1fSJoe Perches		return;
510351b2a1fSJoe Perches	}
511c707a81dSJoe Perches
5123645e328SRichard Genoud	if (-e ".git") {
513c707a81dSJoe Perches		$files = `git ls-files "include/*.h"`;
514c707a81dSJoe Perches		@include_files = split('\n', $files);
5153445686aSJoe Perches	}
516c707a81dSJoe Perches
5173445686aSJoe Perches	foreach my $file (@include_files) {
5183445686aSJoe Perches		seed_camelcase_file($file);
5193445686aSJoe Perches	}
520351b2a1fSJoe Perches
521c707a81dSJoe Perches	if ($camelcase_cache ne "") {
522351b2a1fSJoe Perches		unlink glob ".checkpatch-camelcase.*";
523c707a81dSJoe Perches		open(my $camelcase_file, '>', "$camelcase_cache")
524c707a81dSJoe Perches		    or warn "$P: Can't write '$camelcase_cache' $!\n";
525351b2a1fSJoe Perches		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
526351b2a1fSJoe Perches			print $camelcase_file ("$_\n");
527351b2a1fSJoe Perches		}
528351b2a1fSJoe Perches		close($camelcase_file);
529351b2a1fSJoe Perches	}
5303445686aSJoe Perches}
5313445686aSJoe Perches
5326c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file);
5330a920b5bSAndy Whitcroft
53400df344fSAndy Whitcroftmy @rawlines = ();
535c2fdda0dSAndy Whitcroftmy @lines = ();
5363705ce5bSJoe Perchesmy @fixed = ();
537c2fdda0dSAndy Whitcroftmy $vname;
5386c72ffaaSAndy Whitcroftfor my $filename (@ARGV) {
53921caa13cSAndy Whitcroft	my $FILE;
5406c72ffaaSAndy Whitcroft	if ($file) {
54121caa13cSAndy Whitcroft		open($FILE, '-|', "diff -u /dev/null $filename") ||
5426c72ffaaSAndy Whitcroft			die "$P: $filename: diff failed - $!\n";
54321caa13cSAndy Whitcroft	} elsif ($filename eq '-') {
54421caa13cSAndy Whitcroft		open($FILE, '<&STDIN');
5456c72ffaaSAndy Whitcroft	} else {
54621caa13cSAndy Whitcroft		open($FILE, '<', "$filename") ||
5476c72ffaaSAndy Whitcroft			die "$P: $filename: open failed - $!\n";
5486c72ffaaSAndy Whitcroft	}
549c2fdda0dSAndy Whitcroft	if ($filename eq '-') {
550c2fdda0dSAndy Whitcroft		$vname = 'Your patch';
551c2fdda0dSAndy Whitcroft	} else {
552c2fdda0dSAndy Whitcroft		$vname = $filename;
553c2fdda0dSAndy Whitcroft	}
55421caa13cSAndy Whitcroft	while (<$FILE>) {
5550a920b5bSAndy Whitcroft		chomp;
55600df344fSAndy Whitcroft		push(@rawlines, $_);
5576c72ffaaSAndy Whitcroft	}
55821caa13cSAndy Whitcroft	close($FILE);
559c2fdda0dSAndy Whitcroft	if (!process($filename)) {
5600a920b5bSAndy Whitcroft		$exit = 1;
5610a920b5bSAndy Whitcroft	}
56200df344fSAndy Whitcroft	@rawlines = ();
56313214adfSAndy Whitcroft	@lines = ();
5643705ce5bSJoe Perches	@fixed = ();
5650a920b5bSAndy Whitcroft}
5660a920b5bSAndy Whitcroft
5670a920b5bSAndy Whitcroftexit($exit);
5680a920b5bSAndy Whitcroft
5690a920b5bSAndy Whitcroftsub top_of_kernel_tree {
5706c72ffaaSAndy Whitcroft	my ($root) = @_;
5716c72ffaaSAndy Whitcroft
5726c72ffaaSAndy Whitcroft	my @tree_check = (
5736c72ffaaSAndy Whitcroft		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
5746c72ffaaSAndy Whitcroft		"README", "Documentation", "arch", "include", "drivers",
5756c72ffaaSAndy Whitcroft		"fs", "init", "ipc", "kernel", "lib", "scripts",
5766c72ffaaSAndy Whitcroft	);
5776c72ffaaSAndy Whitcroft
5786c72ffaaSAndy Whitcroft	foreach my $check (@tree_check) {
5796c72ffaaSAndy Whitcroft		if (! -e $root . '/' . $check) {
5800a920b5bSAndy Whitcroft			return 0;
5810a920b5bSAndy Whitcroft		}
5826c72ffaaSAndy Whitcroft	}
5836c72ffaaSAndy Whitcroft	return 1;
5846c72ffaaSAndy Whitcroft}
5850a920b5bSAndy Whitcroft
58620112475SJoe Perchessub parse_email {
58720112475SJoe Perches	my ($formatted_email) = @_;
58820112475SJoe Perches
58920112475SJoe Perches	my $name = "";
59020112475SJoe Perches	my $address = "";
59120112475SJoe Perches	my $comment = "";
59220112475SJoe Perches
59320112475SJoe Perches	if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
59420112475SJoe Perches		$name = $1;
59520112475SJoe Perches		$address = $2;
59620112475SJoe Perches		$comment = $3 if defined $3;
59720112475SJoe Perches	} elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
59820112475SJoe Perches		$address = $1;
59920112475SJoe Perches		$comment = $2 if defined $2;
60020112475SJoe Perches	} elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
60120112475SJoe Perches		$address = $1;
60220112475SJoe Perches		$comment = $2 if defined $2;
60320112475SJoe Perches		$formatted_email =~ s/$address.*$//;
60420112475SJoe Perches		$name = $formatted_email;
6053705ce5bSJoe Perches		$name = trim($name);
60620112475SJoe Perches		$name =~ s/^\"|\"$//g;
60720112475SJoe Perches		# If there's a name left after stripping spaces and
60820112475SJoe Perches		# leading quotes, and the address doesn't have both
60920112475SJoe Perches		# leading and trailing angle brackets, the address
61020112475SJoe Perches		# is invalid. ie:
61120112475SJoe Perches		#   "joe smith [email protected]" bad
61220112475SJoe Perches		#   "joe smith <[email protected]" bad
61320112475SJoe Perches		if ($name ne "" && $address !~ /^<[^>]+>$/) {
61420112475SJoe Perches			$name = "";
61520112475SJoe Perches			$address = "";
61620112475SJoe Perches			$comment = "";
61720112475SJoe Perches		}
61820112475SJoe Perches	}
61920112475SJoe Perches
6203705ce5bSJoe Perches	$name = trim($name);
62120112475SJoe Perches	$name =~ s/^\"|\"$//g;
6223705ce5bSJoe Perches	$address = trim($address);
62320112475SJoe Perches	$address =~ s/^\<|\>$//g;
62420112475SJoe Perches
62520112475SJoe Perches	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
62620112475SJoe Perches		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
62720112475SJoe Perches		$name = "\"$name\"";
62820112475SJoe Perches	}
62920112475SJoe Perches
63020112475SJoe Perches	return ($name, $address, $comment);
63120112475SJoe Perches}
63220112475SJoe Perches
63320112475SJoe Perchessub format_email {
63420112475SJoe Perches	my ($name, $address) = @_;
63520112475SJoe Perches
63620112475SJoe Perches	my $formatted_email;
63720112475SJoe Perches
6383705ce5bSJoe Perches	$name = trim($name);
63920112475SJoe Perches	$name =~ s/^\"|\"$//g;
6403705ce5bSJoe Perches	$address = trim($address);
64120112475SJoe Perches
64220112475SJoe Perches	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
64320112475SJoe Perches		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
64420112475SJoe Perches		$name = "\"$name\"";
64520112475SJoe Perches	}
64620112475SJoe Perches
64720112475SJoe Perches	if ("$name" eq "") {
64820112475SJoe Perches		$formatted_email = "$address";
64920112475SJoe Perches	} else {
65020112475SJoe Perches		$formatted_email = "$name <$address>";
65120112475SJoe Perches	}
65220112475SJoe Perches
65320112475SJoe Perches	return $formatted_email;
65420112475SJoe Perches}
65520112475SJoe Perches
656000d1cc1SJoe Perchessub which_conf {
657000d1cc1SJoe Perches	my ($conf) = @_;
658000d1cc1SJoe Perches
659000d1cc1SJoe Perches	foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
660000d1cc1SJoe Perches		if (-e "$path/$conf") {
661000d1cc1SJoe Perches			return "$path/$conf";
662000d1cc1SJoe Perches		}
663000d1cc1SJoe Perches	}
664000d1cc1SJoe Perches
665000d1cc1SJoe Perches	return "";
666000d1cc1SJoe Perches}
667000d1cc1SJoe Perches
6680a920b5bSAndy Whitcroftsub expand_tabs {
6690a920b5bSAndy Whitcroft	my ($str) = @_;
6700a920b5bSAndy Whitcroft
6710a920b5bSAndy Whitcroft	my $res = '';
6720a920b5bSAndy Whitcroft	my $n = 0;
6730a920b5bSAndy Whitcroft	for my $c (split(//, $str)) {
6740a920b5bSAndy Whitcroft		if ($c eq "\t") {
6750a920b5bSAndy Whitcroft			$res .= ' ';
6760a920b5bSAndy Whitcroft			$n++;
6770a920b5bSAndy Whitcroft			for (; ($n % 8) != 0; $n++) {
6780a920b5bSAndy Whitcroft				$res .= ' ';
6790a920b5bSAndy Whitcroft			}
6800a920b5bSAndy Whitcroft			next;
6810a920b5bSAndy Whitcroft		}
6820a920b5bSAndy Whitcroft		$res .= $c;
6830a920b5bSAndy Whitcroft		$n++;
6840a920b5bSAndy Whitcroft	}
6850a920b5bSAndy Whitcroft
6860a920b5bSAndy Whitcroft	return $res;
6870a920b5bSAndy Whitcroft}
6886c72ffaaSAndy Whitcroftsub copy_spacing {
689773647a0SAndy Whitcroft	(my $res = shift) =~ tr/\t/ /c;
6906c72ffaaSAndy Whitcroft	return $res;
6916c72ffaaSAndy Whitcroft}
6920a920b5bSAndy Whitcroft
6934a0df2efSAndy Whitcroftsub line_stats {
6944a0df2efSAndy Whitcroft	my ($line) = @_;
6954a0df2efSAndy Whitcroft
6964a0df2efSAndy Whitcroft	# Drop the diff line leader and expand tabs
6974a0df2efSAndy Whitcroft	$line =~ s/^.//;
6984a0df2efSAndy Whitcroft	$line = expand_tabs($line);
6994a0df2efSAndy Whitcroft
7004a0df2efSAndy Whitcroft	# Pick the indent from the front of the line.
7014a0df2efSAndy Whitcroft	my ($white) = ($line =~ /^(\s*)/);
7024a0df2efSAndy Whitcroft
7034a0df2efSAndy Whitcroft	return (length($line), length($white));
7044a0df2efSAndy Whitcroft}
7054a0df2efSAndy Whitcroft
706773647a0SAndy Whitcroftmy $sanitise_quote = '';
707773647a0SAndy Whitcroft
708773647a0SAndy Whitcroftsub sanitise_line_reset {
709773647a0SAndy Whitcroft	my ($in_comment) = @_;
710773647a0SAndy Whitcroft
711773647a0SAndy Whitcroft	if ($in_comment) {
712773647a0SAndy Whitcroft		$sanitise_quote = '*/';
713773647a0SAndy Whitcroft	} else {
714773647a0SAndy Whitcroft		$sanitise_quote = '';
715773647a0SAndy Whitcroft	}
716773647a0SAndy Whitcroft}
71700df344fSAndy Whitcroftsub sanitise_line {
71800df344fSAndy Whitcroft	my ($line) = @_;
71900df344fSAndy Whitcroft
72000df344fSAndy Whitcroft	my $res = '';
72100df344fSAndy Whitcroft	my $l = '';
72200df344fSAndy Whitcroft
723c2fdda0dSAndy Whitcroft	my $qlen = 0;
724773647a0SAndy Whitcroft	my $off = 0;
725773647a0SAndy Whitcroft	my $c;
72600df344fSAndy Whitcroft
727773647a0SAndy Whitcroft	# Always copy over the diff marker.
728773647a0SAndy Whitcroft	$res = substr($line, 0, 1);
729773647a0SAndy Whitcroft
730773647a0SAndy Whitcroft	for ($off = 1; $off < length($line); $off++) {
731773647a0SAndy Whitcroft		$c = substr($line, $off, 1);
732773647a0SAndy Whitcroft
733773647a0SAndy Whitcroft		# Comments we are wacking completly including the begin
734773647a0SAndy Whitcroft		# and end, all to $;.
735773647a0SAndy Whitcroft		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
736773647a0SAndy Whitcroft			$sanitise_quote = '*/';
737773647a0SAndy Whitcroft
738773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
739773647a0SAndy Whitcroft			$off++;
74000df344fSAndy Whitcroft			next;
741773647a0SAndy Whitcroft		}
74281bc0e02SAndy Whitcroft		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
743773647a0SAndy Whitcroft			$sanitise_quote = '';
744773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
745773647a0SAndy Whitcroft			$off++;
746773647a0SAndy Whitcroft			next;
747773647a0SAndy Whitcroft		}
748113f04a8SDaniel Walker		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
749113f04a8SDaniel Walker			$sanitise_quote = '//';
750113f04a8SDaniel Walker
751113f04a8SDaniel Walker			substr($res, $off, 2, $sanitise_quote);
752113f04a8SDaniel Walker			$off++;
753113f04a8SDaniel Walker			next;
754113f04a8SDaniel Walker		}
755773647a0SAndy Whitcroft
756773647a0SAndy Whitcroft		# A \ in a string means ignore the next character.
757773647a0SAndy Whitcroft		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
758773647a0SAndy Whitcroft		    $c eq "\\") {
759773647a0SAndy Whitcroft			substr($res, $off, 2, 'XX');
760773647a0SAndy Whitcroft			$off++;
761773647a0SAndy Whitcroft			next;
762773647a0SAndy Whitcroft		}
763773647a0SAndy Whitcroft		# Regular quotes.
764773647a0SAndy Whitcroft		if ($c eq "'" || $c eq '"') {
765773647a0SAndy Whitcroft			if ($sanitise_quote eq '') {
766773647a0SAndy Whitcroft				$sanitise_quote = $c;
767773647a0SAndy Whitcroft
768773647a0SAndy Whitcroft				substr($res, $off, 1, $c);
769773647a0SAndy Whitcroft				next;
770773647a0SAndy Whitcroft			} elsif ($sanitise_quote eq $c) {
771773647a0SAndy Whitcroft				$sanitise_quote = '';
77200df344fSAndy Whitcroft			}
77300df344fSAndy Whitcroft		}
774773647a0SAndy Whitcroft
775fae17daeSAndy Whitcroft		#print "c<$c> SQ<$sanitise_quote>\n";
776773647a0SAndy Whitcroft		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
777773647a0SAndy Whitcroft			substr($res, $off, 1, $;);
778113f04a8SDaniel Walker		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
779113f04a8SDaniel Walker			substr($res, $off, 1, $;);
780773647a0SAndy Whitcroft		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
781773647a0SAndy Whitcroft			substr($res, $off, 1, 'X');
78200df344fSAndy Whitcroft		} else {
783773647a0SAndy Whitcroft			substr($res, $off, 1, $c);
78400df344fSAndy Whitcroft		}
785c2fdda0dSAndy Whitcroft	}
786c2fdda0dSAndy Whitcroft
787113f04a8SDaniel Walker	if ($sanitise_quote eq '//') {
788113f04a8SDaniel Walker		$sanitise_quote = '';
789113f04a8SDaniel Walker	}
790113f04a8SDaniel Walker
791c2fdda0dSAndy Whitcroft	# The pathname on a #include may be surrounded by '<' and '>'.
792c45dcabdSAndy Whitcroft	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
793c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
794c2fdda0dSAndy Whitcroft		$res =~ s@\<.*\>@<$clean>@;
795c2fdda0dSAndy Whitcroft
796c2fdda0dSAndy Whitcroft	# The whole of a #error is a string.
797c45dcabdSAndy Whitcroft	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
798c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
799c45dcabdSAndy Whitcroft		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
800c2fdda0dSAndy Whitcroft	}
801c2fdda0dSAndy Whitcroft
80200df344fSAndy Whitcroft	return $res;
80300df344fSAndy Whitcroft}
80400df344fSAndy Whitcroft
805a6962d72SJoe Perchessub get_quoted_string {
806a6962d72SJoe Perches	my ($line, $rawline) = @_;
807a6962d72SJoe Perches
808a6962d72SJoe Perches	return "" if ($line !~ m/(\"[X]+\")/g);
809a6962d72SJoe Perches	return substr($rawline, $-[0], $+[0] - $-[0]);
810a6962d72SJoe Perches}
811a6962d72SJoe Perches
8128905a67cSAndy Whitcroftsub ctx_statement_block {
8138905a67cSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
8148905a67cSAndy Whitcroft	my $line = $linenr - 1;
8158905a67cSAndy Whitcroft	my $blk = '';
8168905a67cSAndy Whitcroft	my $soff = $off;
8178905a67cSAndy Whitcroft	my $coff = $off - 1;
818773647a0SAndy Whitcroft	my $coff_set = 0;
8198905a67cSAndy Whitcroft
82013214adfSAndy Whitcroft	my $loff = 0;
82113214adfSAndy Whitcroft
8228905a67cSAndy Whitcroft	my $type = '';
8238905a67cSAndy Whitcroft	my $level = 0;
824a2750645SAndy Whitcroft	my @stack = ();
825cf655043SAndy Whitcroft	my $p;
8268905a67cSAndy Whitcroft	my $c;
8278905a67cSAndy Whitcroft	my $len = 0;
82813214adfSAndy Whitcroft
82913214adfSAndy Whitcroft	my $remainder;
8308905a67cSAndy Whitcroft	while (1) {
831a2750645SAndy Whitcroft		@stack = (['', 0]) if ($#stack == -1);
832a2750645SAndy Whitcroft
833773647a0SAndy Whitcroft		#warn "CSB: blk<$blk> remain<$remain>\n";
8348905a67cSAndy Whitcroft		# If we are about to drop off the end, pull in more
8358905a67cSAndy Whitcroft		# context.
8368905a67cSAndy Whitcroft		if ($off >= $len) {
8378905a67cSAndy Whitcroft			for (; $remain > 0; $line++) {
838dea33496SAndy Whitcroft				last if (!defined $lines[$line]);
839c2fdda0dSAndy Whitcroft				next if ($lines[$line] =~ /^-/);
8408905a67cSAndy Whitcroft				$remain--;
84113214adfSAndy Whitcroft				$loff = $len;
842c2fdda0dSAndy Whitcroft				$blk .= $lines[$line] . "\n";
8438905a67cSAndy Whitcroft				$len = length($blk);
8448905a67cSAndy Whitcroft				$line++;
8458905a67cSAndy Whitcroft				last;
8468905a67cSAndy Whitcroft			}
8478905a67cSAndy Whitcroft			# Bail if there is no further context.
8488905a67cSAndy Whitcroft			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
84913214adfSAndy Whitcroft			if ($off >= $len) {
8508905a67cSAndy Whitcroft				last;
8518905a67cSAndy Whitcroft			}
852f74bd194SAndy Whitcroft			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
853f74bd194SAndy Whitcroft				$level++;
854f74bd194SAndy Whitcroft				$type = '#';
855f74bd194SAndy Whitcroft			}
8568905a67cSAndy Whitcroft		}
857cf655043SAndy Whitcroft		$p = $c;
8588905a67cSAndy Whitcroft		$c = substr($blk, $off, 1);
85913214adfSAndy Whitcroft		$remainder = substr($blk, $off);
8608905a67cSAndy Whitcroft
861773647a0SAndy Whitcroft		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
8624635f4fbSAndy Whitcroft
8634635f4fbSAndy Whitcroft		# Handle nested #if/#else.
8644635f4fbSAndy Whitcroft		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
8654635f4fbSAndy Whitcroft			push(@stack, [ $type, $level ]);
8664635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
8674635f4fbSAndy Whitcroft			($type, $level) = @{$stack[$#stack - 1]};
8684635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*endif\b/) {
8694635f4fbSAndy Whitcroft			($type, $level) = @{pop(@stack)};
8704635f4fbSAndy Whitcroft		}
8714635f4fbSAndy Whitcroft
8728905a67cSAndy Whitcroft		# Statement ends at the ';' or a close '}' at the
8738905a67cSAndy Whitcroft		# outermost level.
8748905a67cSAndy Whitcroft		if ($level == 0 && $c eq ';') {
8758905a67cSAndy Whitcroft			last;
8768905a67cSAndy Whitcroft		}
8778905a67cSAndy Whitcroft
87813214adfSAndy Whitcroft		# An else is really a conditional as long as its not else if
879773647a0SAndy Whitcroft		if ($level == 0 && $coff_set == 0 &&
880773647a0SAndy Whitcroft				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
881773647a0SAndy Whitcroft				$remainder =~ /^(else)(?:\s|{)/ &&
882773647a0SAndy Whitcroft				$remainder !~ /^else\s+if\b/) {
883773647a0SAndy Whitcroft			$coff = $off + length($1) - 1;
884773647a0SAndy Whitcroft			$coff_set = 1;
885773647a0SAndy Whitcroft			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
886773647a0SAndy Whitcroft			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
88713214adfSAndy Whitcroft		}
88813214adfSAndy Whitcroft
8898905a67cSAndy Whitcroft		if (($type eq '' || $type eq '(') && $c eq '(') {
8908905a67cSAndy Whitcroft			$level++;
8918905a67cSAndy Whitcroft			$type = '(';
8928905a67cSAndy Whitcroft		}
8938905a67cSAndy Whitcroft		if ($type eq '(' && $c eq ')') {
8948905a67cSAndy Whitcroft			$level--;
8958905a67cSAndy Whitcroft			$type = ($level != 0)? '(' : '';
8968905a67cSAndy Whitcroft
8978905a67cSAndy Whitcroft			if ($level == 0 && $coff < $soff) {
8988905a67cSAndy Whitcroft				$coff = $off;
899773647a0SAndy Whitcroft				$coff_set = 1;
900773647a0SAndy Whitcroft				#warn "CSB: mark coff<$coff>\n";
9018905a67cSAndy Whitcroft			}
9028905a67cSAndy Whitcroft		}
9038905a67cSAndy Whitcroft		if (($type eq '' || $type eq '{') && $c eq '{') {
9048905a67cSAndy Whitcroft			$level++;
9058905a67cSAndy Whitcroft			$type = '{';
9068905a67cSAndy Whitcroft		}
9078905a67cSAndy Whitcroft		if ($type eq '{' && $c eq '}') {
9088905a67cSAndy Whitcroft			$level--;
9098905a67cSAndy Whitcroft			$type = ($level != 0)? '{' : '';
9108905a67cSAndy Whitcroft
9118905a67cSAndy Whitcroft			if ($level == 0) {
912b998e001SPatrick Pannuto				if (substr($blk, $off + 1, 1) eq ';') {
913b998e001SPatrick Pannuto					$off++;
914b998e001SPatrick Pannuto				}
9158905a67cSAndy Whitcroft				last;
9168905a67cSAndy Whitcroft			}
9178905a67cSAndy Whitcroft		}
918f74bd194SAndy Whitcroft		# Preprocessor commands end at the newline unless escaped.
919f74bd194SAndy Whitcroft		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
920f74bd194SAndy Whitcroft			$level--;
921f74bd194SAndy Whitcroft			$type = '';
922f74bd194SAndy Whitcroft			$off++;
923f74bd194SAndy Whitcroft			last;
924f74bd194SAndy Whitcroft		}
9258905a67cSAndy Whitcroft		$off++;
9268905a67cSAndy Whitcroft	}
927a3bb97a7SAndy Whitcroft	# We are truly at the end, so shuffle to the next line.
92813214adfSAndy Whitcroft	if ($off == $len) {
929a3bb97a7SAndy Whitcroft		$loff = $len + 1;
93013214adfSAndy Whitcroft		$line++;
93113214adfSAndy Whitcroft		$remain--;
93213214adfSAndy Whitcroft	}
9338905a67cSAndy Whitcroft
9348905a67cSAndy Whitcroft	my $statement = substr($blk, $soff, $off - $soff + 1);
9358905a67cSAndy Whitcroft	my $condition = substr($blk, $soff, $coff - $soff + 1);
9368905a67cSAndy Whitcroft
9378905a67cSAndy Whitcroft	#warn "STATEMENT<$statement>\n";
9388905a67cSAndy Whitcroft	#warn "CONDITION<$condition>\n";
9398905a67cSAndy Whitcroft
940773647a0SAndy Whitcroft	#print "coff<$coff> soff<$off> loff<$loff>\n";
94113214adfSAndy Whitcroft
94213214adfSAndy Whitcroft	return ($statement, $condition,
94313214adfSAndy Whitcroft			$line, $remain + 1, $off - $loff + 1, $level);
94413214adfSAndy Whitcroft}
94513214adfSAndy Whitcroft
946cf655043SAndy Whitcroftsub statement_lines {
947cf655043SAndy Whitcroft	my ($stmt) = @_;
948cf655043SAndy Whitcroft
949cf655043SAndy Whitcroft	# Strip the diff line prefixes and rip blank lines at start and end.
950cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
951cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
952cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
953cf655043SAndy Whitcroft
954cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
955cf655043SAndy Whitcroft
956cf655043SAndy Whitcroft	return $#stmt_lines + 2;
957cf655043SAndy Whitcroft}
958cf655043SAndy Whitcroft
959cf655043SAndy Whitcroftsub statement_rawlines {
960cf655043SAndy Whitcroft	my ($stmt) = @_;
961cf655043SAndy Whitcroft
962cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
963cf655043SAndy Whitcroft
964cf655043SAndy Whitcroft	return $#stmt_lines + 2;
965cf655043SAndy Whitcroft}
966cf655043SAndy Whitcroft
967cf655043SAndy Whitcroftsub statement_block_size {
968cf655043SAndy Whitcroft	my ($stmt) = @_;
969cf655043SAndy Whitcroft
970cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
971cf655043SAndy Whitcroft	$stmt =~ s/^\s*{//;
972cf655043SAndy Whitcroft	$stmt =~ s/}\s*$//;
973cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
974cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
975cf655043SAndy Whitcroft
976cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
977cf655043SAndy Whitcroft	my @stmt_statements = ($stmt =~ /;/g);
978cf655043SAndy Whitcroft
979cf655043SAndy Whitcroft	my $stmt_lines = $#stmt_lines + 2;
980cf655043SAndy Whitcroft	my $stmt_statements = $#stmt_statements + 1;
981cf655043SAndy Whitcroft
982cf655043SAndy Whitcroft	if ($stmt_lines > $stmt_statements) {
983cf655043SAndy Whitcroft		return $stmt_lines;
984cf655043SAndy Whitcroft	} else {
985cf655043SAndy Whitcroft		return $stmt_statements;
986cf655043SAndy Whitcroft	}
987cf655043SAndy Whitcroft}
988cf655043SAndy Whitcroft
98913214adfSAndy Whitcroftsub ctx_statement_full {
99013214adfSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
99113214adfSAndy Whitcroft	my ($statement, $condition, $level);
99213214adfSAndy Whitcroft
99313214adfSAndy Whitcroft	my (@chunks);
99413214adfSAndy Whitcroft
995cf655043SAndy Whitcroft	# Grab the first conditional/block pair.
99613214adfSAndy Whitcroft	($statement, $condition, $linenr, $remain, $off, $level) =
99713214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
998773647a0SAndy Whitcroft	#print "F: c<$condition> s<$statement> remain<$remain>\n";
99913214adfSAndy Whitcroft	push(@chunks, [ $condition, $statement ]);
1000cf655043SAndy Whitcroft	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1001cf655043SAndy Whitcroft		return ($level, $linenr, @chunks);
1002cf655043SAndy Whitcroft	}
1003cf655043SAndy Whitcroft
1004cf655043SAndy Whitcroft	# Pull in the following conditional/block pairs and see if they
1005cf655043SAndy Whitcroft	# could continue the statement.
1006cf655043SAndy Whitcroft	for (;;) {
100713214adfSAndy Whitcroft		($statement, $condition, $linenr, $remain, $off, $level) =
100813214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
1009cf655043SAndy Whitcroft		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1010773647a0SAndy Whitcroft		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1011cf655043SAndy Whitcroft		#print "C: push\n";
1012cf655043SAndy Whitcroft		push(@chunks, [ $condition, $statement ]);
101313214adfSAndy Whitcroft	}
101413214adfSAndy Whitcroft
101513214adfSAndy Whitcroft	return ($level, $linenr, @chunks);
10168905a67cSAndy Whitcroft}
10178905a67cSAndy Whitcroft
10184a0df2efSAndy Whitcroftsub ctx_block_get {
1019f0a594c1SAndy Whitcroft	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
10204a0df2efSAndy Whitcroft	my $line;
10214a0df2efSAndy Whitcroft	my $start = $linenr - 1;
10224a0df2efSAndy Whitcroft	my $blk = '';
10234a0df2efSAndy Whitcroft	my @o;
10244a0df2efSAndy Whitcroft	my @c;
10254a0df2efSAndy Whitcroft	my @res = ();
10264a0df2efSAndy Whitcroft
1027f0a594c1SAndy Whitcroft	my $level = 0;
10284635f4fbSAndy Whitcroft	my @stack = ($level);
102900df344fSAndy Whitcroft	for ($line = $start; $remain > 0; $line++) {
103000df344fSAndy Whitcroft		next if ($rawlines[$line] =~ /^-/);
103100df344fSAndy Whitcroft		$remain--;
103200df344fSAndy Whitcroft
103300df344fSAndy Whitcroft		$blk .= $rawlines[$line];
10344635f4fbSAndy Whitcroft
10354635f4fbSAndy Whitcroft		# Handle nested #if/#else.
103601464f30SAndy Whitcroft		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
10374635f4fbSAndy Whitcroft			push(@stack, $level);
103801464f30SAndy Whitcroft		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
10394635f4fbSAndy Whitcroft			$level = $stack[$#stack - 1];
104001464f30SAndy Whitcroft		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
10414635f4fbSAndy Whitcroft			$level = pop(@stack);
10424635f4fbSAndy Whitcroft		}
10434635f4fbSAndy Whitcroft
104401464f30SAndy Whitcroft		foreach my $c (split(//, $lines[$line])) {
1045f0a594c1SAndy Whitcroft			##print "C<$c>L<$level><$open$close>O<$off>\n";
1046f0a594c1SAndy Whitcroft			if ($off > 0) {
1047f0a594c1SAndy Whitcroft				$off--;
1048f0a594c1SAndy Whitcroft				next;
1049f0a594c1SAndy Whitcroft			}
10504a0df2efSAndy Whitcroft
1051f0a594c1SAndy Whitcroft			if ($c eq $close && $level > 0) {
1052f0a594c1SAndy Whitcroft				$level--;
1053f0a594c1SAndy Whitcroft				last if ($level == 0);
1054f0a594c1SAndy Whitcroft			} elsif ($c eq $open) {
1055f0a594c1SAndy Whitcroft				$level++;
1056f0a594c1SAndy Whitcroft			}
1057f0a594c1SAndy Whitcroft		}
10584a0df2efSAndy Whitcroft
1059f0a594c1SAndy Whitcroft		if (!$outer || $level <= 1) {
106000df344fSAndy Whitcroft			push(@res, $rawlines[$line]);
10614a0df2efSAndy Whitcroft		}
10624a0df2efSAndy Whitcroft
1063f0a594c1SAndy Whitcroft		last if ($level == 0);
10644a0df2efSAndy Whitcroft	}
10654a0df2efSAndy Whitcroft
1066f0a594c1SAndy Whitcroft	return ($level, @res);
10674a0df2efSAndy Whitcroft}
10684a0df2efSAndy Whitcroftsub ctx_block_outer {
10694a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
10704a0df2efSAndy Whitcroft
1071f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1072f0a594c1SAndy Whitcroft	return @r;
10734a0df2efSAndy Whitcroft}
10744a0df2efSAndy Whitcroftsub ctx_block {
10754a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
10764a0df2efSAndy Whitcroft
1077f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1078f0a594c1SAndy Whitcroft	return @r;
1079653d4876SAndy Whitcroft}
1080653d4876SAndy Whitcroftsub ctx_statement {
1081f0a594c1SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
1082f0a594c1SAndy Whitcroft
1083f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1084f0a594c1SAndy Whitcroft	return @r;
1085f0a594c1SAndy Whitcroft}
1086f0a594c1SAndy Whitcroftsub ctx_block_level {
1087653d4876SAndy Whitcroft	my ($linenr, $remain) = @_;
1088653d4876SAndy Whitcroft
1089f0a594c1SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
10904a0df2efSAndy Whitcroft}
10919c0ca6f9SAndy Whitcroftsub ctx_statement_level {
10929c0ca6f9SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
10939c0ca6f9SAndy Whitcroft
10949c0ca6f9SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
10959c0ca6f9SAndy Whitcroft}
10964a0df2efSAndy Whitcroft
10974a0df2efSAndy Whitcroftsub ctx_locate_comment {
10984a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
10994a0df2efSAndy Whitcroft
11004a0df2efSAndy Whitcroft	# Catch a comment on the end of the line itself.
1101beae6332SAndy Whitcroft	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
11024a0df2efSAndy Whitcroft	return $current_comment if (defined $current_comment);
11034a0df2efSAndy Whitcroft
11044a0df2efSAndy Whitcroft	# Look through the context and try and figure out if there is a
11054a0df2efSAndy Whitcroft	# comment.
11064a0df2efSAndy Whitcroft	my $in_comment = 0;
11074a0df2efSAndy Whitcroft	$current_comment = '';
11084a0df2efSAndy Whitcroft	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
110900df344fSAndy Whitcroft		my $line = $rawlines[$linenr - 1];
111000df344fSAndy Whitcroft		#warn "           $line\n";
11114a0df2efSAndy Whitcroft		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
11124a0df2efSAndy Whitcroft			$in_comment = 1;
11134a0df2efSAndy Whitcroft		}
11144a0df2efSAndy Whitcroft		if ($line =~ m@/\*@) {
11154a0df2efSAndy Whitcroft			$in_comment = 1;
11164a0df2efSAndy Whitcroft		}
11174a0df2efSAndy Whitcroft		if (!$in_comment && $current_comment ne '') {
11184a0df2efSAndy Whitcroft			$current_comment = '';
11194a0df2efSAndy Whitcroft		}
11204a0df2efSAndy Whitcroft		$current_comment .= $line . "\n" if ($in_comment);
11214a0df2efSAndy Whitcroft		if ($line =~ m@\*/@) {
11224a0df2efSAndy Whitcroft			$in_comment = 0;
11234a0df2efSAndy Whitcroft		}
11244a0df2efSAndy Whitcroft	}
11254a0df2efSAndy Whitcroft
11264a0df2efSAndy Whitcroft	chomp($current_comment);
11274a0df2efSAndy Whitcroft	return($current_comment);
11284a0df2efSAndy Whitcroft}
11294a0df2efSAndy Whitcroftsub ctx_has_comment {
11304a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
11314a0df2efSAndy Whitcroft	my $cmt = ctx_locate_comment($first_line, $end_line);
11324a0df2efSAndy Whitcroft
113300df344fSAndy Whitcroft	##print "LINE: $rawlines[$end_line - 1 ]\n";
11344a0df2efSAndy Whitcroft	##print "CMMT: $cmt\n";
11354a0df2efSAndy Whitcroft
11364a0df2efSAndy Whitcroft	return ($cmt ne '');
11374a0df2efSAndy Whitcroft}
11384a0df2efSAndy Whitcroft
11394d001e4dSAndy Whitcroftsub raw_line {
11404d001e4dSAndy Whitcroft	my ($linenr, $cnt) = @_;
11414d001e4dSAndy Whitcroft
11424d001e4dSAndy Whitcroft	my $offset = $linenr - 1;
11434d001e4dSAndy Whitcroft	$cnt++;
11444d001e4dSAndy Whitcroft
11454d001e4dSAndy Whitcroft	my $line;
11464d001e4dSAndy Whitcroft	while ($cnt) {
11474d001e4dSAndy Whitcroft		$line = $rawlines[$offset++];
11484d001e4dSAndy Whitcroft		next if (defined($line) && $line =~ /^-/);
11494d001e4dSAndy Whitcroft		$cnt--;
11504d001e4dSAndy Whitcroft	}
11514d001e4dSAndy Whitcroft
11524d001e4dSAndy Whitcroft	return $line;
11534d001e4dSAndy Whitcroft}
11544d001e4dSAndy Whitcroft
11550a920b5bSAndy Whitcroftsub cat_vet {
11560a920b5bSAndy Whitcroft	my ($vet) = @_;
11579c0ca6f9SAndy Whitcroft	my ($res, $coded);
11580a920b5bSAndy Whitcroft
11599c0ca6f9SAndy Whitcroft	$res = '';
11606c72ffaaSAndy Whitcroft	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
11616c72ffaaSAndy Whitcroft		$res .= $1;
11626c72ffaaSAndy Whitcroft		if ($2 ne '') {
11639c0ca6f9SAndy Whitcroft			$coded = sprintf("^%c", unpack('C', $2) + 64);
11646c72ffaaSAndy Whitcroft			$res .= $coded;
11656c72ffaaSAndy Whitcroft		}
11669c0ca6f9SAndy Whitcroft	}
11679c0ca6f9SAndy Whitcroft	$res =~ s/$/\$/;
11680a920b5bSAndy Whitcroft
11699c0ca6f9SAndy Whitcroft	return $res;
11700a920b5bSAndy Whitcroft}
11710a920b5bSAndy Whitcroft
1172c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0;
1173cf655043SAndy Whitcroftmy $av_pending;
1174c2fdda0dSAndy Whitcroftmy @av_paren_type;
11751f65f947SAndy Whitcroftmy $av_pend_colon;
1176c2fdda0dSAndy Whitcroft
1177c2fdda0dSAndy Whitcroftsub annotate_reset {
1178c2fdda0dSAndy Whitcroft	$av_preprocessor = 0;
1179cf655043SAndy Whitcroft	$av_pending = '_';
1180cf655043SAndy Whitcroft	@av_paren_type = ('E');
11811f65f947SAndy Whitcroft	$av_pend_colon = 'O';
1182c2fdda0dSAndy Whitcroft}
1183c2fdda0dSAndy Whitcroft
11846c72ffaaSAndy Whitcroftsub annotate_values {
11856c72ffaaSAndy Whitcroft	my ($stream, $type) = @_;
11866c72ffaaSAndy Whitcroft
11876c72ffaaSAndy Whitcroft	my $res;
11881f65f947SAndy Whitcroft	my $var = '_' x length($stream);
11896c72ffaaSAndy Whitcroft	my $cur = $stream;
11906c72ffaaSAndy Whitcroft
1191c2fdda0dSAndy Whitcroft	print "$stream\n" if ($dbg_values > 1);
11926c72ffaaSAndy Whitcroft
11936c72ffaaSAndy Whitcroft	while (length($cur)) {
1194773647a0SAndy Whitcroft		@av_paren_type = ('E') if ($#av_paren_type < 0);
1195cf655043SAndy Whitcroft		print " <" . join('', @av_paren_type) .
1196171ae1a4SAndy Whitcroft				"> <$type> <$av_pending>" if ($dbg_values > 1);
11976c72ffaaSAndy Whitcroft		if ($cur =~ /^(\s+)/o) {
1198c2fdda0dSAndy Whitcroft			print "WS($1)\n" if ($dbg_values > 1);
1199c2fdda0dSAndy Whitcroft			if ($1 =~ /\n/ && $av_preprocessor) {
1200cf655043SAndy Whitcroft				$type = pop(@av_paren_type);
1201c2fdda0dSAndy Whitcroft				$av_preprocessor = 0;
12026c72ffaaSAndy Whitcroft			}
12036c72ffaaSAndy Whitcroft
1204c023e473SFlorian Mickler		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
12059446ef56SAndy Whitcroft			print "CAST($1)\n" if ($dbg_values > 1);
12069446ef56SAndy Whitcroft			push(@av_paren_type, $type);
1207addcdceaSAndy Whitcroft			$type = 'c';
12089446ef56SAndy Whitcroft
1209e91b6e26SAndy Whitcroft		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1210c2fdda0dSAndy Whitcroft			print "DECLARE($1)\n" if ($dbg_values > 1);
12116c72ffaaSAndy Whitcroft			$type = 'T';
12126c72ffaaSAndy Whitcroft
1213389a2fe5SAndy Whitcroft		} elsif ($cur =~ /^($Modifier)\s*/) {
1214389a2fe5SAndy Whitcroft			print "MODIFIER($1)\n" if ($dbg_values > 1);
1215389a2fe5SAndy Whitcroft			$type = 'T';
1216389a2fe5SAndy Whitcroft
1217c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1218171ae1a4SAndy Whitcroft			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1219c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
1220171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
1221171ae1a4SAndy Whitcroft			if ($2 ne '') {
1222cf655043SAndy Whitcroft				$av_pending = 'N';
1223171ae1a4SAndy Whitcroft			}
1224171ae1a4SAndy Whitcroft			$type = 'E';
1225171ae1a4SAndy Whitcroft
1226c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1227171ae1a4SAndy Whitcroft			print "UNDEF($1)\n" if ($dbg_values > 1);
1228171ae1a4SAndy Whitcroft			$av_preprocessor = 1;
1229171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
12306c72ffaaSAndy Whitcroft
1231c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1232cf655043SAndy Whitcroft			print "PRE_START($1)\n" if ($dbg_values > 1);
1233c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
1234cf655043SAndy Whitcroft
1235cf655043SAndy Whitcroft			push(@av_paren_type, $type);
1236cf655043SAndy Whitcroft			push(@av_paren_type, $type);
1237171ae1a4SAndy Whitcroft			$type = 'E';
1238cf655043SAndy Whitcroft
1239c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1240cf655043SAndy Whitcroft			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1241cf655043SAndy Whitcroft			$av_preprocessor = 1;
1242cf655043SAndy Whitcroft
1243cf655043SAndy Whitcroft			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1244cf655043SAndy Whitcroft
1245171ae1a4SAndy Whitcroft			$type = 'E';
1246cf655043SAndy Whitcroft
1247c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1248cf655043SAndy Whitcroft			print "PRE_END($1)\n" if ($dbg_values > 1);
1249cf655043SAndy Whitcroft
1250cf655043SAndy Whitcroft			$av_preprocessor = 1;
1251cf655043SAndy Whitcroft
1252cf655043SAndy Whitcroft			# Assume all arms of the conditional end as this
1253cf655043SAndy Whitcroft			# one does, and continue as if the #endif was not here.
1254cf655043SAndy Whitcroft			pop(@av_paren_type);
1255cf655043SAndy Whitcroft			push(@av_paren_type, $type);
1256171ae1a4SAndy Whitcroft			$type = 'E';
12576c72ffaaSAndy Whitcroft
12586c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\\\n)/o) {
1259c2fdda0dSAndy Whitcroft			print "PRECONT($1)\n" if ($dbg_values > 1);
12606c72ffaaSAndy Whitcroft
1261171ae1a4SAndy Whitcroft		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1262171ae1a4SAndy Whitcroft			print "ATTR($1)\n" if ($dbg_values > 1);
1263171ae1a4SAndy Whitcroft			$av_pending = $type;
1264171ae1a4SAndy Whitcroft			$type = 'N';
1265171ae1a4SAndy Whitcroft
12666c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1267c2fdda0dSAndy Whitcroft			print "SIZEOF($1)\n" if ($dbg_values > 1);
12686c72ffaaSAndy Whitcroft			if (defined $2) {
1269cf655043SAndy Whitcroft				$av_pending = 'V';
12706c72ffaaSAndy Whitcroft			}
12716c72ffaaSAndy Whitcroft			$type = 'N';
12726c72ffaaSAndy Whitcroft
127314b111c1SAndy Whitcroft		} elsif ($cur =~ /^(if|while|for)\b/o) {
1274c2fdda0dSAndy Whitcroft			print "COND($1)\n" if ($dbg_values > 1);
127514b111c1SAndy Whitcroft			$av_pending = 'E';
12766c72ffaaSAndy Whitcroft			$type = 'N';
12776c72ffaaSAndy Whitcroft
12781f65f947SAndy Whitcroft		} elsif ($cur =~/^(case)/o) {
12791f65f947SAndy Whitcroft			print "CASE($1)\n" if ($dbg_values > 1);
12801f65f947SAndy Whitcroft			$av_pend_colon = 'C';
12811f65f947SAndy Whitcroft			$type = 'N';
12821f65f947SAndy Whitcroft
128314b111c1SAndy Whitcroft		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1284c2fdda0dSAndy Whitcroft			print "KEYWORD($1)\n" if ($dbg_values > 1);
12856c72ffaaSAndy Whitcroft			$type = 'N';
12866c72ffaaSAndy Whitcroft
12876c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\()/o) {
1288c2fdda0dSAndy Whitcroft			print "PAREN('$1')\n" if ($dbg_values > 1);
1289cf655043SAndy Whitcroft			push(@av_paren_type, $av_pending);
1290cf655043SAndy Whitcroft			$av_pending = '_';
12916c72ffaaSAndy Whitcroft			$type = 'N';
12926c72ffaaSAndy Whitcroft
12936c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\))/o) {
1294cf655043SAndy Whitcroft			my $new_type = pop(@av_paren_type);
1295cf655043SAndy Whitcroft			if ($new_type ne '_') {
1296cf655043SAndy Whitcroft				$type = $new_type;
1297c2fdda0dSAndy Whitcroft				print "PAREN('$1') -> $type\n"
1298c2fdda0dSAndy Whitcroft							if ($dbg_values > 1);
12996c72ffaaSAndy Whitcroft			} else {
1300c2fdda0dSAndy Whitcroft				print "PAREN('$1')\n" if ($dbg_values > 1);
13016c72ffaaSAndy Whitcroft			}
13026c72ffaaSAndy Whitcroft
1303c8cb2ca3SAndy Whitcroft		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1304c2fdda0dSAndy Whitcroft			print "FUNC($1)\n" if ($dbg_values > 1);
1305c8cb2ca3SAndy Whitcroft			$type = 'V';
1306cf655043SAndy Whitcroft			$av_pending = 'V';
13076c72ffaaSAndy Whitcroft
13088e761b04SAndy Whitcroft		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
13098e761b04SAndy Whitcroft			if (defined $2 && $type eq 'C' || $type eq 'T') {
13101f65f947SAndy Whitcroft				$av_pend_colon = 'B';
13118e761b04SAndy Whitcroft			} elsif ($type eq 'E') {
13128e761b04SAndy Whitcroft				$av_pend_colon = 'L';
13131f65f947SAndy Whitcroft			}
13141f65f947SAndy Whitcroft			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
13151f65f947SAndy Whitcroft			$type = 'V';
13161f65f947SAndy Whitcroft
13176c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1318c2fdda0dSAndy Whitcroft			print "IDENT($1)\n" if ($dbg_values > 1);
13196c72ffaaSAndy Whitcroft			$type = 'V';
13206c72ffaaSAndy Whitcroft
13216c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Assignment)/o) {
1322c2fdda0dSAndy Whitcroft			print "ASSIGN($1)\n" if ($dbg_values > 1);
13236c72ffaaSAndy Whitcroft			$type = 'N';
13246c72ffaaSAndy Whitcroft
1325cf655043SAndy Whitcroft		} elsif ($cur =~/^(;|{|})/) {
1326c2fdda0dSAndy Whitcroft			print "END($1)\n" if ($dbg_values > 1);
132713214adfSAndy Whitcroft			$type = 'E';
13281f65f947SAndy Whitcroft			$av_pend_colon = 'O';
132913214adfSAndy Whitcroft
13308e761b04SAndy Whitcroft		} elsif ($cur =~/^(,)/) {
13318e761b04SAndy Whitcroft			print "COMMA($1)\n" if ($dbg_values > 1);
13328e761b04SAndy Whitcroft			$type = 'C';
13338e761b04SAndy Whitcroft
13341f65f947SAndy Whitcroft		} elsif ($cur =~ /^(\?)/o) {
13351f65f947SAndy Whitcroft			print "QUESTION($1)\n" if ($dbg_values > 1);
13361f65f947SAndy Whitcroft			$type = 'N';
13371f65f947SAndy Whitcroft
13381f65f947SAndy Whitcroft		} elsif ($cur =~ /^(:)/o) {
13391f65f947SAndy Whitcroft			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
13401f65f947SAndy Whitcroft
13411f65f947SAndy Whitcroft			substr($var, length($res), 1, $av_pend_colon);
13421f65f947SAndy Whitcroft			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
13431f65f947SAndy Whitcroft				$type = 'E';
13441f65f947SAndy Whitcroft			} else {
13451f65f947SAndy Whitcroft				$type = 'N';
13461f65f947SAndy Whitcroft			}
13471f65f947SAndy Whitcroft			$av_pend_colon = 'O';
13481f65f947SAndy Whitcroft
13498e761b04SAndy Whitcroft		} elsif ($cur =~ /^(\[)/o) {
135013214adfSAndy Whitcroft			print "CLOSE($1)\n" if ($dbg_values > 1);
13516c72ffaaSAndy Whitcroft			$type = 'N';
13526c72ffaaSAndy Whitcroft
13530d413866SAndy Whitcroft		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
135474048ed8SAndy Whitcroft			my $variant;
135574048ed8SAndy Whitcroft
135674048ed8SAndy Whitcroft			print "OPV($1)\n" if ($dbg_values > 1);
135774048ed8SAndy Whitcroft			if ($type eq 'V') {
135874048ed8SAndy Whitcroft				$variant = 'B';
135974048ed8SAndy Whitcroft			} else {
136074048ed8SAndy Whitcroft				$variant = 'U';
136174048ed8SAndy Whitcroft			}
136274048ed8SAndy Whitcroft
136374048ed8SAndy Whitcroft			substr($var, length($res), 1, $variant);
136474048ed8SAndy Whitcroft			$type = 'N';
136574048ed8SAndy Whitcroft
13666c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Operators)/o) {
1367c2fdda0dSAndy Whitcroft			print "OP($1)\n" if ($dbg_values > 1);
13686c72ffaaSAndy Whitcroft			if ($1 ne '++' && $1 ne '--') {
13696c72ffaaSAndy Whitcroft				$type = 'N';
13706c72ffaaSAndy Whitcroft			}
13716c72ffaaSAndy Whitcroft
13726c72ffaaSAndy Whitcroft		} elsif ($cur =~ /(^.)/o) {
1373c2fdda0dSAndy Whitcroft			print "C($1)\n" if ($dbg_values > 1);
13746c72ffaaSAndy Whitcroft		}
13756c72ffaaSAndy Whitcroft		if (defined $1) {
13766c72ffaaSAndy Whitcroft			$cur = substr($cur, length($1));
13776c72ffaaSAndy Whitcroft			$res .= $type x length($1);
13786c72ffaaSAndy Whitcroft		}
13796c72ffaaSAndy Whitcroft	}
13806c72ffaaSAndy Whitcroft
13811f65f947SAndy Whitcroft	return ($res, $var);
13826c72ffaaSAndy Whitcroft}
13836c72ffaaSAndy Whitcroft
13848905a67cSAndy Whitcroftsub possible {
138513214adfSAndy Whitcroft	my ($possible, $line) = @_;
13869a974fdbSAndy Whitcroft	my $notPermitted = qr{(?:
13870776e594SAndy Whitcroft		^(?:
13880776e594SAndy Whitcroft			$Modifier|
13890776e594SAndy Whitcroft			$Storage|
13900776e594SAndy Whitcroft			$Type|
13919a974fdbSAndy Whitcroft			DEFINE_\S+
13929a974fdbSAndy Whitcroft		)$|
13939a974fdbSAndy Whitcroft		^(?:
13940776e594SAndy Whitcroft			goto|
13950776e594SAndy Whitcroft			return|
13960776e594SAndy Whitcroft			case|
13970776e594SAndy Whitcroft			else|
13980776e594SAndy Whitcroft			asm|__asm__|
139989a88353SAndy Whitcroft			do|
140089a88353SAndy Whitcroft			\#|
140189a88353SAndy Whitcroft			\#\#|
14029a974fdbSAndy Whitcroft		)(?:\s|$)|
14030776e594SAndy Whitcroft		^(?:typedef|struct|enum)\b
14049a974fdbSAndy Whitcroft	    )}x;
14059a974fdbSAndy Whitcroft	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
14069a974fdbSAndy Whitcroft	if ($possible !~ $notPermitted) {
1407c45dcabdSAndy Whitcroft		# Check for modifiers.
1408c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Storage\s*//g;
1409c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Sparse\s*//g;
1410c45dcabdSAndy Whitcroft		if ($possible =~ /^\s*$/) {
1411c45dcabdSAndy Whitcroft
1412c45dcabdSAndy Whitcroft		} elsif ($possible =~ /\s/) {
1413c45dcabdSAndy Whitcroft			$possible =~ s/\s*$Type\s*//g;
1414d2506586SAndy Whitcroft			for my $modifier (split(' ', $possible)) {
14159a974fdbSAndy Whitcroft				if ($modifier !~ $notPermitted) {
1416d2506586SAndy Whitcroft					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1417d2506586SAndy Whitcroft					push(@modifierList, $modifier);
1418d2506586SAndy Whitcroft				}
14199a974fdbSAndy Whitcroft			}
1420c45dcabdSAndy Whitcroft
1421c45dcabdSAndy Whitcroft		} else {
142213214adfSAndy Whitcroft			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
14238905a67cSAndy Whitcroft			push(@typeList, $possible);
1424c45dcabdSAndy Whitcroft		}
14258905a67cSAndy Whitcroft		build_types();
14260776e594SAndy Whitcroft	} else {
14270776e594SAndy Whitcroft		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
14288905a67cSAndy Whitcroft	}
14298905a67cSAndy Whitcroft}
14308905a67cSAndy Whitcroft
14316c72ffaaSAndy Whitcroftmy $prefix = '';
14326c72ffaaSAndy Whitcroft
1433000d1cc1SJoe Perchessub show_type {
1434*cbec18afSJoe Perches	my ($type) = @_;
143591bfe484SJoe Perches
1436*cbec18afSJoe Perches	return defined $use_type{$type} if (scalar keys %use_type > 0);
1437*cbec18afSJoe Perches
1438*cbec18afSJoe Perches	return !defined $ignore_type{$type};
1439000d1cc1SJoe Perches}
1440000d1cc1SJoe Perches
1441f0a594c1SAndy Whitcroftsub report {
1442*cbec18afSJoe Perches	my ($level, $type, $msg) = @_;
1443*cbec18afSJoe Perches
1444*cbec18afSJoe Perches	if (!show_type($type) ||
1445*cbec18afSJoe Perches	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1446773647a0SAndy Whitcroft		return 0;
1447773647a0SAndy Whitcroft	}
1448000d1cc1SJoe Perches	my $line;
1449000d1cc1SJoe Perches	if ($show_types) {
1450*cbec18afSJoe Perches		$line = "$prefix$level:$type: $msg\n";
1451000d1cc1SJoe Perches	} else {
1452*cbec18afSJoe Perches		$line = "$prefix$level: $msg\n";
1453000d1cc1SJoe Perches	}
14548905a67cSAndy Whitcroft	$line = (split('\n', $line))[0] . "\n" if ($terse);
14558905a67cSAndy Whitcroft
145613214adfSAndy Whitcroft	push(our @report, $line);
1457773647a0SAndy Whitcroft
1458773647a0SAndy Whitcroft	return 1;
1459f0a594c1SAndy Whitcroft}
1460*cbec18afSJoe Perches
1461f0a594c1SAndy Whitcroftsub report_dump {
146213214adfSAndy Whitcroft	our @report;
1463f0a594c1SAndy Whitcroft}
1464000d1cc1SJoe Perches
1465de7d4f0eSAndy Whitcroftsub ERROR {
1466*cbec18afSJoe Perches	my ($type, $msg) = @_;
1467*cbec18afSJoe Perches
1468*cbec18afSJoe Perches	if (report("ERROR", $type, $msg)) {
1469de7d4f0eSAndy Whitcroft		our $clean = 0;
14706c72ffaaSAndy Whitcroft		our $cnt_error++;
14713705ce5bSJoe Perches		return 1;
1472de7d4f0eSAndy Whitcroft	}
14733705ce5bSJoe Perches	return 0;
1474773647a0SAndy Whitcroft}
1475de7d4f0eSAndy Whitcroftsub WARN {
1476*cbec18afSJoe Perches	my ($type, $msg) = @_;
1477*cbec18afSJoe Perches
1478*cbec18afSJoe Perches	if (report("WARNING", $type, $msg)) {
1479de7d4f0eSAndy Whitcroft		our $clean = 0;
14806c72ffaaSAndy Whitcroft		our $cnt_warn++;
14813705ce5bSJoe Perches		return 1;
1482de7d4f0eSAndy Whitcroft	}
14833705ce5bSJoe Perches	return 0;
1484773647a0SAndy Whitcroft}
1485de7d4f0eSAndy Whitcroftsub CHK {
1486*cbec18afSJoe Perches	my ($type, $msg) = @_;
1487*cbec18afSJoe Perches
1488*cbec18afSJoe Perches	if ($check && report("CHECK", $type, $msg)) {
1489de7d4f0eSAndy Whitcroft		our $clean = 0;
14906c72ffaaSAndy Whitcroft		our $cnt_chk++;
14913705ce5bSJoe Perches		return 1;
14926c72ffaaSAndy Whitcroft	}
14933705ce5bSJoe Perches	return 0;
1494de7d4f0eSAndy Whitcroft}
1495de7d4f0eSAndy Whitcroft
14966ecd9674SAndy Whitcroftsub check_absolute_file {
14976ecd9674SAndy Whitcroft	my ($absolute, $herecurr) = @_;
14986ecd9674SAndy Whitcroft	my $file = $absolute;
14996ecd9674SAndy Whitcroft
15006ecd9674SAndy Whitcroft	##print "absolute<$absolute>\n";
15016ecd9674SAndy Whitcroft
15026ecd9674SAndy Whitcroft	# See if any suffix of this path is a path within the tree.
15036ecd9674SAndy Whitcroft	while ($file =~ s@^[^/]*/@@) {
15046ecd9674SAndy Whitcroft		if (-f "$root/$file") {
15056ecd9674SAndy Whitcroft			##print "file<$file>\n";
15066ecd9674SAndy Whitcroft			last;
15076ecd9674SAndy Whitcroft		}
15086ecd9674SAndy Whitcroft	}
15096ecd9674SAndy Whitcroft	if (! -f _)  {
15106ecd9674SAndy Whitcroft		return 0;
15116ecd9674SAndy Whitcroft	}
15126ecd9674SAndy Whitcroft
15136ecd9674SAndy Whitcroft	# It is, so see if the prefix is acceptable.
15146ecd9674SAndy Whitcroft	my $prefix = $absolute;
15156ecd9674SAndy Whitcroft	substr($prefix, -length($file)) = '';
15166ecd9674SAndy Whitcroft
15176ecd9674SAndy Whitcroft	##print "prefix<$prefix>\n";
15186ecd9674SAndy Whitcroft	if ($prefix ne ".../") {
1519000d1cc1SJoe Perches		WARN("USE_RELATIVE_PATH",
1520000d1cc1SJoe Perches		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
15216ecd9674SAndy Whitcroft	}
15226ecd9674SAndy Whitcroft}
15236ecd9674SAndy Whitcroft
15243705ce5bSJoe Perchessub trim {
15253705ce5bSJoe Perches	my ($string) = @_;
15263705ce5bSJoe Perches
1527b34c648bSJoe Perches	$string =~ s/^\s+|\s+$//g;
1528b34c648bSJoe Perches
1529b34c648bSJoe Perches	return $string;
1530b34c648bSJoe Perches}
1531b34c648bSJoe Perches
1532b34c648bSJoe Perchessub ltrim {
1533b34c648bSJoe Perches	my ($string) = @_;
1534b34c648bSJoe Perches
1535b34c648bSJoe Perches	$string =~ s/^\s+//;
1536b34c648bSJoe Perches
1537b34c648bSJoe Perches	return $string;
1538b34c648bSJoe Perches}
1539b34c648bSJoe Perches
1540b34c648bSJoe Perchessub rtrim {
1541b34c648bSJoe Perches	my ($string) = @_;
1542b34c648bSJoe Perches
1543b34c648bSJoe Perches	$string =~ s/\s+$//;
15443705ce5bSJoe Perches
15453705ce5bSJoe Perches	return $string;
15463705ce5bSJoe Perches}
15473705ce5bSJoe Perches
154852ea8506SJoe Perchessub string_find_replace {
154952ea8506SJoe Perches	my ($string, $find, $replace) = @_;
155052ea8506SJoe Perches
155152ea8506SJoe Perches	$string =~ s/$find/$replace/g;
155252ea8506SJoe Perches
155352ea8506SJoe Perches	return $string;
155452ea8506SJoe Perches}
155552ea8506SJoe Perches
15563705ce5bSJoe Perchessub tabify {
15573705ce5bSJoe Perches	my ($leading) = @_;
15583705ce5bSJoe Perches
15593705ce5bSJoe Perches	my $source_indent = 8;
15603705ce5bSJoe Perches	my $max_spaces_before_tab = $source_indent - 1;
15613705ce5bSJoe Perches	my $spaces_to_tab = " " x $source_indent;
15623705ce5bSJoe Perches
15633705ce5bSJoe Perches	#convert leading spaces to tabs
15643705ce5bSJoe Perches	1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
15653705ce5bSJoe Perches	#Remove spaces before a tab
15663705ce5bSJoe Perches	1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
15673705ce5bSJoe Perches
15683705ce5bSJoe Perches	return "$leading";
15693705ce5bSJoe Perches}
15703705ce5bSJoe Perches
1571d1fe9c09SJoe Perchessub pos_last_openparen {
1572d1fe9c09SJoe Perches	my ($line) = @_;
1573d1fe9c09SJoe Perches
1574d1fe9c09SJoe Perches	my $pos = 0;
1575d1fe9c09SJoe Perches
1576d1fe9c09SJoe Perches	my $opens = $line =~ tr/\(/\(/;
1577d1fe9c09SJoe Perches	my $closes = $line =~ tr/\)/\)/;
1578d1fe9c09SJoe Perches
1579d1fe9c09SJoe Perches	my $last_openparen = 0;
1580d1fe9c09SJoe Perches
1581d1fe9c09SJoe Perches	if (($opens == 0) || ($closes >= $opens)) {
1582d1fe9c09SJoe Perches		return -1;
1583d1fe9c09SJoe Perches	}
1584d1fe9c09SJoe Perches
1585d1fe9c09SJoe Perches	my $len = length($line);
1586d1fe9c09SJoe Perches
1587d1fe9c09SJoe Perches	for ($pos = 0; $pos < $len; $pos++) {
1588d1fe9c09SJoe Perches		my $string = substr($line, $pos);
1589d1fe9c09SJoe Perches		if ($string =~ /^($FuncArg|$balanced_parens)/) {
1590d1fe9c09SJoe Perches			$pos += length($1) - 1;
1591d1fe9c09SJoe Perches		} elsif (substr($line, $pos, 1) eq '(') {
1592d1fe9c09SJoe Perches			$last_openparen = $pos;
1593d1fe9c09SJoe Perches		} elsif (index($string, '(') == -1) {
1594d1fe9c09SJoe Perches			last;
1595d1fe9c09SJoe Perches		}
1596d1fe9c09SJoe Perches	}
1597d1fe9c09SJoe Perches
1598d1fe9c09SJoe Perches	return $last_openparen + 1;
1599d1fe9c09SJoe Perches}
1600d1fe9c09SJoe Perches
16010a920b5bSAndy Whitcroftsub process {
16020a920b5bSAndy Whitcroft	my $filename = shift;
16030a920b5bSAndy Whitcroft
16040a920b5bSAndy Whitcroft	my $linenr=0;
16050a920b5bSAndy Whitcroft	my $prevline="";
1606c2fdda0dSAndy Whitcroft	my $prevrawline="";
16070a920b5bSAndy Whitcroft	my $stashline="";
1608c2fdda0dSAndy Whitcroft	my $stashrawline="";
16090a920b5bSAndy Whitcroft
16104a0df2efSAndy Whitcroft	my $length;
16110a920b5bSAndy Whitcroft	my $indent;
16120a920b5bSAndy Whitcroft	my $previndent=0;
16130a920b5bSAndy Whitcroft	my $stashindent=0;
16140a920b5bSAndy Whitcroft
1615de7d4f0eSAndy Whitcroft	our $clean = 1;
16160a920b5bSAndy Whitcroft	my $signoff = 0;
16170a920b5bSAndy Whitcroft	my $is_patch = 0;
16180a920b5bSAndy Whitcroft
161915662b3eSJoe Perches	my $in_header_lines = 1;
162015662b3eSJoe Perches	my $in_commit_log = 0;		#Scanning lines before patch
162115662b3eSJoe Perches
1622fa64205dSPasi Savanainen	my $non_utf8_charset = 0;
1623fa64205dSPasi Savanainen
162413214adfSAndy Whitcroft	our @report = ();
16256c72ffaaSAndy Whitcroft	our $cnt_lines = 0;
16266c72ffaaSAndy Whitcroft	our $cnt_error = 0;
16276c72ffaaSAndy Whitcroft	our $cnt_warn = 0;
16286c72ffaaSAndy Whitcroft	our $cnt_chk = 0;
16296c72ffaaSAndy Whitcroft
16300a920b5bSAndy Whitcroft	# Trace the real file/line as we go.
16310a920b5bSAndy Whitcroft	my $realfile = '';
16320a920b5bSAndy Whitcroft	my $realline = 0;
16330a920b5bSAndy Whitcroft	my $realcnt = 0;
16340a920b5bSAndy Whitcroft	my $here = '';
16350a920b5bSAndy Whitcroft	my $in_comment = 0;
1636c2fdda0dSAndy Whitcroft	my $comment_edge = 0;
16370a920b5bSAndy Whitcroft	my $first_line = 0;
16381e855726SWolfram Sang	my $p1_prefix = '';
16390a920b5bSAndy Whitcroft
164013214adfSAndy Whitcroft	my $prev_values = 'E';
164113214adfSAndy Whitcroft
164213214adfSAndy Whitcroft	# suppression flags
1643773647a0SAndy Whitcroft	my %suppress_ifbraces;
1644170d3a22SAndy Whitcroft	my %suppress_whiletrailers;
16452b474a1aSAndy Whitcroft	my %suppress_export;
16463e469cdcSAndy Whitcroft	my $suppress_statement = 0;
1647653d4876SAndy Whitcroft
16487e51f197SJoe Perches	my %signatures = ();
1649323c1260SJoe Perches
1650c2fdda0dSAndy Whitcroft	# Pre-scan the patch sanitizing the lines.
1651de7d4f0eSAndy Whitcroft	# Pre-scan the patch looking for any __setup documentation.
1652c2fdda0dSAndy Whitcroft	#
1653de7d4f0eSAndy Whitcroft	my @setup_docs = ();
1654de7d4f0eSAndy Whitcroft	my $setup_docs = 0;
1655773647a0SAndy Whitcroft
1656d8b07710SJoe Perches	my $camelcase_file_seeded = 0;
1657d8b07710SJoe Perches
1658773647a0SAndy Whitcroft	sanitise_line_reset();
1659c2fdda0dSAndy Whitcroft	my $line;
1660c2fdda0dSAndy Whitcroft	foreach my $rawline (@rawlines) {
1661773647a0SAndy Whitcroft		$linenr++;
1662773647a0SAndy Whitcroft		$line = $rawline;
1663c2fdda0dSAndy Whitcroft
16643705ce5bSJoe Perches		push(@fixed, $rawline) if ($fix);
16653705ce5bSJoe Perches
1666773647a0SAndy Whitcroft		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1667de7d4f0eSAndy Whitcroft			$setup_docs = 0;
1668de7d4f0eSAndy Whitcroft			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1669de7d4f0eSAndy Whitcroft				$setup_docs = 1;
1670de7d4f0eSAndy Whitcroft			}
1671773647a0SAndy Whitcroft			#next;
1672de7d4f0eSAndy Whitcroft		}
1673773647a0SAndy Whitcroft		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1674773647a0SAndy Whitcroft			$realline=$1-1;
1675773647a0SAndy Whitcroft			if (defined $2) {
1676773647a0SAndy Whitcroft				$realcnt=$3+1;
1677773647a0SAndy Whitcroft			} else {
1678773647a0SAndy Whitcroft				$realcnt=1+1;
1679773647a0SAndy Whitcroft			}
1680c45dcabdSAndy Whitcroft			$in_comment = 0;
1681773647a0SAndy Whitcroft
1682773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  Run
1683773647a0SAndy Whitcroft			# the context looking for a comment "edge".  If this
1684773647a0SAndy Whitcroft			# edge is a close comment then we must be in a comment
1685773647a0SAndy Whitcroft			# at context start.
1686773647a0SAndy Whitcroft			my $edge;
168701fa9147SAndy Whitcroft			my $cnt = $realcnt;
168801fa9147SAndy Whitcroft			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
168901fa9147SAndy Whitcroft				next if (defined $rawlines[$ln - 1] &&
169001fa9147SAndy Whitcroft					 $rawlines[$ln - 1] =~ /^-/);
169101fa9147SAndy Whitcroft				$cnt--;
169201fa9147SAndy Whitcroft				#print "RAW<$rawlines[$ln - 1]>\n";
1693721c1cb6SAndy Whitcroft				last if (!defined $rawlines[$ln - 1]);
1694fae17daeSAndy Whitcroft				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1695fae17daeSAndy Whitcroft				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1696fae17daeSAndy Whitcroft					($edge) = $1;
1697fae17daeSAndy Whitcroft					last;
1698fae17daeSAndy Whitcroft				}
1699773647a0SAndy Whitcroft			}
1700773647a0SAndy Whitcroft			if (defined $edge && $edge eq '*/') {
1701773647a0SAndy Whitcroft				$in_comment = 1;
1702773647a0SAndy Whitcroft			}
1703773647a0SAndy Whitcroft
1704773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  If this
1705773647a0SAndy Whitcroft			# is the start of a diff block and this line starts
1706773647a0SAndy Whitcroft			# ' *' then it is very likely a comment.
1707773647a0SAndy Whitcroft			if (!defined $edge &&
170883242e0cSAndy Whitcroft			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1709773647a0SAndy Whitcroft			{
1710773647a0SAndy Whitcroft				$in_comment = 1;
1711773647a0SAndy Whitcroft			}
1712773647a0SAndy Whitcroft
1713773647a0SAndy Whitcroft			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1714773647a0SAndy Whitcroft			sanitise_line_reset($in_comment);
1715773647a0SAndy Whitcroft
1716171ae1a4SAndy Whitcroft		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1717773647a0SAndy Whitcroft			# Standardise the strings and chars within the input to
1718171ae1a4SAndy Whitcroft			# simplify matching -- only bother with positive lines.
1719773647a0SAndy Whitcroft			$line = sanitise_line($rawline);
1720773647a0SAndy Whitcroft		}
1721773647a0SAndy Whitcroft		push(@lines, $line);
1722773647a0SAndy Whitcroft
1723773647a0SAndy Whitcroft		if ($realcnt > 1) {
1724773647a0SAndy Whitcroft			$realcnt-- if ($line =~ /^(?:\+| |$)/);
1725773647a0SAndy Whitcroft		} else {
1726773647a0SAndy Whitcroft			$realcnt = 0;
1727773647a0SAndy Whitcroft		}
1728773647a0SAndy Whitcroft
1729773647a0SAndy Whitcroft		#print "==>$rawline\n";
1730773647a0SAndy Whitcroft		#print "-->$line\n";
1731de7d4f0eSAndy Whitcroft
1732de7d4f0eSAndy Whitcroft		if ($setup_docs && $line =~ /^\+/) {
1733de7d4f0eSAndy Whitcroft			push(@setup_docs, $line);
1734de7d4f0eSAndy Whitcroft		}
1735de7d4f0eSAndy Whitcroft	}
1736de7d4f0eSAndy Whitcroft
17376c72ffaaSAndy Whitcroft	$prefix = '';
17386c72ffaaSAndy Whitcroft
1739773647a0SAndy Whitcroft	$realcnt = 0;
1740773647a0SAndy Whitcroft	$linenr = 0;
17410a920b5bSAndy Whitcroft	foreach my $line (@lines) {
17420a920b5bSAndy Whitcroft		$linenr++;
17431b5539b1SJoe Perches		my $sline = $line;	#copy of $line
17441b5539b1SJoe Perches		$sline =~ s/$;/ /g;	#with comments as spaces
17450a920b5bSAndy Whitcroft
1746c2fdda0dSAndy Whitcroft		my $rawline = $rawlines[$linenr - 1];
17476c72ffaaSAndy Whitcroft
17480a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied
17496c72ffaaSAndy Whitcroft		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
17500a920b5bSAndy Whitcroft			$is_patch = 1;
17514a0df2efSAndy Whitcroft			$first_line = $linenr + 1;
17520a920b5bSAndy Whitcroft			$realline=$1-1;
17530a920b5bSAndy Whitcroft			if (defined $2) {
17540a920b5bSAndy Whitcroft				$realcnt=$3+1;
17550a920b5bSAndy Whitcroft			} else {
17560a920b5bSAndy Whitcroft				$realcnt=1+1;
17570a920b5bSAndy Whitcroft			}
1758c2fdda0dSAndy Whitcroft			annotate_reset();
175913214adfSAndy Whitcroft			$prev_values = 'E';
176013214adfSAndy Whitcroft
1761773647a0SAndy Whitcroft			%suppress_ifbraces = ();
1762170d3a22SAndy Whitcroft			%suppress_whiletrailers = ();
17632b474a1aSAndy Whitcroft			%suppress_export = ();
17643e469cdcSAndy Whitcroft			$suppress_statement = 0;
17650a920b5bSAndy Whitcroft			next;
17660a920b5bSAndy Whitcroft
17674a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that
17684a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely
17694a0df2efSAndy Whitcroft# blank context lines so we need to count that too.
1770773647a0SAndy Whitcroft		} elsif ($line =~ /^( |\+|$)/) {
17710a920b5bSAndy Whitcroft			$realline++;
1772d8aaf121SAndy Whitcroft			$realcnt-- if ($realcnt != 0);
17730a920b5bSAndy Whitcroft
17744a0df2efSAndy Whitcroft			# Measure the line length and indent.
1775c2fdda0dSAndy Whitcroft			($length, $indent) = line_stats($rawline);
17760a920b5bSAndy Whitcroft
17770a920b5bSAndy Whitcroft			# Track the previous line.
17780a920b5bSAndy Whitcroft			($prevline, $stashline) = ($stashline, $line);
17790a920b5bSAndy Whitcroft			($previndent, $stashindent) = ($stashindent, $indent);
1780c2fdda0dSAndy Whitcroft			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1781c2fdda0dSAndy Whitcroft
1782773647a0SAndy Whitcroft			#warn "line<$line>\n";
17836c72ffaaSAndy Whitcroft
1784d8aaf121SAndy Whitcroft		} elsif ($realcnt == 1) {
1785d8aaf121SAndy Whitcroft			$realcnt--;
17860a920b5bSAndy Whitcroft		}
17870a920b5bSAndy Whitcroft
1788cc77cdcaSAndy Whitcroft		my $hunk_line = ($realcnt != 0);
1789cc77cdcaSAndy Whitcroft
17900a920b5bSAndy Whitcroft#make up the handle for any error we report on this line
1791773647a0SAndy Whitcroft		$prefix = "$filename:$realline: " if ($emacs && $file);
1792773647a0SAndy Whitcroft		$prefix = "$filename:$linenr: " if ($emacs && !$file);
1793773647a0SAndy Whitcroft
17946c72ffaaSAndy Whitcroft		$here = "#$linenr: " if (!$file);
17956c72ffaaSAndy Whitcroft		$here = "#$realline: " if ($file);
1796773647a0SAndy Whitcroft
1797773647a0SAndy Whitcroft		# extract the filename as it passes
17983bf9a009SRabin Vincent		if ($line =~ /^diff --git.*?(\S+)$/) {
17993bf9a009SRabin Vincent			$realfile = $1;
18002b7ab453SJoe Perches			$realfile =~ s@^([^/]*)/@@ if (!$file);
1801270c49a0SJoe Perches			$in_commit_log = 0;
18023bf9a009SRabin Vincent		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1803773647a0SAndy Whitcroft			$realfile = $1;
18042b7ab453SJoe Perches			$realfile =~ s@^([^/]*)/@@ if (!$file);
1805270c49a0SJoe Perches			$in_commit_log = 0;
18061e855726SWolfram Sang
18071e855726SWolfram Sang			$p1_prefix = $1;
1808e2f7aa4bSAndy Whitcroft			if (!$file && $tree && $p1_prefix ne '' &&
1809e2f7aa4bSAndy Whitcroft			    -e "$root/$p1_prefix") {
1810000d1cc1SJoe Perches				WARN("PATCH_PREFIX",
1811000d1cc1SJoe Perches				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
18121e855726SWolfram Sang			}
1813773647a0SAndy Whitcroft
1814c1ab3326SAndy Whitcroft			if ($realfile =~ m@^include/asm/@) {
1815000d1cc1SJoe Perches				ERROR("MODIFIED_INCLUDE_ASM",
1816000d1cc1SJoe Perches				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1817773647a0SAndy Whitcroft			}
1818773647a0SAndy Whitcroft			next;
1819773647a0SAndy Whitcroft		}
1820773647a0SAndy Whitcroft
1821389834b6SRandy Dunlap		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
18220a920b5bSAndy Whitcroft
1823c2fdda0dSAndy Whitcroft		my $hereline = "$here\n$rawline\n";
1824c2fdda0dSAndy Whitcroft		my $herecurr = "$here\n$rawline\n";
1825c2fdda0dSAndy Whitcroft		my $hereprev = "$here\n$prevrawline\n$rawline\n";
18260a920b5bSAndy Whitcroft
18276c72ffaaSAndy Whitcroft		$cnt_lines++ if ($realcnt != 0);
18286c72ffaaSAndy Whitcroft
18293bf9a009SRabin Vincent# Check for incorrect file permissions
18303bf9a009SRabin Vincent		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
18313bf9a009SRabin Vincent			my $permhere = $here . "FILE: $realfile\n";
183204db4d25SJoe Perches			if ($realfile !~ m@scripts/@ &&
183304db4d25SJoe Perches			    $realfile !~ /\.(py|pl|awk|sh)$/) {
1834000d1cc1SJoe Perches				ERROR("EXECUTE_PERMISSIONS",
1835000d1cc1SJoe Perches				      "do not set execute permissions for source files\n" . $permhere);
18363bf9a009SRabin Vincent			}
18373bf9a009SRabin Vincent		}
18383bf9a009SRabin Vincent
183920112475SJoe Perches# Check the patch for a signoff:
1840d8aaf121SAndy Whitcroft		if ($line =~ /^\s*signed-off-by:/i) {
18414a0df2efSAndy Whitcroft			$signoff++;
184215662b3eSJoe Perches			$in_commit_log = 0;
18430a920b5bSAndy Whitcroft		}
184420112475SJoe Perches
184520112475SJoe Perches# Check signature styles
1846270c49a0SJoe Perches		if (!$in_header_lines &&
1847ce0338dfSJoe Perches		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
184820112475SJoe Perches			my $space_before = $1;
184920112475SJoe Perches			my $sign_off = $2;
185020112475SJoe Perches			my $space_after = $3;
185120112475SJoe Perches			my $email = $4;
185220112475SJoe Perches			my $ucfirst_sign_off = ucfirst(lc($sign_off));
185320112475SJoe Perches
1854ce0338dfSJoe Perches			if ($sign_off !~ /$signature_tags/) {
1855ce0338dfSJoe Perches				WARN("BAD_SIGN_OFF",
1856ce0338dfSJoe Perches				     "Non-standard signature: $sign_off\n" . $herecurr);
1857ce0338dfSJoe Perches			}
185820112475SJoe Perches			if (defined $space_before && $space_before ne "") {
18593705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
18603705ce5bSJoe Perches					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
18613705ce5bSJoe Perches				    $fix) {
18623705ce5bSJoe Perches					$fixed[$linenr - 1] =
18633705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
18643705ce5bSJoe Perches				}
186520112475SJoe Perches			}
186620112475SJoe Perches			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
18673705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
18683705ce5bSJoe Perches					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
18693705ce5bSJoe Perches				    $fix) {
18703705ce5bSJoe Perches					$fixed[$linenr - 1] =
18713705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
18723705ce5bSJoe Perches				}
18733705ce5bSJoe Perches
187420112475SJoe Perches			}
187520112475SJoe Perches			if (!defined $space_after || $space_after ne " ") {
18763705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
18773705ce5bSJoe Perches					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
18783705ce5bSJoe Perches				    $fix) {
18793705ce5bSJoe Perches					$fixed[$linenr - 1] =
18803705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
18813705ce5bSJoe Perches				}
188220112475SJoe Perches			}
188320112475SJoe Perches
188420112475SJoe Perches			my ($email_name, $email_address, $comment) = parse_email($email);
188520112475SJoe Perches			my $suggested_email = format_email(($email_name, $email_address));
188620112475SJoe Perches			if ($suggested_email eq "") {
1887000d1cc1SJoe Perches				ERROR("BAD_SIGN_OFF",
1888000d1cc1SJoe Perches				      "Unrecognized email address: '$email'\n" . $herecurr);
188920112475SJoe Perches			} else {
189020112475SJoe Perches				my $dequoted = $suggested_email;
189120112475SJoe Perches				$dequoted =~ s/^"//;
189220112475SJoe Perches				$dequoted =~ s/" </ </;
189320112475SJoe Perches				# Don't force email to have quotes
189420112475SJoe Perches				# Allow just an angle bracketed address
189520112475SJoe Perches				if ("$dequoted$comment" ne $email &&
189620112475SJoe Perches				    "<$email_address>$comment" ne $email &&
189720112475SJoe Perches				    "$suggested_email$comment" ne $email) {
1898000d1cc1SJoe Perches					WARN("BAD_SIGN_OFF",
1899000d1cc1SJoe Perches					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
190020112475SJoe Perches				}
19010a920b5bSAndy Whitcroft			}
19027e51f197SJoe Perches
19037e51f197SJoe Perches# Check for duplicate signatures
19047e51f197SJoe Perches			my $sig_nospace = $line;
19057e51f197SJoe Perches			$sig_nospace =~ s/\s//g;
19067e51f197SJoe Perches			$sig_nospace = lc($sig_nospace);
19077e51f197SJoe Perches			if (defined $signatures{$sig_nospace}) {
19087e51f197SJoe Perches				WARN("BAD_SIGN_OFF",
19097e51f197SJoe Perches				     "Duplicate signature\n" . $herecurr);
19107e51f197SJoe Perches			} else {
19117e51f197SJoe Perches				$signatures{$sig_nospace} = 1;
19127e51f197SJoe Perches			}
19130a920b5bSAndy Whitcroft		}
19140a920b5bSAndy Whitcroft
191500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file
19168905a67cSAndy Whitcroft		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1917000d1cc1SJoe Perches			ERROR("CORRUPTED_PATCH",
1918000d1cc1SJoe Perches			      "patch seems to be corrupt (line wrapped?)\n" .
19196c72ffaaSAndy Whitcroft				$herecurr) if (!$emitted_corrupt++);
1920de7d4f0eSAndy Whitcroft		}
1921de7d4f0eSAndy Whitcroft
19226ecd9674SAndy Whitcroft# Check for absolute kernel paths.
19236ecd9674SAndy Whitcroft		if ($tree) {
19246ecd9674SAndy Whitcroft			while ($line =~ m{(?:^|\s)(/\S*)}g) {
19256ecd9674SAndy Whitcroft				my $file = $1;
19266ecd9674SAndy Whitcroft
19276ecd9674SAndy Whitcroft				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
19286ecd9674SAndy Whitcroft				    check_absolute_file($1, $herecurr)) {
19296ecd9674SAndy Whitcroft					#
19306ecd9674SAndy Whitcroft				} else {
19316ecd9674SAndy Whitcroft					check_absolute_file($file, $herecurr);
19326ecd9674SAndy Whitcroft				}
19336ecd9674SAndy Whitcroft			}
19346ecd9674SAndy Whitcroft		}
19356ecd9674SAndy Whitcroft
1936de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1937de7d4f0eSAndy Whitcroft		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1938171ae1a4SAndy Whitcroft		    $rawline !~ m/^$UTF8*$/) {
1939171ae1a4SAndy Whitcroft			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1940171ae1a4SAndy Whitcroft
1941171ae1a4SAndy Whitcroft			my $blank = copy_spacing($rawline);
1942171ae1a4SAndy Whitcroft			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1943171ae1a4SAndy Whitcroft			my $hereptr = "$hereline$ptr\n";
1944171ae1a4SAndy Whitcroft
194534d99219SJoe Perches			CHK("INVALID_UTF8",
1946000d1cc1SJoe Perches			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
194700df344fSAndy Whitcroft		}
19480a920b5bSAndy Whitcroft
194915662b3eSJoe Perches# Check if it's the start of a commit log
195015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename)
195115662b3eSJoe Perches		if ($in_header_lines && $realfile =~ /^$/ &&
1952270c49a0SJoe Perches		    $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
195315662b3eSJoe Perches			$in_header_lines = 0;
195415662b3eSJoe Perches			$in_commit_log = 1;
195515662b3eSJoe Perches		}
195615662b3eSJoe Perches
1957fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly
1958fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing.
1959fa64205dSPasi Savanainen		if ($in_header_lines &&
1960fa64205dSPasi Savanainen		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1961fa64205dSPasi Savanainen		    $1 !~ /utf-8/i) {
1962fa64205dSPasi Savanainen			$non_utf8_charset = 1;
1963fa64205dSPasi Savanainen		}
1964fa64205dSPasi Savanainen
1965fa64205dSPasi Savanainen		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
196615662b3eSJoe Perches		    $rawline =~ /$NON_ASCII_UTF8/) {
1967fa64205dSPasi Savanainen			WARN("UTF8_BEFORE_PATCH",
196815662b3eSJoe Perches			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
196915662b3eSJoe Perches		}
197015662b3eSJoe Perches
197130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed
197230670854SAndy Whitcroft		next if (!$hunk_line || $line =~ /^-/);
197300df344fSAndy Whitcroft
19740a920b5bSAndy Whitcroft#trailing whitespace
19759c0ca6f9SAndy Whitcroft		if ($line =~ /^\+.*\015/) {
1976c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1977d5e616fcSJoe Perches			if (ERROR("DOS_LINE_ENDINGS",
1978d5e616fcSJoe Perches				  "DOS line endings\n" . $herevet) &&
1979d5e616fcSJoe Perches			    $fix) {
1980d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/[\s\015]+$//;
1981d5e616fcSJoe Perches			}
1982c2fdda0dSAndy Whitcroft		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1983c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
19843705ce5bSJoe Perches			if (ERROR("TRAILING_WHITESPACE",
19853705ce5bSJoe Perches				  "trailing whitespace\n" . $herevet) &&
19863705ce5bSJoe Perches			    $fix) {
1987d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/\s+$//;
19883705ce5bSJoe Perches			}
19893705ce5bSJoe Perches
1990d2c0a235SAndy Whitcroft			$rpt_cleaners = 1;
19910a920b5bSAndy Whitcroft		}
19925368df20SAndy Whitcroft
19934783f894SJosh Triplett# Check for FSF mailing addresses.
1994109d8cb2SAlexander Duyck		if ($rawline =~ /\bwrite to the Free/i ||
19953e2232f2SJoe Perches		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
19963e2232f2SJoe Perches		    $rawline =~ /\b51\s+Franklin\s+St/i) {
19974783f894SJosh Triplett			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
19984783f894SJosh Triplett			my $msg_type = \&ERROR;
19994783f894SJosh Triplett			$msg_type = \&CHK if ($file);
20004783f894SJosh Triplett			&{$msg_type}("FSF_MAILING_ADDRESS",
20014783f894SJosh Triplett				     "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
20024783f894SJosh Triplett		}
20034783f894SJosh Triplett
20043354957aSAndi Kleen# check for Kconfig help text having a real description
20059fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have
20069fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough.
20073354957aSAndi Kleen		if ($realfile =~ /Kconfig/ &&
2008a1385803SAndy Whitcroft		    $line =~ /.\s*config\s+/) {
20093354957aSAndi Kleen			my $length = 0;
20109fe287d7SAndy Whitcroft			my $cnt = $realcnt;
20119fe287d7SAndy Whitcroft			my $ln = $linenr + 1;
20129fe287d7SAndy Whitcroft			my $f;
2013a1385803SAndy Whitcroft			my $is_start = 0;
20149fe287d7SAndy Whitcroft			my $is_end = 0;
2015a1385803SAndy Whitcroft			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
20169fe287d7SAndy Whitcroft				$f = $lines[$ln - 1];
20179fe287d7SAndy Whitcroft				$cnt-- if ($lines[$ln - 1] !~ /^-/);
20189fe287d7SAndy Whitcroft				$is_end = $lines[$ln - 1] =~ /^\+/;
20199fe287d7SAndy Whitcroft
20209fe287d7SAndy Whitcroft				next if ($f =~ /^-/);
2021a1385803SAndy Whitcroft
2022a1385803SAndy Whitcroft				if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2023a1385803SAndy Whitcroft					$is_start = 1;
2024a1385803SAndy Whitcroft				} elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2025a1385803SAndy Whitcroft					$length = -1;
2026a1385803SAndy Whitcroft				}
2027a1385803SAndy Whitcroft
20289fe287d7SAndy Whitcroft				$f =~ s/^.//;
20293354957aSAndi Kleen				$f =~ s/#.*//;
20303354957aSAndi Kleen				$f =~ s/^\s+//;
20313354957aSAndi Kleen				next if ($f =~ /^$/);
20329fe287d7SAndy Whitcroft				if ($f =~ /^\s*config\s/) {
20339fe287d7SAndy Whitcroft					$is_end = 1;
20349fe287d7SAndy Whitcroft					last;
20359fe287d7SAndy Whitcroft				}
20363354957aSAndi Kleen				$length++;
20373354957aSAndi Kleen			}
2038000d1cc1SJoe Perches			WARN("CONFIG_DESCRIPTION",
2039a1385803SAndy Whitcroft			     "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2040a1385803SAndy Whitcroft			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
20413354957aSAndi Kleen		}
20423354957aSAndi Kleen
20431ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
20441ba8dfd1SKees Cook		if ($realfile =~ /Kconfig/ &&
20451ba8dfd1SKees Cook		    $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
20461ba8dfd1SKees Cook			WARN("CONFIG_EXPERIMENTAL",
20471ba8dfd1SKees Cook			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
20481ba8dfd1SKees Cook		}
20491ba8dfd1SKees Cook
2050c68e5878SArnaud Lacombe		if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2051c68e5878SArnaud Lacombe		    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2052c68e5878SArnaud Lacombe			my $flag = $1;
2053c68e5878SArnaud Lacombe			my $replacement = {
2054c68e5878SArnaud Lacombe				'EXTRA_AFLAGS' =>   'asflags-y',
2055c68e5878SArnaud Lacombe				'EXTRA_CFLAGS' =>   'ccflags-y',
2056c68e5878SArnaud Lacombe				'EXTRA_CPPFLAGS' => 'cppflags-y',
2057c68e5878SArnaud Lacombe				'EXTRA_LDFLAGS' =>  'ldflags-y',
2058c68e5878SArnaud Lacombe			};
2059c68e5878SArnaud Lacombe
2060c68e5878SArnaud Lacombe			WARN("DEPRECATED_VARIABLE",
2061c68e5878SArnaud Lacombe			     "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2062c68e5878SArnaud Lacombe		}
2063c68e5878SArnaud Lacombe
2064bff5da43SRob Herring# check for DT compatible documentation
2065bff5da43SRob Herring		if (defined $root && $realfile =~ /\.dts/ &&
2066bff5da43SRob Herring		    $rawline =~ /^\+\s*compatible\s*=/) {
2067bff5da43SRob Herring			my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2068bff5da43SRob Herring
2069bff5da43SRob Herring			foreach my $compat (@compats) {
2070bff5da43SRob Herring				my $compat2 = $compat;
2071bff5da43SRob Herring				my $dt_path =  $root . "/Documentation/devicetree/bindings/";
2072bff5da43SRob Herring				$compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/;
2073bff5da43SRob Herring				`grep -Erq "$compat|$compat2" $dt_path`;
2074bff5da43SRob Herring				if ( $? >> 8 ) {
2075bff5da43SRob Herring					WARN("UNDOCUMENTED_DT_STRING",
2076bff5da43SRob Herring					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2077bff5da43SRob Herring				}
2078bff5da43SRob Herring
2079bff5da43SRob Herring				my $vendor = $compat;
2080bff5da43SRob Herring				my $vendor_path = $dt_path . "vendor-prefixes.txt";
2081bff5da43SRob Herring				next if (! -f $vendor_path);
2082bff5da43SRob Herring				$vendor =~ s/^([a-zA-Z0-9]+)\,.*/$1/;
2083bff5da43SRob Herring				`grep -Eq "$vendor" $vendor_path`;
2084bff5da43SRob Herring				if ( $? >> 8 ) {
2085bff5da43SRob Herring					WARN("UNDOCUMENTED_DT_STRING",
2086bff5da43SRob Herring					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\n" . $herecurr);
2087bff5da43SRob Herring				}
2088bff5da43SRob Herring			}
2089bff5da43SRob Herring		}
2090bff5da43SRob Herring
20915368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk
20925368df20SAndy Whitcroft		next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
20935368df20SAndy Whitcroft
20946cd7f386SJoe Perches#line length limit
2095c45dcabdSAndy Whitcroft		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2096f4c014c0SAndy Whitcroft		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
20970fccc622SJoe Perches		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
20988bbea968SJoe Perches		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
20996cd7f386SJoe Perches		    $length > $max_line_length)
2100c45dcabdSAndy Whitcroft		{
2101000d1cc1SJoe Perches			WARN("LONG_LINE",
21026cd7f386SJoe Perches			     "line over $max_line_length characters\n" . $herecurr);
21030a920b5bSAndy Whitcroft		}
21040a920b5bSAndy Whitcroft
2105ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability
21068c5fcd24SJoe Perches# to grep for the string.  Make exceptions when the previous string ends in a
21078c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
21088c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2109ca56dc09SJosh Triplett		if ($line =~ /^\+\s*"/ &&
2110ca56dc09SJosh Triplett		    $prevline =~ /"\s*$/ &&
21118c5fcd24SJoe Perches		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
2112ca56dc09SJosh Triplett			WARN("SPLIT_STRING",
2113ca56dc09SJosh Triplett			     "quoted string split across lines\n" . $hereprev);
2114ca56dc09SJosh Triplett		}
2115ca56dc09SJosh Triplett
21165e79d96eSJoe Perches# check for spaces before a quoted newline
21175e79d96eSJoe Perches		if ($rawline =~ /^.*\".*\s\\n/) {
21183705ce5bSJoe Perches			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
21193705ce5bSJoe Perches				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
21203705ce5bSJoe Perches			    $fix) {
21213705ce5bSJoe Perches				$fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
21223705ce5bSJoe Perches			}
21233705ce5bSJoe Perches
21245e79d96eSJoe Perches		}
21255e79d96eSJoe Perches
21268905a67cSAndy Whitcroft# check for adding lines without a newline.
21278905a67cSAndy Whitcroft		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2128000d1cc1SJoe Perches			WARN("MISSING_EOF_NEWLINE",
2129000d1cc1SJoe Perches			     "adding a line without newline at end of file\n" . $herecurr);
21308905a67cSAndy Whitcroft		}
21318905a67cSAndy Whitcroft
213242e41c54SMike Frysinger# Blackfin: use hi/lo macros
213342e41c54SMike Frysinger		if ($realfile =~ m@arch/blackfin/.*\.S$@) {
213442e41c54SMike Frysinger			if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
213542e41c54SMike Frysinger				my $herevet = "$here\n" . cat_vet($line) . "\n";
2136000d1cc1SJoe Perches				ERROR("LO_MACRO",
2137000d1cc1SJoe Perches				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
213842e41c54SMike Frysinger			}
213942e41c54SMike Frysinger			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
214042e41c54SMike Frysinger				my $herevet = "$here\n" . cat_vet($line) . "\n";
2141000d1cc1SJoe Perches				ERROR("HI_MACRO",
2142000d1cc1SJoe Perches				      "use the HI() macro, not (... >> 16)\n" . $herevet);
214342e41c54SMike Frysinger			}
214442e41c54SMike Frysinger		}
214542e41c54SMike Frysinger
2146b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk
2147b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c|pl)$/);
21480a920b5bSAndy Whitcroft
21490a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything
21500a920b5bSAndy Whitcroft# more than 8 must use tabs.
2151c2fdda0dSAndy Whitcroft		if ($rawline =~ /^\+\s* \t\s*\S/ ||
2152c2fdda0dSAndy Whitcroft		    $rawline =~ /^\+\s*        \s*/) {
2153c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2154d2c0a235SAndy Whitcroft			$rpt_cleaners = 1;
21553705ce5bSJoe Perches			if (ERROR("CODE_INDENT",
21563705ce5bSJoe Perches				  "code indent should use tabs where possible\n" . $herevet) &&
21573705ce5bSJoe Perches			    $fix) {
21583705ce5bSJoe Perches				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
21593705ce5bSJoe Perches			}
21600a920b5bSAndy Whitcroft		}
21610a920b5bSAndy Whitcroft
216208e44365SAlberto Panizzo# check for space before tabs.
216308e44365SAlberto Panizzo		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
216408e44365SAlberto Panizzo			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
21653705ce5bSJoe Perches			if (WARN("SPACE_BEFORE_TAB",
21663705ce5bSJoe Perches				"please, no space before tabs\n" . $herevet) &&
21673705ce5bSJoe Perches			    $fix) {
2168c76f4cb3SJoe Perches				while ($fixed[$linenr - 1] =~
2169c76f4cb3SJoe Perches					   s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2170c76f4cb3SJoe Perches				while ($fixed[$linenr - 1] =~
2171c76f4cb3SJoe Perches					   s/(^\+.*) +\t/$1\t/) {}
21723705ce5bSJoe Perches			}
217308e44365SAlberto Panizzo		}
217408e44365SAlberto Panizzo
2175d1fe9c09SJoe Perches# check for && or || at the start of a line
2176d1fe9c09SJoe Perches		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2177d1fe9c09SJoe Perches			CHK("LOGICAL_CONTINUATIONS",
2178d1fe9c09SJoe Perches			    "Logical continuations should be on the previous line\n" . $hereprev);
2179d1fe9c09SJoe Perches		}
2180d1fe9c09SJoe Perches
2181d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line
2182d1fe9c09SJoe Perches		if ($^V && $^V ge 5.10.0 &&
2183d1fe9c09SJoe Perches		    $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2184d1fe9c09SJoe Perches			$prevline =~ /^\+(\t*)(.*)$/;
2185d1fe9c09SJoe Perches			my $oldindent = $1;
2186d1fe9c09SJoe Perches			my $rest = $2;
2187d1fe9c09SJoe Perches
2188d1fe9c09SJoe Perches			my $pos = pos_last_openparen($rest);
2189d1fe9c09SJoe Perches			if ($pos >= 0) {
2190b34a26f3SJoe Perches				$line =~ /^(\+| )([ \t]*)/;
2191b34a26f3SJoe Perches				my $newindent = $2;
2192d1fe9c09SJoe Perches
2193d1fe9c09SJoe Perches				my $goodtabindent = $oldindent .
2194d1fe9c09SJoe Perches					"\t" x ($pos / 8) .
2195d1fe9c09SJoe Perches					" "  x ($pos % 8);
2196d1fe9c09SJoe Perches				my $goodspaceindent = $oldindent . " "  x $pos;
2197d1fe9c09SJoe Perches
2198d1fe9c09SJoe Perches				if ($newindent ne $goodtabindent &&
2199d1fe9c09SJoe Perches				    $newindent ne $goodspaceindent) {
22003705ce5bSJoe Perches
22013705ce5bSJoe Perches					if (CHK("PARENTHESIS_ALIGNMENT",
22023705ce5bSJoe Perches						"Alignment should match open parenthesis\n" . $hereprev) &&
22033705ce5bSJoe Perches					    $fix && $line =~ /^\+/) {
22043705ce5bSJoe Perches						$fixed[$linenr - 1] =~
22053705ce5bSJoe Perches						    s/^\+[ \t]*/\+$goodtabindent/;
22063705ce5bSJoe Perches					}
2207d1fe9c09SJoe Perches				}
2208d1fe9c09SJoe Perches			}
2209d1fe9c09SJoe Perches		}
2210d1fe9c09SJoe Perches
221123f780c9SJoe Perches		if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
22123705ce5bSJoe Perches			if (CHK("SPACING",
22133705ce5bSJoe Perches				"No space is necessary after a cast\n" . $hereprev) &&
22143705ce5bSJoe Perches			    $fix) {
22153705ce5bSJoe Perches				$fixed[$linenr - 1] =~
22163705ce5bSJoe Perches				    s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
22173705ce5bSJoe Perches			}
2218aad4f614SJoe Perches		}
2219aad4f614SJoe Perches
222005880600SJoe Perches		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2221fdb4bcd6SJoe Perches		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2222fdb4bcd6SJoe Perches		    $rawline =~ /^\+[ \t]*\*/) {
222305880600SJoe Perches			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
222405880600SJoe Perches			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
222505880600SJoe Perches		}
222605880600SJoe Perches
222705880600SJoe Perches		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2228a605e32eSJoe Perches		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
2229a605e32eSJoe Perches		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
223061135e96SJoe Perches		    $rawline =~ /^\+/ &&			#line is new
2231a605e32eSJoe Perches		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
2232a605e32eSJoe Perches			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2233a605e32eSJoe Perches			     "networking block comments start with * on subsequent lines\n" . $hereprev);
2234a605e32eSJoe Perches		}
2235a605e32eSJoe Perches
2236a605e32eSJoe Perches		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2237c24f9f19SJoe Perches		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
2238c24f9f19SJoe Perches		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
2239c24f9f19SJoe Perches		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
2240c24f9f19SJoe Perches		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
224105880600SJoe Perches			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
224205880600SJoe Perches			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
224305880600SJoe Perches		}
224405880600SJoe Perches
22455f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line.
22466b4c5bebSAndy Whitcroft# Exceptions:
22476b4c5bebSAndy Whitcroft#  1) within comments
22486b4c5bebSAndy Whitcroft#  2) indented preprocessor commands
22496b4c5bebSAndy Whitcroft#  3) hanging labels
22503705ce5bSJoe Perches		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
22515f7ddae6SRaffaele Recalcati			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
22523705ce5bSJoe Perches			if (WARN("LEADING_SPACE",
22533705ce5bSJoe Perches				 "please, no spaces at the start of a line\n" . $herevet) &&
22543705ce5bSJoe Perches			    $fix) {
22553705ce5bSJoe Perches				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
22563705ce5bSJoe Perches			}
22575f7ddae6SRaffaele Recalcati		}
22585f7ddae6SRaffaele Recalcati
2259b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk
2260b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c)$/);
2261b9ea10d6SAndy Whitcroft
22621ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
22631ba8dfd1SKees Cook		if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
22641ba8dfd1SKees Cook			WARN("CONFIG_EXPERIMENTAL",
22651ba8dfd1SKees Cook			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
22661ba8dfd1SKees Cook		}
22671ba8dfd1SKees Cook
2268c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers
2269cf655043SAndy Whitcroft		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2270000d1cc1SJoe Perches			WARN("CVS_KEYWORD",
2271000d1cc1SJoe Perches			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2272c2fdda0dSAndy Whitcroft		}
227322f2a2efSAndy Whitcroft
227442e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync
227542e41c54SMike Frysinger		if ($line =~ /__builtin_bfin_csync/) {
227642e41c54SMike Frysinger			my $herevet = "$here\n" . cat_vet($line) . "\n";
2277000d1cc1SJoe Perches			ERROR("CSYNC",
2278000d1cc1SJoe Perches			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
227942e41c54SMike Frysinger		}
228042e41c54SMike Frysinger		if ($line =~ /__builtin_bfin_ssync/) {
228142e41c54SMike Frysinger			my $herevet = "$here\n" . cat_vet($line) . "\n";
2282000d1cc1SJoe Perches			ERROR("SSYNC",
2283000d1cc1SJoe Perches			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
228442e41c54SMike Frysinger		}
228542e41c54SMike Frysinger
228656e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings
228756e77d70SJoe Perches		if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
228856e77d70SJoe Perches			WARN("HOTPLUG_SECTION",
228956e77d70SJoe Perches			     "Using $1 is unnecessary\n" . $herecurr);
229056e77d70SJoe Perches		}
229156e77d70SJoe Perches
22929c0ca6f9SAndy Whitcroft# Check for potential 'bare' types
22932b474a1aSAndy Whitcroft		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
22942b474a1aSAndy Whitcroft		    $realline_next);
22953e469cdcSAndy Whitcroft#print "LINE<$line>\n";
22963e469cdcSAndy Whitcroft		if ($linenr >= $suppress_statement &&
22971b5539b1SJoe Perches		    $realcnt && $sline =~ /.\s*\S/) {
2298170d3a22SAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2299f5fe35ddSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
2300171ae1a4SAndy Whitcroft			$stat =~ s/\n./\n /g;
2301171ae1a4SAndy Whitcroft			$cond =~ s/\n./\n /g;
2302171ae1a4SAndy Whitcroft
23033e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n";
23043e469cdcSAndy Whitcroft			# If this statement has no statement boundaries within
23053e469cdcSAndy Whitcroft			# it there is no point in retrying a statement scan
23063e469cdcSAndy Whitcroft			# until we hit end of it.
23073e469cdcSAndy Whitcroft			my $frag = $stat; $frag =~ s/;+\s*$//;
23083e469cdcSAndy Whitcroft			if ($frag !~ /(?:{|;)/) {
23093e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n";
23103e469cdcSAndy Whitcroft				$suppress_statement = $line_nr_next;
23113e469cdcSAndy Whitcroft			}
2312f74bd194SAndy Whitcroft
23132b474a1aSAndy Whitcroft			# Find the real next line.
23142b474a1aSAndy Whitcroft			$realline_next = $line_nr_next;
23152b474a1aSAndy Whitcroft			if (defined $realline_next &&
23162b474a1aSAndy Whitcroft			    (!defined $lines[$realline_next - 1] ||
23172b474a1aSAndy Whitcroft			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
23182b474a1aSAndy Whitcroft				$realline_next++;
23192b474a1aSAndy Whitcroft			}
23202b474a1aSAndy Whitcroft
2321171ae1a4SAndy Whitcroft			my $s = $stat;
2322171ae1a4SAndy Whitcroft			$s =~ s/{.*$//s;
2323cf655043SAndy Whitcroft
2324c2fdda0dSAndy Whitcroft			# Ignore goto labels.
2325171ae1a4SAndy Whitcroft			if ($s =~ /$Ident:\*$/s) {
2326c2fdda0dSAndy Whitcroft
2327c2fdda0dSAndy Whitcroft			# Ignore functions being called
2328171ae1a4SAndy Whitcroft			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2329c2fdda0dSAndy Whitcroft
2330463f2864SAndy Whitcroft			} elsif ($s =~ /^.\s*else\b/s) {
2331463f2864SAndy Whitcroft
2332c45dcabdSAndy Whitcroft			# declarations always start with types
2333d2506586SAndy Whitcroft			} elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
2334c45dcabdSAndy Whitcroft				my $type = $1;
2335c45dcabdSAndy Whitcroft				$type =~ s/\s+/ /g;
2336c45dcabdSAndy Whitcroft				possible($type, "A:" . $s);
2337c45dcabdSAndy Whitcroft
23386c72ffaaSAndy Whitcroft			# definitions in global scope can only start with types
2339a6a84062SAndy Whitcroft			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2340c45dcabdSAndy Whitcroft				possible($1, "B:" . $s);
2341c2fdda0dSAndy Whitcroft			}
23428905a67cSAndy Whitcroft
23436c72ffaaSAndy Whitcroft			# any (foo ... *) is a pointer cast, and foo is a type
234465863862SAndy Whitcroft			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2345c45dcabdSAndy Whitcroft				possible($1, "C:" . $s);
23469c0ca6f9SAndy Whitcroft			}
23478905a67cSAndy Whitcroft
23488905a67cSAndy Whitcroft			# Check for any sort of function declaration.
23498905a67cSAndy Whitcroft			# int foo(something bar, other baz);
23508905a67cSAndy Whitcroft			# void (*store_gdt)(x86_descr_ptr *);
2351171ae1a4SAndy Whitcroft			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
23528905a67cSAndy Whitcroft				my ($name_len) = length($1);
23538905a67cSAndy Whitcroft
2354cf655043SAndy Whitcroft				my $ctx = $s;
2355773647a0SAndy Whitcroft				substr($ctx, 0, $name_len + 1, '');
23568905a67cSAndy Whitcroft				$ctx =~ s/\)[^\)]*$//;
2357cf655043SAndy Whitcroft
23588905a67cSAndy Whitcroft				for my $arg (split(/\s*,\s*/, $ctx)) {
2359c45dcabdSAndy Whitcroft					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
23608905a67cSAndy Whitcroft
2361c45dcabdSAndy Whitcroft						possible($1, "D:" . $s);
23628905a67cSAndy Whitcroft					}
23638905a67cSAndy Whitcroft				}
23648905a67cSAndy Whitcroft			}
23658905a67cSAndy Whitcroft
23669c0ca6f9SAndy Whitcroft		}
23679c0ca6f9SAndy Whitcroft
236800df344fSAndy Whitcroft#
236900df344fSAndy Whitcroft# Checks which may be anchored in the context.
237000df344fSAndy Whitcroft#
237100df344fSAndy Whitcroft
237200df344fSAndy Whitcroft# Check for switch () and associated case and default
237300df344fSAndy Whitcroft# statements should be at the same indent.
237400df344fSAndy Whitcroft		if ($line=~/\bswitch\s*\(.*\)/) {
237500df344fSAndy Whitcroft			my $err = '';
237600df344fSAndy Whitcroft			my $sep = '';
237700df344fSAndy Whitcroft			my @ctx = ctx_block_outer($linenr, $realcnt);
237800df344fSAndy Whitcroft			shift(@ctx);
237900df344fSAndy Whitcroft			for my $ctx (@ctx) {
238000df344fSAndy Whitcroft				my ($clen, $cindent) = line_stats($ctx);
238100df344fSAndy Whitcroft				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
238200df344fSAndy Whitcroft							$indent != $cindent) {
238300df344fSAndy Whitcroft					$err .= "$sep$ctx\n";
238400df344fSAndy Whitcroft					$sep = '';
238500df344fSAndy Whitcroft				} else {
238600df344fSAndy Whitcroft					$sep = "[...]\n";
238700df344fSAndy Whitcroft				}
238800df344fSAndy Whitcroft			}
238900df344fSAndy Whitcroft			if ($err ne '') {
2390000d1cc1SJoe Perches				ERROR("SWITCH_CASE_INDENT_LEVEL",
2391000d1cc1SJoe Perches				      "switch and case should be at the same indent\n$hereline$err");
2392de7d4f0eSAndy Whitcroft			}
2393de7d4f0eSAndy Whitcroft		}
2394de7d4f0eSAndy Whitcroft
2395de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop,
2396de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else
2397c45dcabdSAndy Whitcroft		if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2398773647a0SAndy Whitcroft			my $pre_ctx = "$1$2";
2399773647a0SAndy Whitcroft
24009c0ca6f9SAndy Whitcroft			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
24018eef05ddSJoe Perches
24028eef05ddSJoe Perches			if ($line =~ /^\+\t{6,}/) {
24038eef05ddSJoe Perches				WARN("DEEP_INDENTATION",
24048eef05ddSJoe Perches				     "Too many leading tabs - consider code refactoring\n" . $herecurr);
24058eef05ddSJoe Perches			}
24068eef05ddSJoe Perches
2407de7d4f0eSAndy Whitcroft			my $ctx_cnt = $realcnt - $#ctx - 1;
2408de7d4f0eSAndy Whitcroft			my $ctx = join("\n", @ctx);
2409de7d4f0eSAndy Whitcroft
2410548596d5SAndy Whitcroft			my $ctx_ln = $linenr;
2411548596d5SAndy Whitcroft			my $ctx_skip = $realcnt;
2412de7d4f0eSAndy Whitcroft
2413548596d5SAndy Whitcroft			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2414548596d5SAndy Whitcroft					defined $lines[$ctx_ln - 1] &&
2415548596d5SAndy Whitcroft					$lines[$ctx_ln - 1] =~ /^-/)) {
2416548596d5SAndy Whitcroft				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2417548596d5SAndy Whitcroft				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2418773647a0SAndy Whitcroft				$ctx_ln++;
2419773647a0SAndy Whitcroft			}
2420548596d5SAndy Whitcroft
242153210168SAndy Whitcroft			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
242253210168SAndy Whitcroft			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2423773647a0SAndy Whitcroft
2424773647a0SAndy Whitcroft			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2425000d1cc1SJoe Perches				ERROR("OPEN_BRACE",
2426000d1cc1SJoe Perches				      "that open brace { should be on the previous line\n" .
242701464f30SAndy Whitcroft					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
242800df344fSAndy Whitcroft			}
2429773647a0SAndy Whitcroft			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2430773647a0SAndy Whitcroft			    $ctx =~ /\)\s*\;\s*$/ &&
2431773647a0SAndy Whitcroft			    defined $lines[$ctx_ln - 1])
2432773647a0SAndy Whitcroft			{
24339c0ca6f9SAndy Whitcroft				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
24349c0ca6f9SAndy Whitcroft				if ($nindent > $indent) {
2435000d1cc1SJoe Perches					WARN("TRAILING_SEMICOLON",
2436000d1cc1SJoe Perches					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
243701464f30SAndy Whitcroft						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
24389c0ca6f9SAndy Whitcroft				}
24399c0ca6f9SAndy Whitcroft			}
244000df344fSAndy Whitcroft		}
244100df344fSAndy Whitcroft
24424d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks.
24434d001e4dSAndy Whitcroft		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
24443e469cdcSAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
24453e469cdcSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0)
24463e469cdcSAndy Whitcroft					if (!defined $stat);
24474d001e4dSAndy Whitcroft			my ($s, $c) = ($stat, $cond);
24484d001e4dSAndy Whitcroft
24494d001e4dSAndy Whitcroft			substr($s, 0, length($c), '');
24504d001e4dSAndy Whitcroft
24514d001e4dSAndy Whitcroft			# Make sure we remove the line prefixes as we have
24524d001e4dSAndy Whitcroft			# none on the first line, and are going to readd them
24534d001e4dSAndy Whitcroft			# where necessary.
24544d001e4dSAndy Whitcroft			$s =~ s/\n./\n/gs;
24554d001e4dSAndy Whitcroft
24564d001e4dSAndy Whitcroft			# Find out how long the conditional actually is.
24576f779c18SAndy Whitcroft			my @newlines = ($c =~ /\n/gs);
24586f779c18SAndy Whitcroft			my $cond_lines = 1 + $#newlines;
24594d001e4dSAndy Whitcroft
24604d001e4dSAndy Whitcroft			# We want to check the first line inside the block
24614d001e4dSAndy Whitcroft			# starting at the end of the conditional, so remove:
24624d001e4dSAndy Whitcroft			#  1) any blank line termination
24634d001e4dSAndy Whitcroft			#  2) any opening brace { on end of the line
24644d001e4dSAndy Whitcroft			#  3) any do (...) {
24654d001e4dSAndy Whitcroft			my $continuation = 0;
24664d001e4dSAndy Whitcroft			my $check = 0;
24674d001e4dSAndy Whitcroft			$s =~ s/^.*\bdo\b//;
24684d001e4dSAndy Whitcroft			$s =~ s/^\s*{//;
24694d001e4dSAndy Whitcroft			if ($s =~ s/^\s*\\//) {
24704d001e4dSAndy Whitcroft				$continuation = 1;
24714d001e4dSAndy Whitcroft			}
24729bd49efeSAndy Whitcroft			if ($s =~ s/^\s*?\n//) {
24734d001e4dSAndy Whitcroft				$check = 1;
24744d001e4dSAndy Whitcroft				$cond_lines++;
24754d001e4dSAndy Whitcroft			}
24764d001e4dSAndy Whitcroft
24774d001e4dSAndy Whitcroft			# Also ignore a loop construct at the end of a
24784d001e4dSAndy Whitcroft			# preprocessor statement.
24794d001e4dSAndy Whitcroft			if (($prevline =~ /^.\s*#\s*define\s/ ||
24804d001e4dSAndy Whitcroft			    $prevline =~ /\\\s*$/) && $continuation == 0) {
24814d001e4dSAndy Whitcroft				$check = 0;
24824d001e4dSAndy Whitcroft			}
24834d001e4dSAndy Whitcroft
24849bd49efeSAndy Whitcroft			my $cond_ptr = -1;
2485740504c6SAndy Whitcroft			$continuation = 0;
24869bd49efeSAndy Whitcroft			while ($cond_ptr != $cond_lines) {
24879bd49efeSAndy Whitcroft				$cond_ptr = $cond_lines;
24884d001e4dSAndy Whitcroft
2489f16fa28fSAndy Whitcroft				# If we see an #else/#elif then the code
2490f16fa28fSAndy Whitcroft				# is not linear.
2491f16fa28fSAndy Whitcroft				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2492f16fa28fSAndy Whitcroft					$check = 0;
2493f16fa28fSAndy Whitcroft				}
2494f16fa28fSAndy Whitcroft
24959bd49efeSAndy Whitcroft				# Ignore:
24969bd49efeSAndy Whitcroft				#  1) blank lines, they should be at 0,
24979bd49efeSAndy Whitcroft				#  2) preprocessor lines, and
24989bd49efeSAndy Whitcroft				#  3) labels.
2499740504c6SAndy Whitcroft				if ($continuation ||
2500740504c6SAndy Whitcroft				    $s =~ /^\s*?\n/ ||
25019bd49efeSAndy Whitcroft				    $s =~ /^\s*#\s*?/ ||
25029bd49efeSAndy Whitcroft				    $s =~ /^\s*$Ident\s*:/) {
2503740504c6SAndy Whitcroft					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
250430dad6ebSAndy Whitcroft					if ($s =~ s/^.*?\n//) {
25059bd49efeSAndy Whitcroft						$cond_lines++;
25069bd49efeSAndy Whitcroft					}
25074d001e4dSAndy Whitcroft				}
250830dad6ebSAndy Whitcroft			}
25094d001e4dSAndy Whitcroft
25104d001e4dSAndy Whitcroft			my (undef, $sindent) = line_stats("+" . $s);
25114d001e4dSAndy Whitcroft			my $stat_real = raw_line($linenr, $cond_lines);
25124d001e4dSAndy Whitcroft
25134d001e4dSAndy Whitcroft			# Check if either of these lines are modified, else
25144d001e4dSAndy Whitcroft			# this is not this patch's fault.
25154d001e4dSAndy Whitcroft			if (!defined($stat_real) ||
25164d001e4dSAndy Whitcroft			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
25174d001e4dSAndy Whitcroft				$check = 0;
25184d001e4dSAndy Whitcroft			}
25194d001e4dSAndy Whitcroft			if (defined($stat_real) && $cond_lines > 1) {
25204d001e4dSAndy Whitcroft				$stat_real = "[...]\n$stat_real";
25214d001e4dSAndy Whitcroft			}
25224d001e4dSAndy Whitcroft
25239bd49efeSAndy Whitcroft			#print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
25244d001e4dSAndy Whitcroft
25254d001e4dSAndy Whitcroft			if ($check && (($sindent % 8) != 0 ||
25264d001e4dSAndy Whitcroft			    ($sindent <= $indent && $s ne ''))) {
2527000d1cc1SJoe Perches				WARN("SUSPECT_CODE_INDENT",
2528000d1cc1SJoe Perches				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
25294d001e4dSAndy Whitcroft			}
25304d001e4dSAndy Whitcroft		}
25314d001e4dSAndy Whitcroft
25326c72ffaaSAndy Whitcroft		# Track the 'values' across context and added lines.
25336c72ffaaSAndy Whitcroft		my $opline = $line; $opline =~ s/^./ /;
25341f65f947SAndy Whitcroft		my ($curr_values, $curr_vars) =
25351f65f947SAndy Whitcroft				annotate_values($opline . "\n", $prev_values);
25366c72ffaaSAndy Whitcroft		$curr_values = $prev_values . $curr_values;
2537c2fdda0dSAndy Whitcroft		if ($dbg_values) {
2538c2fdda0dSAndy Whitcroft			my $outline = $opline; $outline =~ s/\t/ /g;
2539cf655043SAndy Whitcroft			print "$linenr > .$outline\n";
2540cf655043SAndy Whitcroft			print "$linenr > $curr_values\n";
25411f65f947SAndy Whitcroft			print "$linenr >  $curr_vars\n";
2542c2fdda0dSAndy Whitcroft		}
25436c72ffaaSAndy Whitcroft		$prev_values = substr($curr_values, -1);
25446c72ffaaSAndy Whitcroft
254500df344fSAndy Whitcroft#ignore lines not being added
25463705ce5bSJoe Perches		next if ($line =~ /^[^\+]/);
254700df344fSAndy Whitcroft
2548653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher.
25497429c690SAndy Whitcroft		if ($dbg_type) {
25507429c690SAndy Whitcroft			if ($line =~ /^.\s*$Declare\s*$/) {
2551000d1cc1SJoe Perches				ERROR("TEST_TYPE",
2552000d1cc1SJoe Perches				      "TEST: is type\n" . $herecurr);
25537429c690SAndy Whitcroft			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2554000d1cc1SJoe Perches				ERROR("TEST_NOT_TYPE",
2555000d1cc1SJoe Perches				      "TEST: is not type ($1 is)\n". $herecurr);
25567429c690SAndy Whitcroft			}
2557653d4876SAndy Whitcroft			next;
2558653d4876SAndy Whitcroft		}
2559a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher.
2560a1ef277eSAndy Whitcroft		if ($dbg_attr) {
25619360b0e5SAndy Whitcroft			if ($line =~ /^.\s*$Modifier\s*$/) {
2562000d1cc1SJoe Perches				ERROR("TEST_ATTR",
2563000d1cc1SJoe Perches				      "TEST: is attr\n" . $herecurr);
25649360b0e5SAndy Whitcroft			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2565000d1cc1SJoe Perches				ERROR("TEST_NOT_ATTR",
2566000d1cc1SJoe Perches				      "TEST: is not attr ($1 is)\n". $herecurr);
2567a1ef277eSAndy Whitcroft			}
2568a1ef277eSAndy Whitcroft			next;
2569a1ef277eSAndy Whitcroft		}
2570653d4876SAndy Whitcroft
2571f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line
257299423c20SAndy Whitcroft		if ($line =~ /^.\s*{/ &&
257399423c20SAndy Whitcroft		    $prevline =~ /(?:^|[^=])=\s*$/) {
2574000d1cc1SJoe Perches			ERROR("OPEN_BRACE",
2575000d1cc1SJoe Perches			      "that open brace { should be on the previous line\n" . $hereprev);
2576f0a594c1SAndy Whitcroft		}
2577f0a594c1SAndy Whitcroft
257800df344fSAndy Whitcroft#
257900df344fSAndy Whitcroft# Checks which are anchored on the added line.
258000df344fSAndy Whitcroft#
258100df344fSAndy Whitcroft
2582653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line)
2583c45dcabdSAndy Whitcroft		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2584653d4876SAndy Whitcroft			my $path = $1;
2585653d4876SAndy Whitcroft			if ($path =~ m{//}) {
2586000d1cc1SJoe Perches				ERROR("MALFORMED_INCLUDE",
2587495e9d84SJoe Perches				      "malformed #include filename\n" . $herecurr);
2588495e9d84SJoe Perches			}
2589495e9d84SJoe Perches			if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2590495e9d84SJoe Perches				ERROR("UAPI_INCLUDE",
2591495e9d84SJoe Perches				      "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2592653d4876SAndy Whitcroft			}
2593653d4876SAndy Whitcroft		}
2594653d4876SAndy Whitcroft
259500df344fSAndy Whitcroft# no C99 // comments
259600df344fSAndy Whitcroft		if ($line =~ m{//}) {
25973705ce5bSJoe Perches			if (ERROR("C99_COMMENTS",
25983705ce5bSJoe Perches				  "do not use C99 // comments\n" . $herecurr) &&
25993705ce5bSJoe Perches			    $fix) {
26003705ce5bSJoe Perches				my $line = $fixed[$linenr - 1];
26013705ce5bSJoe Perches				if ($line =~ /\/\/(.*)$/) {
26023705ce5bSJoe Perches					my $comment = trim($1);
26033705ce5bSJoe Perches					$fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
26043705ce5bSJoe Perches				}
26053705ce5bSJoe Perches			}
260600df344fSAndy Whitcroft		}
260700df344fSAndy Whitcroft		# Remove C99 comments.
26080a920b5bSAndy Whitcroft		$line =~ s@//.*@@;
26096c72ffaaSAndy Whitcroft		$opline =~ s@//.*@@;
26100a920b5bSAndy Whitcroft
26112b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
26122b474a1aSAndy Whitcroft# the whole statement.
26132b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n";
26142b474a1aSAndy Whitcroft		if (defined $realline_next &&
26152b474a1aSAndy Whitcroft		    exists $lines[$realline_next - 1] &&
26162b474a1aSAndy Whitcroft		    !defined $suppress_export{$realline_next} &&
26172b474a1aSAndy Whitcroft		    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
26182b474a1aSAndy Whitcroft		     $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
26193cbf62dfSAndy Whitcroft			# Handle definitions which produce identifiers with
26203cbf62dfSAndy Whitcroft			# a prefix:
26213cbf62dfSAndy Whitcroft			#   XXX(foo);
26223cbf62dfSAndy Whitcroft			#   EXPORT_SYMBOL(something_foo);
2623653d4876SAndy Whitcroft			my $name = $1;
262487a53877SAndy Whitcroft			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
26253cbf62dfSAndy Whitcroft			    $name =~ /^${Ident}_$2/) {
26263cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n";
26273cbf62dfSAndy Whitcroft				$suppress_export{$realline_next} = 1;
26283cbf62dfSAndy Whitcroft
26293cbf62dfSAndy Whitcroft			} elsif ($stat !~ /(?:
26302b474a1aSAndy Whitcroft				\n.}\s*$|
263148012058SAndy Whitcroft				^.DEFINE_$Ident\(\Q$name\E\)|
263248012058SAndy Whitcroft				^.DECLARE_$Ident\(\Q$name\E\)|
263348012058SAndy Whitcroft				^.LIST_HEAD\(\Q$name\E\)|
26342b474a1aSAndy Whitcroft				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
26352b474a1aSAndy Whitcroft				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
263648012058SAndy Whitcroft			    )/x) {
26372b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
26382b474a1aSAndy Whitcroft				$suppress_export{$realline_next} = 2;
26392b474a1aSAndy Whitcroft			} else {
26402b474a1aSAndy Whitcroft				$suppress_export{$realline_next} = 1;
26410a920b5bSAndy Whitcroft			}
26420a920b5bSAndy Whitcroft		}
26432b474a1aSAndy Whitcroft		if (!defined $suppress_export{$linenr} &&
26442b474a1aSAndy Whitcroft		    $prevline =~ /^.\s*$/ &&
26452b474a1aSAndy Whitcroft		    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
26462b474a1aSAndy Whitcroft		     $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
26472b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n";
26482b474a1aSAndy Whitcroft			$suppress_export{$linenr} = 2;
26492b474a1aSAndy Whitcroft		}
26502b474a1aSAndy Whitcroft		if (defined $suppress_export{$linenr} &&
26512b474a1aSAndy Whitcroft		    $suppress_export{$linenr} == 2) {
2652000d1cc1SJoe Perches			WARN("EXPORT_SYMBOL",
2653000d1cc1SJoe Perches			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
26542b474a1aSAndy Whitcroft		}
26550a920b5bSAndy Whitcroft
26565150bda4SJoe Eloff# check for global initialisers.
2657d5e616fcSJoe Perches		if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2658d5e616fcSJoe Perches			if (ERROR("GLOBAL_INITIALISERS",
2659000d1cc1SJoe Perches				  "do not initialise globals to 0 or NULL\n" .
2660d5e616fcSJoe Perches				      $herecurr) &&
2661d5e616fcSJoe Perches			    $fix) {
2662d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2663d5e616fcSJoe Perches			}
2664f0a594c1SAndy Whitcroft		}
26650a920b5bSAndy Whitcroft# check for static initialisers.
2666d5e616fcSJoe Perches		if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2667d5e616fcSJoe Perches			if (ERROR("INITIALISED_STATIC",
2668000d1cc1SJoe Perches				  "do not initialise statics to 0 or NULL\n" .
2669d5e616fcSJoe Perches				      $herecurr) &&
2670d5e616fcSJoe Perches			    $fix) {
2671d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2672d5e616fcSJoe Perches			}
26730a920b5bSAndy Whitcroft		}
26740a920b5bSAndy Whitcroft
2675cb710ecaSJoe Perches# check for static const char * arrays.
2676cb710ecaSJoe Perches		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2677000d1cc1SJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
2678000d1cc1SJoe Perches			     "static const char * array should probably be static const char * const\n" .
2679cb710ecaSJoe Perches				$herecurr);
2680cb710ecaSJoe Perches               }
2681cb710ecaSJoe Perches
2682cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations.
2683cb710ecaSJoe Perches		if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2684000d1cc1SJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
2685000d1cc1SJoe Perches			     "static char array declaration should probably be static const char\n" .
2686cb710ecaSJoe Perches				$herecurr);
2687cb710ecaSJoe Perches               }
2688cb710ecaSJoe Perches
26899b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations.
26909b0fa60dSJoe Perches		if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
26919b0fa60dSJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
26929b0fa60dSJoe Perches			     "char * array declaration might be better as static const\n" .
26939b0fa60dSJoe Perches				$herecurr);
26949b0fa60dSJoe Perches               }
26959b0fa60dSJoe Perches
2696b36190c5SJoe Perches# check for function declarations without arguments like "int foo()"
2697b36190c5SJoe Perches		if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2698b36190c5SJoe Perches			if (ERROR("FUNCTION_WITHOUT_ARGS",
2699b36190c5SJoe Perches				  "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2700b36190c5SJoe Perches			    $fix) {
2701b36190c5SJoe Perches				$fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2702b36190c5SJoe Perches			}
2703b36190c5SJoe Perches		}
2704b36190c5SJoe Perches
270592e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE
270692e112fdSJoe Perches		if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
270792e112fdSJoe Perches			if (WARN("DEFINE_PCI_DEVICE_TABLE",
270892e112fdSJoe Perches				 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
270992e112fdSJoe Perches			    $fix) {
271092e112fdSJoe Perches				$fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
271192e112fdSJoe Perches			}
271293ed0e2dSJoe Perches		}
271393ed0e2dSJoe Perches
2714653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations
2715653d4876SAndy Whitcroft# make sense.
2716653d4876SAndy Whitcroft		if ($line =~ /\btypedef\s/ &&
27178054576dSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2718c45dcabdSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
27198ed22cadSAndy Whitcroft		    $line !~ /\b$typeTypedefs\b/ &&
2720653d4876SAndy Whitcroft		    $line !~ /\b__bitwise(?:__|)\b/) {
2721000d1cc1SJoe Perches			WARN("NEW_TYPEDEFS",
2722000d1cc1SJoe Perches			     "do not add new typedefs\n" . $herecurr);
27230a920b5bSAndy Whitcroft		}
27240a920b5bSAndy Whitcroft
27250a920b5bSAndy Whitcroft# * goes on variable not on type
272665863862SAndy Whitcroft		# (char*[ const])
2727bfcb2cc7SAndy Whitcroft		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2728bfcb2cc7SAndy Whitcroft			#print "AA<$1>\n";
27293705ce5bSJoe Perches			my ($ident, $from, $to) = ($1, $2, $2);
2730d8aaf121SAndy Whitcroft
273165863862SAndy Whitcroft			# Should start with a space.
273265863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
273365863862SAndy Whitcroft			# Should not end with a space.
273465863862SAndy Whitcroft			$to =~ s/\s+$//;
273565863862SAndy Whitcroft			# '*'s should not have spaces between.
2736f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
273765863862SAndy Whitcroft			}
2738d8aaf121SAndy Whitcroft
27393705ce5bSJoe Perches##			print "1: from<$from> to<$to> ident<$ident>\n";
274065863862SAndy Whitcroft			if ($from ne $to) {
27413705ce5bSJoe Perches				if (ERROR("POINTER_LOCATION",
27423705ce5bSJoe Perches					  "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
27433705ce5bSJoe Perches				    $fix) {
27443705ce5bSJoe Perches					my $sub_from = $ident;
27453705ce5bSJoe Perches					my $sub_to = $ident;
27463705ce5bSJoe Perches					$sub_to =~ s/\Q$from\E/$to/;
27473705ce5bSJoe Perches					$fixed[$linenr - 1] =~
27483705ce5bSJoe Perches					    s@\Q$sub_from\E@$sub_to@;
27493705ce5bSJoe Perches				}
275065863862SAndy Whitcroft			}
2751bfcb2cc7SAndy Whitcroft		}
2752bfcb2cc7SAndy Whitcroft		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2753bfcb2cc7SAndy Whitcroft			#print "BB<$1>\n";
27543705ce5bSJoe Perches			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2755d8aaf121SAndy Whitcroft
275665863862SAndy Whitcroft			# Should start with a space.
275765863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
275865863862SAndy Whitcroft			# Should not end with a space.
275965863862SAndy Whitcroft			$to =~ s/\s+$//;
276065863862SAndy Whitcroft			# '*'s should not have spaces between.
2761f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
276265863862SAndy Whitcroft			}
276365863862SAndy Whitcroft			# Modifiers should have spaces.
276465863862SAndy Whitcroft			$to =~ s/(\b$Modifier$)/$1 /;
276565863862SAndy Whitcroft
27663705ce5bSJoe Perches##			print "2: from<$from> to<$to> ident<$ident>\n";
2767667026e7SAndy Whitcroft			if ($from ne $to && $ident !~ /^$Modifier$/) {
27683705ce5bSJoe Perches				if (ERROR("POINTER_LOCATION",
27693705ce5bSJoe Perches					  "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
27703705ce5bSJoe Perches				    $fix) {
27713705ce5bSJoe Perches
27723705ce5bSJoe Perches					my $sub_from = $match;
27733705ce5bSJoe Perches					my $sub_to = $match;
27743705ce5bSJoe Perches					$sub_to =~ s/\Q$from\E/$to/;
27753705ce5bSJoe Perches					$fixed[$linenr - 1] =~
27763705ce5bSJoe Perches					    s@\Q$sub_from\E@$sub_to@;
27773705ce5bSJoe Perches				}
277865863862SAndy Whitcroft			}
27790a920b5bSAndy Whitcroft		}
27800a920b5bSAndy Whitcroft
27810a920b5bSAndy Whitcroft# # no BUG() or BUG_ON()
27820a920b5bSAndy Whitcroft# 		if ($line =~ /\b(BUG|BUG_ON)\b/) {
27830a920b5bSAndy Whitcroft# 			print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
27840a920b5bSAndy Whitcroft# 			print "$herecurr";
27850a920b5bSAndy Whitcroft# 			$clean = 0;
27860a920b5bSAndy Whitcroft# 		}
27870a920b5bSAndy Whitcroft
27888905a67cSAndy Whitcroft		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2789000d1cc1SJoe Perches			WARN("LINUX_VERSION_CODE",
2790000d1cc1SJoe Perches			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
27918905a67cSAndy Whitcroft		}
27928905a67cSAndy Whitcroft
279317441227SJoe Perches# check for uses of printk_ratelimit
279417441227SJoe Perches		if ($line =~ /\bprintk_ratelimit\s*\(/) {
2795000d1cc1SJoe Perches			WARN("PRINTK_RATELIMITED",
2796000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
279717441227SJoe Perches		}
279817441227SJoe Perches
279900df344fSAndy Whitcroft# printk should use KERN_* levels.  Note that follow on printk's on the
280000df344fSAndy Whitcroft# same line do not need a level, so we use the current block context
280100df344fSAndy Whitcroft# to try and find and validate the current printk.  In summary the current
280225985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end.
280300df344fSAndy Whitcroft# we assume the first bad printk is the one to report.
2804f0a594c1SAndy Whitcroft		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
280500df344fSAndy Whitcroft			my $ok = 0;
280600df344fSAndy Whitcroft			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
280700df344fSAndy Whitcroft				#print "CHECK<$lines[$ln - 1]\n";
280825985edcSLucas De Marchi				# we have a preceding printk if it ends
280900df344fSAndy Whitcroft				# with "\n" ignore it, else it is to blame
281000df344fSAndy Whitcroft				if ($lines[$ln - 1] =~ m{\bprintk\(}) {
281100df344fSAndy Whitcroft					if ($rawlines[$ln - 1] !~ m{\\n"}) {
281200df344fSAndy Whitcroft						$ok = 1;
281300df344fSAndy Whitcroft					}
281400df344fSAndy Whitcroft					last;
281500df344fSAndy Whitcroft				}
281600df344fSAndy Whitcroft			}
281700df344fSAndy Whitcroft			if ($ok == 0) {
2818000d1cc1SJoe Perches				WARN("PRINTK_WITHOUT_KERN_LEVEL",
2819000d1cc1SJoe Perches				     "printk() should include KERN_ facility level\n" . $herecurr);
28200a920b5bSAndy Whitcroft			}
282100df344fSAndy Whitcroft		}
28220a920b5bSAndy Whitcroft
2823243f3803SJoe Perches		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2824243f3803SJoe Perches			my $orig = $1;
2825243f3803SJoe Perches			my $level = lc($orig);
2826243f3803SJoe Perches			$level = "warn" if ($level eq "warning");
28278f26b837SJoe Perches			my $level2 = $level;
28288f26b837SJoe Perches			$level2 = "dbg" if ($level eq "debug");
2829243f3803SJoe Perches			WARN("PREFER_PR_LEVEL",
28308f26b837SJoe Perches			     "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2831243f3803SJoe Perches		}
2832243f3803SJoe Perches
2833243f3803SJoe Perches		if ($line =~ /\bpr_warning\s*\(/) {
2834d5e616fcSJoe Perches			if (WARN("PREFER_PR_LEVEL",
2835d5e616fcSJoe Perches				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2836d5e616fcSJoe Perches			    $fix) {
2837d5e616fcSJoe Perches				$fixed[$linenr - 1] =~
2838d5e616fcSJoe Perches				    s/\bpr_warning\b/pr_warn/;
2839d5e616fcSJoe Perches			}
2840243f3803SJoe Perches		}
2841243f3803SJoe Perches
2842dc139313SJoe Perches		if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2843dc139313SJoe Perches			my $orig = $1;
2844dc139313SJoe Perches			my $level = lc($orig);
2845dc139313SJoe Perches			$level = "warn" if ($level eq "warning");
2846dc139313SJoe Perches			$level = "dbg" if ($level eq "debug");
2847dc139313SJoe Perches			WARN("PREFER_DEV_LEVEL",
2848dc139313SJoe Perches			     "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2849dc139313SJoe Perches		}
2850dc139313SJoe Perches
2851653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while,
2852653d4876SAndy Whitcroft# or if closed on same line
2853c45dcabdSAndy Whitcroft		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2854c45dcabdSAndy Whitcroft		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2855000d1cc1SJoe Perches			ERROR("OPEN_BRACE",
2856000d1cc1SJoe Perches			      "open brace '{' following function declarations go on the next line\n" . $herecurr);
28570a920b5bSAndy Whitcroft		}
2858653d4876SAndy Whitcroft
28598905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line.
28608905a67cSAndy Whitcroft		if ($line =~ /^.\s*{/ &&
28618905a67cSAndy Whitcroft		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2862000d1cc1SJoe Perches			ERROR("OPEN_BRACE",
2863000d1cc1SJoe Perches			      "open brace '{' following $1 go on the same line\n" . $hereprev);
28648905a67cSAndy Whitcroft		}
28658905a67cSAndy Whitcroft
28660c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition
28673705ce5bSJoe Perches		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
28683705ce5bSJoe Perches			if (WARN("SPACING",
28693705ce5bSJoe Perches				 "missing space after $1 definition\n" . $herecurr) &&
28703705ce5bSJoe Perches			    $fix) {
28713705ce5bSJoe Perches				$fixed[$linenr - 1] =~
28723705ce5bSJoe Perches				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
28733705ce5bSJoe Perches			}
28740c73b4ebSAndy Whitcroft		}
28750c73b4ebSAndy Whitcroft
287631070b5dSJoe Perches# Function pointer declarations
287731070b5dSJoe Perches# check spacing between type, funcptr, and args
287831070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)"
287991f72e9cSJoe Perches		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
288031070b5dSJoe Perches			my $declare = $1;
288131070b5dSJoe Perches			my $pre_pointer_space = $2;
288231070b5dSJoe Perches			my $post_pointer_space = $3;
288331070b5dSJoe Perches			my $funcname = $4;
288431070b5dSJoe Perches			my $post_funcname_space = $5;
288531070b5dSJoe Perches			my $pre_args_space = $6;
288631070b5dSJoe Perches
288791f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type
288891f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types
288991f72e9cSJoe Perches# don't need a space so don't warn for those.
289091f72e9cSJoe Perches			my $post_declare_space = "";
289191f72e9cSJoe Perches			if ($declare =~ /(\s+)$/) {
289291f72e9cSJoe Perches				$post_declare_space = $1;
289391f72e9cSJoe Perches				$declare = rtrim($declare);
289491f72e9cSJoe Perches			}
289591f72e9cSJoe Perches			if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
289631070b5dSJoe Perches				WARN("SPACING",
289731070b5dSJoe Perches				     "missing space after return type\n" . $herecurr);
289891f72e9cSJoe Perches				$post_declare_space = " ";
289931070b5dSJoe Perches			}
290031070b5dSJoe Perches
290131070b5dSJoe Perches# unnecessary space "type  (*funcptr)(args...)"
290291f72e9cSJoe Perches# This test is not currently implemented because these declarations are
290391f72e9cSJoe Perches# equivalent to
290491f72e9cSJoe Perches#	int  foo(int bar, ...)
290591f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning.
290691f72e9cSJoe Perches#
290791f72e9cSJoe Perches#			elsif ($declare =~ /\s{2,}$/) {
290891f72e9cSJoe Perches#				WARN("SPACING",
290991f72e9cSJoe Perches#				     "Multiple spaces after return type\n" . $herecurr);
291091f72e9cSJoe Perches#			}
291131070b5dSJoe Perches
291231070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)"
291331070b5dSJoe Perches			if (defined $pre_pointer_space &&
291431070b5dSJoe Perches			    $pre_pointer_space =~ /^\s/) {
291531070b5dSJoe Perches				WARN("SPACING",
291631070b5dSJoe Perches				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
291731070b5dSJoe Perches			}
291831070b5dSJoe Perches
291931070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)"
292031070b5dSJoe Perches			if (defined $post_pointer_space &&
292131070b5dSJoe Perches			    $post_pointer_space =~ /^\s/) {
292231070b5dSJoe Perches				WARN("SPACING",
292331070b5dSJoe Perches				     "Unnecessary space before function pointer name\n" . $herecurr);
292431070b5dSJoe Perches			}
292531070b5dSJoe Perches
292631070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)"
292731070b5dSJoe Perches			if (defined $post_funcname_space &&
292831070b5dSJoe Perches			    $post_funcname_space =~ /^\s/) {
292931070b5dSJoe Perches				WARN("SPACING",
293031070b5dSJoe Perches				     "Unnecessary space after function pointer name\n" . $herecurr);
293131070b5dSJoe Perches			}
293231070b5dSJoe Perches
293331070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)"
293431070b5dSJoe Perches			if (defined $pre_args_space &&
293531070b5dSJoe Perches			    $pre_args_space =~ /^\s/) {
293631070b5dSJoe Perches				WARN("SPACING",
293731070b5dSJoe Perches				     "Unnecessary space before function pointer arguments\n" . $herecurr);
293831070b5dSJoe Perches			}
293931070b5dSJoe Perches
294031070b5dSJoe Perches			if (show_type("SPACING") && $fix) {
294131070b5dSJoe Perches				$fixed[$linenr - 1] =~
294291f72e9cSJoe Perches				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
294331070b5dSJoe Perches			}
294431070b5dSJoe Perches		}
294531070b5dSJoe Perches
29468d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed:
29478d31cfceSAndy Whitcroft#  1. with a type on the left -- int [] a;
2948fe2a7dbcSAndy Whitcroft#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2949fe2a7dbcSAndy Whitcroft#  3. inside a curly brace -- = { [0...10] = 5 }
29508d31cfceSAndy Whitcroft		while ($line =~ /(.*?\s)\[/g) {
29518d31cfceSAndy Whitcroft			my ($where, $prefix) = ($-[1], $1);
29528d31cfceSAndy Whitcroft			if ($prefix !~ /$Type\s+$/ &&
2953fe2a7dbcSAndy Whitcroft			    ($where != 0 || $prefix !~ /^.\s+$/) &&
2954daebc534SAndy Whitcroft			    $prefix !~ /[{,]\s+$/) {
29553705ce5bSJoe Perches				if (ERROR("BRACKET_SPACE",
29563705ce5bSJoe Perches					  "space prohibited before open square bracket '['\n" . $herecurr) &&
29573705ce5bSJoe Perches				    $fix) {
29583705ce5bSJoe Perches				    $fixed[$linenr - 1] =~
29593705ce5bSJoe Perches					s/^(\+.*?)\s+\[/$1\[/;
29603705ce5bSJoe Perches				}
29618d31cfceSAndy Whitcroft			}
29628d31cfceSAndy Whitcroft		}
29638d31cfceSAndy Whitcroft
2964f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses.
29656c72ffaaSAndy Whitcroft		while ($line =~ /($Ident)\s+\(/g) {
2966c2fdda0dSAndy Whitcroft			my $name = $1;
2967773647a0SAndy Whitcroft			my $ctx_before = substr($line, 0, $-[1]);
2968773647a0SAndy Whitcroft			my $ctx = "$ctx_before$name";
2969c2fdda0dSAndy Whitcroft
2970c2fdda0dSAndy Whitcroft			# Ignore those directives where spaces _are_ permitted.
2971773647a0SAndy Whitcroft			if ($name =~ /^(?:
2972773647a0SAndy Whitcroft				if|for|while|switch|return|case|
2973773647a0SAndy Whitcroft				volatile|__volatile__|
2974773647a0SAndy Whitcroft				__attribute__|format|__extension__|
2975773647a0SAndy Whitcroft				asm|__asm__)$/x)
2976773647a0SAndy Whitcroft			{
2977c2fdda0dSAndy Whitcroft			# cpp #define statements have non-optional spaces, ie
2978c2fdda0dSAndy Whitcroft			# if there is a space between the name and the open
2979c2fdda0dSAndy Whitcroft			# parenthesis it is simply not a parameter group.
2980c45dcabdSAndy Whitcroft			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2981773647a0SAndy Whitcroft
2982773647a0SAndy Whitcroft			# cpp #elif statement condition may start with a (
2983c45dcabdSAndy Whitcroft			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2984c2fdda0dSAndy Whitcroft
2985c2fdda0dSAndy Whitcroft			# If this whole things ends with a type its most
2986c2fdda0dSAndy Whitcroft			# likely a typedef for a function.
2987773647a0SAndy Whitcroft			} elsif ($ctx =~ /$Type$/) {
2988c2fdda0dSAndy Whitcroft
2989c2fdda0dSAndy Whitcroft			} else {
29903705ce5bSJoe Perches				if (WARN("SPACING",
29913705ce5bSJoe Perches					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
29923705ce5bSJoe Perches					     $fix) {
29933705ce5bSJoe Perches					$fixed[$linenr - 1] =~
29943705ce5bSJoe Perches					    s/\b$name\s+\(/$name\(/;
29953705ce5bSJoe Perches				}
2996f0a594c1SAndy Whitcroft			}
29976c72ffaaSAndy Whitcroft		}
29989a4cad4eSEric Nelson
2999653d4876SAndy Whitcroft# Check operator spacing.
30000a920b5bSAndy Whitcroft		if (!($line=~/\#\s*include/)) {
30013705ce5bSJoe Perches			my $fixed_line = "";
30023705ce5bSJoe Perches			my $line_fixed = 0;
30033705ce5bSJoe Perches
30049c0ca6f9SAndy Whitcroft			my $ops = qr{
30059c0ca6f9SAndy Whitcroft				<<=|>>=|<=|>=|==|!=|
30069c0ca6f9SAndy Whitcroft				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
30079c0ca6f9SAndy Whitcroft				=>|->|<<|>>|<|>|=|!|~|
30081f65f947SAndy Whitcroft				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
300984731623SJoe Perches				\?:|\?|:
30109c0ca6f9SAndy Whitcroft			}x;
3011cf655043SAndy Whitcroft			my @elements = split(/($ops|;)/, $opline);
30123705ce5bSJoe Perches
30133705ce5bSJoe Perches##			print("element count: <" . $#elements . ">\n");
30143705ce5bSJoe Perches##			foreach my $el (@elements) {
30153705ce5bSJoe Perches##				print("el: <$el>\n");
30163705ce5bSJoe Perches##			}
30173705ce5bSJoe Perches
30183705ce5bSJoe Perches			my @fix_elements = ();
301900df344fSAndy Whitcroft			my $off = 0;
30206c72ffaaSAndy Whitcroft
30213705ce5bSJoe Perches			foreach my $el (@elements) {
30223705ce5bSJoe Perches				push(@fix_elements, substr($rawline, $off, length($el)));
30233705ce5bSJoe Perches				$off += length($el);
30243705ce5bSJoe Perches			}
30253705ce5bSJoe Perches
30263705ce5bSJoe Perches			$off = 0;
30273705ce5bSJoe Perches
30286c72ffaaSAndy Whitcroft			my $blank = copy_spacing($opline);
3029b34c648bSJoe Perches			my $last_after = -1;
30306c72ffaaSAndy Whitcroft
30310a920b5bSAndy Whitcroft			for (my $n = 0; $n < $#elements; $n += 2) {
30323705ce5bSJoe Perches
30333705ce5bSJoe Perches				my $good = $fix_elements[$n] . $fix_elements[$n + 1];
30343705ce5bSJoe Perches
30353705ce5bSJoe Perches##				print("n: <$n> good: <$good>\n");
30363705ce5bSJoe Perches
30374a0df2efSAndy Whitcroft				$off += length($elements[$n]);
30384a0df2efSAndy Whitcroft
303925985edcSLucas De Marchi				# Pick up the preceding and succeeding characters.
3040773647a0SAndy Whitcroft				my $ca = substr($opline, 0, $off);
3041773647a0SAndy Whitcroft				my $cc = '';
3042773647a0SAndy Whitcroft				if (length($opline) >= ($off + length($elements[$n + 1]))) {
3043773647a0SAndy Whitcroft					$cc = substr($opline, $off + length($elements[$n + 1]));
3044773647a0SAndy Whitcroft				}
3045773647a0SAndy Whitcroft				my $cb = "$ca$;$cc";
3046773647a0SAndy Whitcroft
30474a0df2efSAndy Whitcroft				my $a = '';
30484a0df2efSAndy Whitcroft				$a = 'V' if ($elements[$n] ne '');
30494a0df2efSAndy Whitcroft				$a = 'W' if ($elements[$n] =~ /\s$/);
3050cf655043SAndy Whitcroft				$a = 'C' if ($elements[$n] =~ /$;$/);
30514a0df2efSAndy Whitcroft				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
30524a0df2efSAndy Whitcroft				$a = 'O' if ($elements[$n] eq '');
3053773647a0SAndy Whitcroft				$a = 'E' if ($ca =~ /^\s*$/);
30544a0df2efSAndy Whitcroft
30550a920b5bSAndy Whitcroft				my $op = $elements[$n + 1];
30564a0df2efSAndy Whitcroft
30574a0df2efSAndy Whitcroft				my $c = '';
30580a920b5bSAndy Whitcroft				if (defined $elements[$n + 2]) {
30594a0df2efSAndy Whitcroft					$c = 'V' if ($elements[$n + 2] ne '');
30604a0df2efSAndy Whitcroft					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
3061cf655043SAndy Whitcroft					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
30624a0df2efSAndy Whitcroft					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
30634a0df2efSAndy Whitcroft					$c = 'O' if ($elements[$n + 2] eq '');
30648b1b3378SAndy Whitcroft					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
30654a0df2efSAndy Whitcroft				} else {
30664a0df2efSAndy Whitcroft					$c = 'E';
30670a920b5bSAndy Whitcroft				}
30680a920b5bSAndy Whitcroft
30694a0df2efSAndy Whitcroft				my $ctx = "${a}x${c}";
30704a0df2efSAndy Whitcroft
30714a0df2efSAndy Whitcroft				my $at = "(ctx:$ctx)";
30724a0df2efSAndy Whitcroft
30736c72ffaaSAndy Whitcroft				my $ptr = substr($blank, 0, $off) . "^";
3074de7d4f0eSAndy Whitcroft				my $hereptr = "$hereline$ptr\n";
30750a920b5bSAndy Whitcroft
307674048ed8SAndy Whitcroft				# Pull out the value of this operator.
30776c72ffaaSAndy Whitcroft				my $op_type = substr($curr_values, $off + 1, 1);
30780a920b5bSAndy Whitcroft
30791f65f947SAndy Whitcroft				# Get the full operator variant.
30801f65f947SAndy Whitcroft				my $opv = $op . substr($curr_vars, $off, 1);
30811f65f947SAndy Whitcroft
308213214adfSAndy Whitcroft				# Ignore operators passed as parameters.
308313214adfSAndy Whitcroft				if ($op_type ne 'V' &&
308413214adfSAndy Whitcroft				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {
308513214adfSAndy Whitcroft
3086cf655043SAndy Whitcroft#				# Ignore comments
3087cf655043SAndy Whitcroft#				} elsif ($op =~ /^$;+$/) {
308813214adfSAndy Whitcroft
3089d8aaf121SAndy Whitcroft				# ; should have either the end of line or a space or \ after it
309013214adfSAndy Whitcroft				} elsif ($op eq ';') {
3091cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEBC]/ &&
3092cf655043SAndy Whitcroft					    $cc !~ /^\\/ && $cc !~ /^;/) {
30933705ce5bSJoe Perches						if (ERROR("SPACING",
30943705ce5bSJoe Perches							  "space required after that '$op' $at\n" . $hereptr)) {
3095b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
30963705ce5bSJoe Perches							$line_fixed = 1;
30973705ce5bSJoe Perches						}
3098d8aaf121SAndy Whitcroft					}
3099d8aaf121SAndy Whitcroft
3100d8aaf121SAndy Whitcroft				# // is a comment
3101d8aaf121SAndy Whitcroft				} elsif ($op eq '//') {
31020a920b5bSAndy Whitcroft
31031f65f947SAndy Whitcroft				# No spaces for:
31041f65f947SAndy Whitcroft				#   ->
31051f65f947SAndy Whitcroft				#   :   when part of a bitfield
31061f65f947SAndy Whitcroft				} elsif ($op eq '->' || $opv eq ':B') {
31074a0df2efSAndy Whitcroft					if ($ctx =~ /Wx.|.xW/) {
31083705ce5bSJoe Perches						if (ERROR("SPACING",
31093705ce5bSJoe Perches							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3110b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
31113705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
31123705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
31133705ce5bSJoe Perches							}
3114b34c648bSJoe Perches							$line_fixed = 1;
31153705ce5bSJoe Perches						}
31160a920b5bSAndy Whitcroft					}
31170a920b5bSAndy Whitcroft
31180a920b5bSAndy Whitcroft				# , must have a space on the right.
31190a920b5bSAndy Whitcroft				} elsif ($op eq ',') {
3120cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
31213705ce5bSJoe Perches						if (ERROR("SPACING",
31223705ce5bSJoe Perches							  "space required after that '$op' $at\n" . $hereptr)) {
3123b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
31243705ce5bSJoe Perches							$line_fixed = 1;
3125b34c648bSJoe Perches							$last_after = $n;
31263705ce5bSJoe Perches						}
31270a920b5bSAndy Whitcroft					}
31280a920b5bSAndy Whitcroft
31299c0ca6f9SAndy Whitcroft				# '*' as part of a type definition -- reported already.
313074048ed8SAndy Whitcroft				} elsif ($opv eq '*_') {
31319c0ca6f9SAndy Whitcroft					#warn "'*' is part of type\n";
31329c0ca6f9SAndy Whitcroft
31339c0ca6f9SAndy Whitcroft				# unary operators should have a space before and
31349c0ca6f9SAndy Whitcroft				# none after.  May be left adjacent to another
31359c0ca6f9SAndy Whitcroft				# unary operator, or a cast
31369c0ca6f9SAndy Whitcroft				} elsif ($op eq '!' || $op eq '~' ||
313774048ed8SAndy Whitcroft					 $opv eq '*U' || $opv eq '-U' ||
31380d413866SAndy Whitcroft					 $opv eq '&U' || $opv eq '&&U') {
3139cf655043SAndy Whitcroft					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
31403705ce5bSJoe Perches						if (ERROR("SPACING",
31413705ce5bSJoe Perches							  "space required before that '$op' $at\n" . $hereptr)) {
3142b34c648bSJoe Perches							if ($n != $last_after + 2) {
3143b34c648bSJoe Perches								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
31443705ce5bSJoe Perches								$line_fixed = 1;
31453705ce5bSJoe Perches							}
31460a920b5bSAndy Whitcroft						}
3147b34c648bSJoe Perches					}
3148a3340b35SAndy Whitcroft					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3149171ae1a4SAndy Whitcroft						# A unary '*' may be const
3150171ae1a4SAndy Whitcroft
3151171ae1a4SAndy Whitcroft					} elsif ($ctx =~ /.xW/) {
31523705ce5bSJoe Perches						if (ERROR("SPACING",
31533705ce5bSJoe Perches							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3154b34c648bSJoe Perches							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
31553705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
31563705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
31573705ce5bSJoe Perches							}
3158b34c648bSJoe Perches							$line_fixed = 1;
31593705ce5bSJoe Perches						}
31600a920b5bSAndy Whitcroft					}
31610a920b5bSAndy Whitcroft
31620a920b5bSAndy Whitcroft				# unary ++ and unary -- are allowed no space on one side.
31630a920b5bSAndy Whitcroft				} elsif ($op eq '++' or $op eq '--') {
3164773647a0SAndy Whitcroft					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
31653705ce5bSJoe Perches						if (ERROR("SPACING",
31663705ce5bSJoe Perches							  "space required one side of that '$op' $at\n" . $hereptr)) {
3167b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
31683705ce5bSJoe Perches							$line_fixed = 1;
31693705ce5bSJoe Perches						}
31700a920b5bSAndy Whitcroft					}
3171773647a0SAndy Whitcroft					if ($ctx =~ /Wx[BE]/ ||
3172773647a0SAndy Whitcroft					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
31733705ce5bSJoe Perches						if (ERROR("SPACING",
31743705ce5bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3175b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
31763705ce5bSJoe Perches							$line_fixed = 1;
31773705ce5bSJoe Perches						}
3178653d4876SAndy Whitcroft					}
3179773647a0SAndy Whitcroft					if ($ctx =~ /ExW/) {
31803705ce5bSJoe Perches						if (ERROR("SPACING",
31813705ce5bSJoe Perches							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3182b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
31833705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
31843705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
3185773647a0SAndy Whitcroft							}
3186b34c648bSJoe Perches							$line_fixed = 1;
31873705ce5bSJoe Perches						}
31883705ce5bSJoe Perches					}
31890a920b5bSAndy Whitcroft
31900a920b5bSAndy Whitcroft				# << and >> may either have or not have spaces both sides
31919c0ca6f9SAndy Whitcroft				} elsif ($op eq '<<' or $op eq '>>' or
31929c0ca6f9SAndy Whitcroft					 $op eq '&' or $op eq '^' or $op eq '|' or
31939c0ca6f9SAndy Whitcroft					 $op eq '+' or $op eq '-' or
3194c2fdda0dSAndy Whitcroft					 $op eq '*' or $op eq '/' or
3195c2fdda0dSAndy Whitcroft					 $op eq '%')
31960a920b5bSAndy Whitcroft				{
3197773647a0SAndy Whitcroft					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
31983705ce5bSJoe Perches						if (ERROR("SPACING",
31993705ce5bSJoe Perches							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
3200b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3201b34c648bSJoe Perches							if (defined $fix_elements[$n + 2]) {
3202b34c648bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
3203b34c648bSJoe Perches							}
32043705ce5bSJoe Perches							$line_fixed = 1;
32053705ce5bSJoe Perches						}
32060a920b5bSAndy Whitcroft					}
32070a920b5bSAndy Whitcroft
32081f65f947SAndy Whitcroft				# A colon needs no spaces before when it is
32091f65f947SAndy Whitcroft				# terminating a case value or a label.
32101f65f947SAndy Whitcroft				} elsif ($opv eq ':C' || $opv eq ':L') {
32111f65f947SAndy Whitcroft					if ($ctx =~ /Wx./) {
32123705ce5bSJoe Perches						if (ERROR("SPACING",
32133705ce5bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3214b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
32153705ce5bSJoe Perches							$line_fixed = 1;
32163705ce5bSJoe Perches						}
32171f65f947SAndy Whitcroft					}
32181f65f947SAndy Whitcroft
32190a920b5bSAndy Whitcroft				# All the others need spaces both sides.
3220cf655043SAndy Whitcroft				} elsif ($ctx !~ /[EWC]x[CWE]/) {
32211f65f947SAndy Whitcroft					my $ok = 0;
32221f65f947SAndy Whitcroft
322322f2a2efSAndy Whitcroft					# Ignore email addresses <foo@bar>
32241f65f947SAndy Whitcroft					if (($op eq '<' &&
32251f65f947SAndy Whitcroft					     $cc =~ /^\S+\@\S+>/) ||
32261f65f947SAndy Whitcroft					    ($op eq '>' &&
32271f65f947SAndy Whitcroft					     $ca =~ /<\S+\@\S+$/))
32281f65f947SAndy Whitcroft					{
32291f65f947SAndy Whitcroft					    	$ok = 1;
32301f65f947SAndy Whitcroft					}
32311f65f947SAndy Whitcroft
323284731623SJoe Perches					# messages are ERROR, but ?: are CHK
32331f65f947SAndy Whitcroft					if ($ok == 0) {
323484731623SJoe Perches						my $msg_type = \&ERROR;
323584731623SJoe Perches						$msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
323684731623SJoe Perches
323784731623SJoe Perches						if (&{$msg_type}("SPACING",
32383705ce5bSJoe Perches								 "spaces required around that '$op' $at\n" . $hereptr)) {
3239b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3240b34c648bSJoe Perches							if (defined $fix_elements[$n + 2]) {
3241b34c648bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
3242b34c648bSJoe Perches							}
32433705ce5bSJoe Perches							$line_fixed = 1;
32443705ce5bSJoe Perches						}
32450a920b5bSAndy Whitcroft					}
324622f2a2efSAndy Whitcroft				}
32474a0df2efSAndy Whitcroft				$off += length($elements[$n + 1]);
32483705ce5bSJoe Perches
32493705ce5bSJoe Perches##				print("n: <$n> GOOD: <$good>\n");
32503705ce5bSJoe Perches
32513705ce5bSJoe Perches				$fixed_line = $fixed_line . $good;
32520a920b5bSAndy Whitcroft			}
32533705ce5bSJoe Perches
32543705ce5bSJoe Perches			if (($#elements % 2) == 0) {
32553705ce5bSJoe Perches				$fixed_line = $fixed_line . $fix_elements[$#elements];
32563705ce5bSJoe Perches			}
32573705ce5bSJoe Perches
32583705ce5bSJoe Perches			if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
32593705ce5bSJoe Perches				$fixed[$linenr - 1] = $fixed_line;
32603705ce5bSJoe Perches			}
32613705ce5bSJoe Perches
32623705ce5bSJoe Perches
32630a920b5bSAndy Whitcroft		}
32640a920b5bSAndy Whitcroft
3265786b6326SJoe Perches# check for whitespace before a non-naked semicolon
3266d2e248e7SJoe Perches		if ($line =~ /^\+.*\S\s+;\s*$/) {
3267786b6326SJoe Perches			if (WARN("SPACING",
3268786b6326SJoe Perches				 "space prohibited before semicolon\n" . $herecurr) &&
3269786b6326SJoe Perches			    $fix) {
3270786b6326SJoe Perches				1 while $fixed[$linenr - 1] =~
3271786b6326SJoe Perches				    s/^(\+.*\S)\s+;/$1;/;
3272786b6326SJoe Perches			}
3273786b6326SJoe Perches		}
3274786b6326SJoe Perches
3275f0a594c1SAndy Whitcroft# check for multiple assignments
3276f0a594c1SAndy Whitcroft		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3277000d1cc1SJoe Perches			CHK("MULTIPLE_ASSIGNMENTS",
3278000d1cc1SJoe Perches			    "multiple assignments should be avoided\n" . $herecurr);
3279f0a594c1SAndy Whitcroft		}
3280f0a594c1SAndy Whitcroft
328122f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration
328222f2a2efSAndy Whitcroft## # continuation.
328322f2a2efSAndy Whitcroft## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
328422f2a2efSAndy Whitcroft## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
328522f2a2efSAndy Whitcroft##
328622f2a2efSAndy Whitcroft## 			# Remove any bracketed sections to ensure we do not
328722f2a2efSAndy Whitcroft## 			# falsly report the parameters of functions.
328822f2a2efSAndy Whitcroft## 			my $ln = $line;
328922f2a2efSAndy Whitcroft## 			while ($ln =~ s/\([^\(\)]*\)//g) {
329022f2a2efSAndy Whitcroft## 			}
329122f2a2efSAndy Whitcroft## 			if ($ln =~ /,/) {
3292000d1cc1SJoe Perches## 				WARN("MULTIPLE_DECLARATION",
3293000d1cc1SJoe Perches##				     "declaring multiple variables together should be avoided\n" . $herecurr);
329422f2a2efSAndy Whitcroft## 			}
329522f2a2efSAndy Whitcroft## 		}
3296f0a594c1SAndy Whitcroft
32970a920b5bSAndy Whitcroft#need space before brace following if, while, etc
329822f2a2efSAndy Whitcroft		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
329922f2a2efSAndy Whitcroft		    $line =~ /do{/) {
33003705ce5bSJoe Perches			if (ERROR("SPACING",
33013705ce5bSJoe Perches				  "space required before the open brace '{'\n" . $herecurr) &&
33023705ce5bSJoe Perches			    $fix) {
3303d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
33043705ce5bSJoe Perches			}
3305de7d4f0eSAndy Whitcroft		}
3306de7d4f0eSAndy Whitcroft
3307c4a62ef9SJoe Perches## # check for blank lines before declarations
3308c4a62ef9SJoe Perches##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3309c4a62ef9SJoe Perches##		    $prevrawline =~ /^.\s*$/) {
3310c4a62ef9SJoe Perches##			WARN("SPACING",
3311c4a62ef9SJoe Perches##			     "No blank lines before declarations\n" . $hereprev);
3312c4a62ef9SJoe Perches##		}
3313c4a62ef9SJoe Perches##
3314c4a62ef9SJoe Perches
3315de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything
3316de7d4f0eSAndy Whitcroft# on the line
3317de7d4f0eSAndy Whitcroft		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3318d5e616fcSJoe Perches			if (ERROR("SPACING",
3319d5e616fcSJoe Perches				  "space required after that close brace '}'\n" . $herecurr) &&
3320d5e616fcSJoe Perches			    $fix) {
3321d5e616fcSJoe Perches				$fixed[$linenr - 1] =~
3322d5e616fcSJoe Perches				    s/}((?!(?:,|;|\)))\S)/} $1/;
3323d5e616fcSJoe Perches			}
33240a920b5bSAndy Whitcroft		}
33250a920b5bSAndy Whitcroft
332622f2a2efSAndy Whitcroft# check spacing on square brackets
332722f2a2efSAndy Whitcroft		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
33283705ce5bSJoe Perches			if (ERROR("SPACING",
33293705ce5bSJoe Perches				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
33303705ce5bSJoe Perches			    $fix) {
33313705ce5bSJoe Perches				$fixed[$linenr - 1] =~
33323705ce5bSJoe Perches				    s/\[\s+/\[/;
33333705ce5bSJoe Perches			}
333422f2a2efSAndy Whitcroft		}
333522f2a2efSAndy Whitcroft		if ($line =~ /\s\]/) {
33363705ce5bSJoe Perches			if (ERROR("SPACING",
33373705ce5bSJoe Perches				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
33383705ce5bSJoe Perches			    $fix) {
33393705ce5bSJoe Perches				$fixed[$linenr - 1] =~
33403705ce5bSJoe Perches				    s/\s+\]/\]/;
33413705ce5bSJoe Perches			}
334222f2a2efSAndy Whitcroft		}
334322f2a2efSAndy Whitcroft
3344c45dcabdSAndy Whitcroft# check spacing on parentheses
33459c0ca6f9SAndy Whitcroft		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
33469c0ca6f9SAndy Whitcroft		    $line !~ /for\s*\(\s+;/) {
33473705ce5bSJoe Perches			if (ERROR("SPACING",
33483705ce5bSJoe Perches				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
33493705ce5bSJoe Perches			    $fix) {
33503705ce5bSJoe Perches				$fixed[$linenr - 1] =~
33513705ce5bSJoe Perches				    s/\(\s+/\(/;
33523705ce5bSJoe Perches			}
335322f2a2efSAndy Whitcroft		}
335413214adfSAndy Whitcroft		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3355c45dcabdSAndy Whitcroft		    $line !~ /for\s*\(.*;\s+\)/ &&
3356c45dcabdSAndy Whitcroft		    $line !~ /:\s+\)/) {
33573705ce5bSJoe Perches			if (ERROR("SPACING",
33583705ce5bSJoe Perches				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
33593705ce5bSJoe Perches			    $fix) {
33603705ce5bSJoe Perches				$fixed[$linenr - 1] =~
33613705ce5bSJoe Perches				    s/\s+\)/\)/;
33623705ce5bSJoe Perches			}
336322f2a2efSAndy Whitcroft		}
336422f2a2efSAndy Whitcroft
33650a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however
33664a0df2efSAndy Whitcroft		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
33670a920b5bSAndy Whitcroft		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
33683705ce5bSJoe Perches			if (WARN("INDENTED_LABEL",
33693705ce5bSJoe Perches				 "labels should not be indented\n" . $herecurr) &&
33703705ce5bSJoe Perches			    $fix) {
33713705ce5bSJoe Perches				$fixed[$linenr - 1] =~
33723705ce5bSJoe Perches				    s/^(.)\s+/$1/;
33733705ce5bSJoe Perches			}
33740a920b5bSAndy Whitcroft		}
33750a920b5bSAndy Whitcroft
3376c45dcabdSAndy Whitcroft# Return is not a function.
3377507e5141SJoe Perches		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3378c45dcabdSAndy Whitcroft			my $spacing = $1;
3379507e5141SJoe Perches			if ($^V && $^V ge 5.10.0 &&
3380507e5141SJoe Perches			    $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) {
3381000d1cc1SJoe Perches				ERROR("RETURN_PARENTHESES",
3382000d1cc1SJoe Perches				      "return is not a function, parentheses are not required\n" . $herecurr);
3383c45dcabdSAndy Whitcroft
3384c45dcabdSAndy Whitcroft			} elsif ($spacing !~ /\s+/) {
3385000d1cc1SJoe Perches				ERROR("SPACING",
3386000d1cc1SJoe Perches				      "space required before the open parenthesis '('\n" . $herecurr);
3387c45dcabdSAndy Whitcroft			}
3388c45dcabdSAndy Whitcroft		}
3389507e5141SJoe Perches
3390189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar))
3391189248d8SJoe Perches		if ($^V && $^V ge 5.10.0 &&
3392189248d8SJoe Perches		    $line =~ /\bif\s*((?:\(\s*){2,})/) {
3393189248d8SJoe Perches			my $openparens = $1;
3394189248d8SJoe Perches			my $count = $openparens =~ tr@\(@\(@;
3395189248d8SJoe Perches			my $msg = "";
3396189248d8SJoe Perches			if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3397189248d8SJoe Perches				my $comp = $4;	#Not $1 because of $LvalOrFunc
3398189248d8SJoe Perches				$msg = " - maybe == should be = ?" if ($comp eq "==");
3399189248d8SJoe Perches				WARN("UNNECESSARY_PARENTHESES",
3400189248d8SJoe Perches				     "Unnecessary parentheses$msg\n" . $herecurr);
3401189248d8SJoe Perches			}
3402189248d8SJoe Perches		}
3403189248d8SJoe Perches
340453a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve
340553a3c448SAndy Whitcroft		if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
340653a3c448SAndy Whitcroft			my $name = $1;
340753a3c448SAndy Whitcroft			if ($name ne 'EOF' && $name ne 'ERROR') {
3408000d1cc1SJoe Perches				WARN("USE_NEGATIVE_ERRNO",
3409000d1cc1SJoe Perches				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
341053a3c448SAndy Whitcroft			}
341153a3c448SAndy Whitcroft		}
3412c45dcabdSAndy Whitcroft
34130a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc
34144a0df2efSAndy Whitcroft		if ($line =~ /\b(if|while|for|switch)\(/) {
34153705ce5bSJoe Perches			if (ERROR("SPACING",
34163705ce5bSJoe Perches				  "space required before the open parenthesis '('\n" . $herecurr) &&
34173705ce5bSJoe Perches			    $fix) {
34183705ce5bSJoe Perches				$fixed[$linenr - 1] =~
34193705ce5bSJoe Perches				    s/\b(if|while|for|switch)\(/$1 \(/;
34203705ce5bSJoe Perches			}
34210a920b5bSAndy Whitcroft		}
34220a920b5bSAndy Whitcroft
3423f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing
3424f5fe35ddSAndy Whitcroft# statements after the conditional.
3425170d3a22SAndy Whitcroft		if ($line =~ /do\s*(?!{)/) {
34263e469cdcSAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
34273e469cdcSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0)
34283e469cdcSAndy Whitcroft					if (!defined $stat);
3429170d3a22SAndy Whitcroft			my ($stat_next) = ctx_statement_block($line_nr_next,
3430170d3a22SAndy Whitcroft						$remain_next, $off_next);
3431170d3a22SAndy Whitcroft			$stat_next =~ s/\n./\n /g;
3432170d3a22SAndy Whitcroft			##print "stat<$stat> stat_next<$stat_next>\n";
3433170d3a22SAndy Whitcroft
3434170d3a22SAndy Whitcroft			if ($stat_next =~ /^\s*while\b/) {
3435170d3a22SAndy Whitcroft				# If the statement carries leading newlines,
3436170d3a22SAndy Whitcroft				# then count those as offsets.
3437170d3a22SAndy Whitcroft				my ($whitespace) =
3438170d3a22SAndy Whitcroft					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3439170d3a22SAndy Whitcroft				my $offset =
3440170d3a22SAndy Whitcroft					statement_rawlines($whitespace) - 1;
3441170d3a22SAndy Whitcroft
3442170d3a22SAndy Whitcroft				$suppress_whiletrailers{$line_nr_next +
3443170d3a22SAndy Whitcroft								$offset} = 1;
3444170d3a22SAndy Whitcroft			}
3445170d3a22SAndy Whitcroft		}
3446170d3a22SAndy Whitcroft		if (!defined $suppress_whiletrailers{$linenr} &&
3447c11230f4SJoe Perches		    defined($stat) && defined($cond) &&
3448170d3a22SAndy Whitcroft		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3449171ae1a4SAndy Whitcroft			my ($s, $c) = ($stat, $cond);
34508905a67cSAndy Whitcroft
3451b53c8e10SAndy Whitcroft			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3452000d1cc1SJoe Perches				ERROR("ASSIGN_IN_IF",
3453000d1cc1SJoe Perches				      "do not use assignment in if condition\n" . $herecurr);
34548905a67cSAndy Whitcroft			}
34558905a67cSAndy Whitcroft
34568905a67cSAndy Whitcroft			# Find out what is on the end of the line after the
34578905a67cSAndy Whitcroft			# conditional.
3458773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
34598905a67cSAndy Whitcroft			$s =~ s/\n.*//g;
346013214adfSAndy Whitcroft			$s =~ s/$;//g; 	# Remove any comments
346153210168SAndy Whitcroft			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
346253210168SAndy Whitcroft			    $c !~ /}\s*while\s*/)
3463773647a0SAndy Whitcroft			{
3464bb44ad39SAndy Whitcroft				# Find out how long the conditional actually is.
3465bb44ad39SAndy Whitcroft				my @newlines = ($c =~ /\n/gs);
3466bb44ad39SAndy Whitcroft				my $cond_lines = 1 + $#newlines;
346742bdf74cSHidetoshi Seto				my $stat_real = '';
3468bb44ad39SAndy Whitcroft
346942bdf74cSHidetoshi Seto				$stat_real = raw_line($linenr, $cond_lines)
347042bdf74cSHidetoshi Seto							. "\n" if ($cond_lines);
3471bb44ad39SAndy Whitcroft				if (defined($stat_real) && $cond_lines > 1) {
3472bb44ad39SAndy Whitcroft					$stat_real = "[...]\n$stat_real";
3473bb44ad39SAndy Whitcroft				}
3474bb44ad39SAndy Whitcroft
3475000d1cc1SJoe Perches				ERROR("TRAILING_STATEMENTS",
3476000d1cc1SJoe Perches				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
34778905a67cSAndy Whitcroft			}
34788905a67cSAndy Whitcroft		}
34798905a67cSAndy Whitcroft
348013214adfSAndy Whitcroft# Check for bitwise tests written as boolean
348113214adfSAndy Whitcroft		if ($line =~ /
348213214adfSAndy Whitcroft			(?:
348313214adfSAndy Whitcroft				(?:\[|\(|\&\&|\|\|)
348413214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
348513214adfSAndy Whitcroft				(?:\&\&|\|\|)
348613214adfSAndy Whitcroft			|
348713214adfSAndy Whitcroft				(?:\&\&|\|\|)
348813214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
348913214adfSAndy Whitcroft				(?:\&\&|\|\||\)|\])
349013214adfSAndy Whitcroft			)/x)
349113214adfSAndy Whitcroft		{
3492000d1cc1SJoe Perches			WARN("HEXADECIMAL_BOOLEAN_TEST",
3493000d1cc1SJoe Perches			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
349413214adfSAndy Whitcroft		}
349513214adfSAndy Whitcroft
34968905a67cSAndy Whitcroft# if and else should not have general statements after it
349713214adfSAndy Whitcroft		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
349813214adfSAndy Whitcroft			my $s = $1;
349913214adfSAndy Whitcroft			$s =~ s/$;//g; 	# Remove any comments
350013214adfSAndy Whitcroft			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3501000d1cc1SJoe Perches				ERROR("TRAILING_STATEMENTS",
3502000d1cc1SJoe Perches				      "trailing statements should be on next line\n" . $herecurr);
35030a920b5bSAndy Whitcroft			}
350413214adfSAndy Whitcroft		}
350539667782SAndy Whitcroft# if should not continue a brace
350639667782SAndy Whitcroft		if ($line =~ /}\s*if\b/) {
3507000d1cc1SJoe Perches			ERROR("TRAILING_STATEMENTS",
3508000d1cc1SJoe Perches			      "trailing statements should be on next line\n" .
350939667782SAndy Whitcroft				$herecurr);
351039667782SAndy Whitcroft		}
3511a1080bf8SAndy Whitcroft# case and default should not have general statements after them
3512a1080bf8SAndy Whitcroft		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3513a1080bf8SAndy Whitcroft		    $line !~ /\G(?:
35143fef12d6SAndy Whitcroft			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3515a1080bf8SAndy Whitcroft			\s*return\s+
3516a1080bf8SAndy Whitcroft		    )/xg)
3517a1080bf8SAndy Whitcroft		{
3518000d1cc1SJoe Perches			ERROR("TRAILING_STATEMENTS",
3519000d1cc1SJoe Perches			      "trailing statements should be on next line\n" . $herecurr);
3520a1080bf8SAndy Whitcroft		}
35210a920b5bSAndy Whitcroft
35220a920b5bSAndy Whitcroft		# Check for }<nl>else {, these must be at the same
35230a920b5bSAndy Whitcroft		# indent level to be relevant to each other.
35240a920b5bSAndy Whitcroft		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
35250a920b5bSAndy Whitcroft						$previndent == $indent) {
3526000d1cc1SJoe Perches			ERROR("ELSE_AFTER_BRACE",
3527000d1cc1SJoe Perches			      "else should follow close brace '}'\n" . $hereprev);
35280a920b5bSAndy Whitcroft		}
35290a920b5bSAndy Whitcroft
3530c2fdda0dSAndy Whitcroft		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3531c2fdda0dSAndy Whitcroft						$previndent == $indent) {
3532c2fdda0dSAndy Whitcroft			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3533c2fdda0dSAndy Whitcroft
3534c2fdda0dSAndy Whitcroft			# Find out what is on the end of the line after the
3535c2fdda0dSAndy Whitcroft			# conditional.
3536773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
3537c2fdda0dSAndy Whitcroft			$s =~ s/\n.*//g;
3538c2fdda0dSAndy Whitcroft
3539c2fdda0dSAndy Whitcroft			if ($s =~ /^\s*;/) {
3540000d1cc1SJoe Perches				ERROR("WHILE_AFTER_BRACE",
3541000d1cc1SJoe Perches				      "while should follow close brace '}'\n" . $hereprev);
3542c2fdda0dSAndy Whitcroft			}
3543c2fdda0dSAndy Whitcroft		}
3544c2fdda0dSAndy Whitcroft
354595e2c602SJoe Perches#Specific variable tests
3546323c1260SJoe Perches		while ($line =~ m{($Constant|$Lval)}g) {
3547323c1260SJoe Perches			my $var = $1;
354895e2c602SJoe Perches
354995e2c602SJoe Perches#gcc binary extension
355095e2c602SJoe Perches			if ($var =~ /^$Binary$/) {
3551d5e616fcSJoe Perches				if (WARN("GCC_BINARY_CONSTANT",
3552d5e616fcSJoe Perches					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3553d5e616fcSJoe Perches				    $fix) {
3554d5e616fcSJoe Perches					my $hexval = sprintf("0x%x", oct($var));
3555d5e616fcSJoe Perches					$fixed[$linenr - 1] =~
3556d5e616fcSJoe Perches					    s/\b$var\b/$hexval/;
3557d5e616fcSJoe Perches				}
355895e2c602SJoe Perches			}
355995e2c602SJoe Perches
356095e2c602SJoe Perches#CamelCase
3561807bd26cSJoe Perches			if ($var !~ /^$Constant$/ &&
3562be79794bSJoe Perches			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
356322735ce8SJoe Perches#Ignore Page<foo> variants
3564807bd26cSJoe Perches			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
356522735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
35663445686aSJoe Perches			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
35677e781f67SJoe Perches				while ($var =~ m{($Ident)}g) {
35687e781f67SJoe Perches					my $word = $1;
35697e781f67SJoe Perches					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3570d8b07710SJoe Perches					if ($check) {
3571d8b07710SJoe Perches						seed_camelcase_includes();
3572d8b07710SJoe Perches						if (!$file && !$camelcase_file_seeded) {
3573d8b07710SJoe Perches							seed_camelcase_file($realfile);
3574d8b07710SJoe Perches							$camelcase_file_seeded = 1;
3575d8b07710SJoe Perches						}
3576d8b07710SJoe Perches					}
35777e781f67SJoe Perches					if (!defined $camelcase{$word}) {
35787e781f67SJoe Perches						$camelcase{$word} = 1;
3579be79794bSJoe Perches						CHK("CAMELCASE",
35807e781f67SJoe Perches						    "Avoid CamelCase: <$word>\n" . $herecurr);
35817e781f67SJoe Perches					}
3582323c1260SJoe Perches				}
3583323c1260SJoe Perches			}
35843445686aSJoe Perches		}
35850a920b5bSAndy Whitcroft
35860a920b5bSAndy Whitcroft#no spaces allowed after \ in define
3587d5e616fcSJoe Perches		if ($line =~ /\#\s*define.*\\\s+$/) {
3588d5e616fcSJoe Perches			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3589d5e616fcSJoe Perches				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3590d5e616fcSJoe Perches			    $fix) {
3591d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/\s+$//;
3592d5e616fcSJoe Perches			}
35930a920b5bSAndy Whitcroft		}
35940a920b5bSAndy Whitcroft
3595653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3596c45dcabdSAndy Whitcroft		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3597e09dec48SAndy Whitcroft			my $file = "$1.h";
3598e09dec48SAndy Whitcroft			my $checkfile = "include/linux/$file";
3599e09dec48SAndy Whitcroft			if (-f "$root/$checkfile" &&
3600e09dec48SAndy Whitcroft			    $realfile ne $checkfile &&
36017840a94cSWolfram Sang			    $1 !~ /$allowed_asm_includes/)
3602c45dcabdSAndy Whitcroft			{
3603e09dec48SAndy Whitcroft				if ($realfile =~ m{^arch/}) {
3604000d1cc1SJoe Perches					CHK("ARCH_INCLUDE_LINUX",
3605000d1cc1SJoe Perches					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3606e09dec48SAndy Whitcroft				} else {
3607000d1cc1SJoe Perches					WARN("INCLUDE_LINUX",
3608000d1cc1SJoe Perches					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3609e09dec48SAndy Whitcroft				}
36100a920b5bSAndy Whitcroft			}
36110a920b5bSAndy Whitcroft		}
36120a920b5bSAndy Whitcroft
3613653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the
3614653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed
3615cf655043SAndy Whitcroft# in a known good container
3616b8f96a31SAndy Whitcroft		if ($realfile !~ m@/vmlinux.lds.h$@ &&
3617b8f96a31SAndy Whitcroft		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3618d8aaf121SAndy Whitcroft			my $ln = $linenr;
3619d8aaf121SAndy Whitcroft			my $cnt = $realcnt;
3620c45dcabdSAndy Whitcroft			my ($off, $dstat, $dcond, $rest);
3621c45dcabdSAndy Whitcroft			my $ctx = '';
3622c45dcabdSAndy Whitcroft			($dstat, $dcond, $ln, $cnt, $off) =
3623f74bd194SAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
3624f74bd194SAndy Whitcroft			$ctx = $dstat;
3625c45dcabdSAndy Whitcroft			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3626a3bb97a7SAndy Whitcroft			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3627c45dcabdSAndy Whitcroft
3628f74bd194SAndy Whitcroft			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3629292f1a9bSAndy Whitcroft			$dstat =~ s/$;//g;
3630c45dcabdSAndy Whitcroft			$dstat =~ s/\\\n.//g;
3631c45dcabdSAndy Whitcroft			$dstat =~ s/^\s*//s;
3632c45dcabdSAndy Whitcroft			$dstat =~ s/\s*$//s;
3633c45dcabdSAndy Whitcroft
3634c45dcabdSAndy Whitcroft			# Flatten any parentheses and braces
3635bf30d6edSAndy Whitcroft			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3636bf30d6edSAndy Whitcroft			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
3637c81769fdSAndy Whitcroft			       $dstat =~ s/\[[^\[\]]*\]/1/)
3638bf30d6edSAndy Whitcroft			{
3639c45dcabdSAndy Whitcroft			}
3640c45dcabdSAndy Whitcroft
3641e45bab8eSAndy Whitcroft			# Flatten any obvious string concatentation.
3642e45bab8eSAndy Whitcroft			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3643e45bab8eSAndy Whitcroft			       $dstat =~ s/$Ident\s*("X*")/$1/)
3644e45bab8eSAndy Whitcroft			{
3645e45bab8eSAndy Whitcroft			}
3646e45bab8eSAndy Whitcroft
3647c45dcabdSAndy Whitcroft			my $exceptions = qr{
3648c45dcabdSAndy Whitcroft				$Declare|
3649c45dcabdSAndy Whitcroft				module_param_named|
3650a0a0a7a9SKees Cook				MODULE_PARM_DESC|
3651c45dcabdSAndy Whitcroft				DECLARE_PER_CPU|
3652c45dcabdSAndy Whitcroft				DEFINE_PER_CPU|
3653383099fdSAndy Whitcroft				__typeof__\(|
365422fd2d3eSStefani Seibold				union|
365522fd2d3eSStefani Seibold				struct|
3656ea71a0a0SAndy Whitcroft				\.$Ident\s*=\s*|
3657ea71a0a0SAndy Whitcroft				^\"|\"$
3658c45dcabdSAndy Whitcroft			}x;
36595eaa20b9SAndy Whitcroft			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3660f74bd194SAndy Whitcroft			if ($dstat ne '' &&
3661f74bd194SAndy Whitcroft			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
3662f74bd194SAndy Whitcroft			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
36633cc4b1c3SJoe Perches			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3664b9df76acSAndy Whitcroft			    $dstat !~ /^'X'$/ &&					# character constants
3665f74bd194SAndy Whitcroft			    $dstat !~ /$exceptions/ &&
3666f74bd194SAndy Whitcroft			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
3667e942e2c3SJoe Perches			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
366872f115f9SAndy Whitcroft			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
3669f74bd194SAndy Whitcroft			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
3670f74bd194SAndy Whitcroft			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
3671f74bd194SAndy Whitcroft			    $dstat !~ /^do\s*{/ &&					# do {...
3672f95a7e6aSJoe Perches			    $dstat !~ /^\({/ &&						# ({...
3673f95a7e6aSJoe Perches			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3674c45dcabdSAndy Whitcroft			{
3675f74bd194SAndy Whitcroft				$ctx =~ s/\n*$//;
3676f74bd194SAndy Whitcroft				my $herectx = $here . "\n";
3677f74bd194SAndy Whitcroft				my $cnt = statement_rawlines($ctx);
3678f74bd194SAndy Whitcroft
3679f74bd194SAndy Whitcroft				for (my $n = 0; $n < $cnt; $n++) {
3680f74bd194SAndy Whitcroft					$herectx .= raw_line($linenr, $n) . "\n";
3681c45dcabdSAndy Whitcroft				}
3682c45dcabdSAndy Whitcroft
3683f74bd194SAndy Whitcroft				if ($dstat =~ /;/) {
3684f74bd194SAndy Whitcroft					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3685f74bd194SAndy Whitcroft					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3686f74bd194SAndy Whitcroft				} else {
3687000d1cc1SJoe Perches					ERROR("COMPLEX_MACRO",
3688f74bd194SAndy Whitcroft					      "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3689d8aaf121SAndy Whitcroft				}
36900a920b5bSAndy Whitcroft			}
36915023d347SJoe Perches
3692481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm
36935023d347SJoe Perches
36945023d347SJoe Perches		} else {
36955023d347SJoe Perches			if ($prevline !~ /^..*\\$/ &&
3696481eb486SJoe Perches			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
3697481eb486SJoe Perches			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
36985023d347SJoe Perches			    $line =~ /^\+.*\\$/) {
36995023d347SJoe Perches				WARN("LINE_CONTINUATIONS",
37005023d347SJoe Perches				     "Avoid unnecessary line continuations\n" . $herecurr);
37015023d347SJoe Perches			}
3702653d4876SAndy Whitcroft		}
37030a920b5bSAndy Whitcroft
3704b13edf7fSJoe Perches# do {} while (0) macro tests:
3705b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop,
3706b13edf7fSJoe Perches# macro should not end with a semicolon
3707b13edf7fSJoe Perches		if ($^V && $^V ge 5.10.0 &&
3708b13edf7fSJoe Perches		    $realfile !~ m@/vmlinux.lds.h$@ &&
3709b13edf7fSJoe Perches		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3710b13edf7fSJoe Perches			my $ln = $linenr;
3711b13edf7fSJoe Perches			my $cnt = $realcnt;
3712b13edf7fSJoe Perches			my ($off, $dstat, $dcond, $rest);
3713b13edf7fSJoe Perches			my $ctx = '';
3714b13edf7fSJoe Perches			($dstat, $dcond, $ln, $cnt, $off) =
3715b13edf7fSJoe Perches				ctx_statement_block($linenr, $realcnt, 0);
3716b13edf7fSJoe Perches			$ctx = $dstat;
3717b13edf7fSJoe Perches
3718b13edf7fSJoe Perches			$dstat =~ s/\\\n.//g;
3719b13edf7fSJoe Perches
3720b13edf7fSJoe Perches			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3721b13edf7fSJoe Perches				my $stmts = $2;
3722b13edf7fSJoe Perches				my $semis = $3;
3723b13edf7fSJoe Perches
3724b13edf7fSJoe Perches				$ctx =~ s/\n*$//;
3725b13edf7fSJoe Perches				my $cnt = statement_rawlines($ctx);
3726b13edf7fSJoe Perches				my $herectx = $here . "\n";
3727b13edf7fSJoe Perches
3728b13edf7fSJoe Perches				for (my $n = 0; $n < $cnt; $n++) {
3729b13edf7fSJoe Perches					$herectx .= raw_line($linenr, $n) . "\n";
3730b13edf7fSJoe Perches				}
3731b13edf7fSJoe Perches
3732ac8e97f8SJoe Perches				if (($stmts =~ tr/;/;/) == 1 &&
3733ac8e97f8SJoe Perches				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
3734b13edf7fSJoe Perches					WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3735b13edf7fSJoe Perches					     "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3736b13edf7fSJoe Perches				}
3737b13edf7fSJoe Perches				if (defined $semis && $semis ne "") {
3738b13edf7fSJoe Perches					WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3739b13edf7fSJoe Perches					     "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3740b13edf7fSJoe Perches				}
3741b13edf7fSJoe Perches			}
3742b13edf7fSJoe Perches		}
3743b13edf7fSJoe Perches
3744080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3745080ba929SMike Frysinger# all assignments may have only one of the following with an assignment:
3746080ba929SMike Frysinger#	.
3747080ba929SMike Frysinger#	ALIGN(...)
3748080ba929SMike Frysinger#	VMLINUX_SYMBOL(...)
3749080ba929SMike Frysinger		if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3750000d1cc1SJoe Perches			WARN("MISSING_VMLINUX_SYMBOL",
3751000d1cc1SJoe Perches			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3752080ba929SMike Frysinger		}
3753080ba929SMike Frysinger
3754f0a594c1SAndy Whitcroft# check for redundant bracing round if etc
375513214adfSAndy Whitcroft		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
375613214adfSAndy Whitcroft			my ($level, $endln, @chunks) =
3757cf655043SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, 1);
375813214adfSAndy Whitcroft			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3759cf655043SAndy Whitcroft			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3760cf655043SAndy Whitcroft			if ($#chunks > 0 && $level == 0) {
3761aad4f614SJoe Perches				my @allowed = ();
3762aad4f614SJoe Perches				my $allow = 0;
376313214adfSAndy Whitcroft				my $seen = 0;
3764773647a0SAndy Whitcroft				my $herectx = $here . "\n";
3765cf655043SAndy Whitcroft				my $ln = $linenr - 1;
376613214adfSAndy Whitcroft				for my $chunk (@chunks) {
376713214adfSAndy Whitcroft					my ($cond, $block) = @{$chunk};
376813214adfSAndy Whitcroft
3769773647a0SAndy Whitcroft					# If the condition carries leading newlines, then count those as offsets.
3770773647a0SAndy Whitcroft					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3771773647a0SAndy Whitcroft					my $offset = statement_rawlines($whitespace) - 1;
3772773647a0SAndy Whitcroft
3773aad4f614SJoe Perches					$allowed[$allow] = 0;
3774773647a0SAndy Whitcroft					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3775773647a0SAndy Whitcroft
3776773647a0SAndy Whitcroft					# We have looked at and allowed this specific line.
3777773647a0SAndy Whitcroft					$suppress_ifbraces{$ln + $offset} = 1;
3778773647a0SAndy Whitcroft
3779773647a0SAndy Whitcroft					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3780cf655043SAndy Whitcroft					$ln += statement_rawlines($block) - 1;
3781cf655043SAndy Whitcroft
3782773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
378313214adfSAndy Whitcroft
378413214adfSAndy Whitcroft					$seen++ if ($block =~ /^\s*{/);
378513214adfSAndy Whitcroft
3786aad4f614SJoe Perches					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3787cf655043SAndy Whitcroft					if (statement_lines($cond) > 1) {
3788cf655043SAndy Whitcroft						#print "APW: ALLOWED: cond<$cond>\n";
3789aad4f614SJoe Perches						$allowed[$allow] = 1;
379013214adfSAndy Whitcroft					}
379113214adfSAndy Whitcroft					if ($block =~/\b(?:if|for|while)\b/) {
3792cf655043SAndy Whitcroft						#print "APW: ALLOWED: block<$block>\n";
3793aad4f614SJoe Perches						$allowed[$allow] = 1;
379413214adfSAndy Whitcroft					}
3795cf655043SAndy Whitcroft					if (statement_block_size($block) > 1) {
3796cf655043SAndy Whitcroft						#print "APW: ALLOWED: lines block<$block>\n";
3797aad4f614SJoe Perches						$allowed[$allow] = 1;
379813214adfSAndy Whitcroft					}
3799aad4f614SJoe Perches					$allow++;
380013214adfSAndy Whitcroft				}
3801aad4f614SJoe Perches				if ($seen) {
3802aad4f614SJoe Perches					my $sum_allowed = 0;
3803aad4f614SJoe Perches					foreach (@allowed) {
3804aad4f614SJoe Perches						$sum_allowed += $_;
3805aad4f614SJoe Perches					}
3806aad4f614SJoe Perches					if ($sum_allowed == 0) {
3807000d1cc1SJoe Perches						WARN("BRACES",
3808000d1cc1SJoe Perches						     "braces {} are not necessary for any arm of this statement\n" . $herectx);
3809aad4f614SJoe Perches					} elsif ($sum_allowed != $allow &&
3810aad4f614SJoe Perches						 $seen != $allow) {
3811aad4f614SJoe Perches						CHK("BRACES",
3812aad4f614SJoe Perches						    "braces {} should be used on all arms of this statement\n" . $herectx);
3813aad4f614SJoe Perches					}
381413214adfSAndy Whitcroft				}
381513214adfSAndy Whitcroft			}
381613214adfSAndy Whitcroft		}
3817773647a0SAndy Whitcroft		if (!defined $suppress_ifbraces{$linenr - 1} &&
381813214adfSAndy Whitcroft					$line =~ /\b(if|while|for|else)\b/) {
3819cf655043SAndy Whitcroft			my $allowed = 0;
3820f0a594c1SAndy Whitcroft
3821cf655043SAndy Whitcroft			# Check the pre-context.
3822cf655043SAndy Whitcroft			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3823cf655043SAndy Whitcroft				#print "APW: ALLOWED: pre<$1>\n";
3824cf655043SAndy Whitcroft				$allowed = 1;
3825f0a594c1SAndy Whitcroft			}
3826773647a0SAndy Whitcroft
3827773647a0SAndy Whitcroft			my ($level, $endln, @chunks) =
3828773647a0SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, $-[0]);
3829773647a0SAndy Whitcroft
3830cf655043SAndy Whitcroft			# Check the condition.
3831cf655043SAndy Whitcroft			my ($cond, $block) = @{$chunks[0]};
3832773647a0SAndy Whitcroft			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3833cf655043SAndy Whitcroft			if (defined $cond) {
3834773647a0SAndy Whitcroft				substr($block, 0, length($cond), '');
3835cf655043SAndy Whitcroft			}
3836cf655043SAndy Whitcroft			if (statement_lines($cond) > 1) {
3837cf655043SAndy Whitcroft				#print "APW: ALLOWED: cond<$cond>\n";
3838cf655043SAndy Whitcroft				$allowed = 1;
3839cf655043SAndy Whitcroft			}
3840cf655043SAndy Whitcroft			if ($block =~/\b(?:if|for|while)\b/) {
3841cf655043SAndy Whitcroft				#print "APW: ALLOWED: block<$block>\n";
3842cf655043SAndy Whitcroft				$allowed = 1;
3843cf655043SAndy Whitcroft			}
3844cf655043SAndy Whitcroft			if (statement_block_size($block) > 1) {
3845cf655043SAndy Whitcroft				#print "APW: ALLOWED: lines block<$block>\n";
3846cf655043SAndy Whitcroft				$allowed = 1;
3847cf655043SAndy Whitcroft			}
3848cf655043SAndy Whitcroft			# Check the post-context.
3849cf655043SAndy Whitcroft			if (defined $chunks[1]) {
3850cf655043SAndy Whitcroft				my ($cond, $block) = @{$chunks[1]};
3851cf655043SAndy Whitcroft				if (defined $cond) {
3852773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
3853cf655043SAndy Whitcroft				}
3854cf655043SAndy Whitcroft				if ($block =~ /^\s*\{/) {
3855cf655043SAndy Whitcroft					#print "APW: ALLOWED: chunk-1 block<$block>\n";
3856cf655043SAndy Whitcroft					$allowed = 1;
3857cf655043SAndy Whitcroft				}
3858cf655043SAndy Whitcroft			}
3859cf655043SAndy Whitcroft			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
386069932487SJustin P. Mattock				my $herectx = $here . "\n";
3861f055663cSAndy Whitcroft				my $cnt = statement_rawlines($block);
3862cf655043SAndy Whitcroft
3863f055663cSAndy Whitcroft				for (my $n = 0; $n < $cnt; $n++) {
386469932487SJustin P. Mattock					$herectx .= raw_line($linenr, $n) . "\n";
3865cf655043SAndy Whitcroft				}
3866cf655043SAndy Whitcroft
3867000d1cc1SJoe Perches				WARN("BRACES",
3868000d1cc1SJoe Perches				     "braces {} are not necessary for single statement blocks\n" . $herectx);
3869f0a594c1SAndy Whitcroft			}
3870f0a594c1SAndy Whitcroft		}
3871f0a594c1SAndy Whitcroft
38720979ae66SJoe Perches# check for unnecessary blank lines around braces
387377b9a53aSJoe Perches		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
38740979ae66SJoe Perches			CHK("BRACES",
38750979ae66SJoe Perches			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
38760979ae66SJoe Perches		}
387777b9a53aSJoe Perches		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
38780979ae66SJoe Perches			CHK("BRACES",
38790979ae66SJoe Perches			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
38800979ae66SJoe Perches		}
38810979ae66SJoe Perches
38824a0df2efSAndy Whitcroft# no volatiles please
38836c72ffaaSAndy Whitcroft		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
38846c72ffaaSAndy Whitcroft		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3885000d1cc1SJoe Perches			WARN("VOLATILE",
3886000d1cc1SJoe Perches			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
38874a0df2efSAndy Whitcroft		}
38884a0df2efSAndy Whitcroft
388900df344fSAndy Whitcroft# warn about #if 0
3890c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3891000d1cc1SJoe Perches			CHK("REDUNDANT_CODE",
3892000d1cc1SJoe Perches			    "if this code is redundant consider removing it\n" .
3893de7d4f0eSAndy Whitcroft				$herecurr);
38944a0df2efSAndy Whitcroft		}
38954a0df2efSAndy Whitcroft
389603df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses
389703df4b51SAndy Whitcroft		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
389803df4b51SAndy Whitcroft			my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
389903df4b51SAndy Whitcroft			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
390003df4b51SAndy Whitcroft				WARN('NEEDLESS_IF',
390103df4b51SAndy Whitcroft				     "$1(NULL) is safe this check is probably not required\n" . $hereprev);
39024c432a8fSGreg Kroah-Hartman			}
39034c432a8fSGreg Kroah-Hartman		}
3904f0a594c1SAndy Whitcroft
39058716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata)
39068716de38SJoe Perches		if ($line =~ /(\b$InitAttribute\b)/) {
39078716de38SJoe Perches			my $attr = $1;
39088716de38SJoe Perches			if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
39098716de38SJoe Perches				my $ptr = $1;
39108716de38SJoe Perches				my $var = $2;
39118716de38SJoe Perches				if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
39128716de38SJoe Perches				      ERROR("MISPLACED_INIT",
39138716de38SJoe Perches					    "$attr should be placed after $var\n" . $herecurr)) ||
39148716de38SJoe Perches				     ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
39158716de38SJoe Perches				      WARN("MISPLACED_INIT",
39168716de38SJoe Perches					   "$attr should be placed after $var\n" . $herecurr))) &&
39178716de38SJoe Perches				    $fix) {
39188716de38SJoe Perches					$fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
39198716de38SJoe Perches				}
39208716de38SJoe Perches			}
39218716de38SJoe Perches		}
39228716de38SJoe Perches
3923e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const
3924e970b884SJoe Perches		if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3925e970b884SJoe Perches			my $attr = $1;
3926e970b884SJoe Perches			$attr =~ /($InitAttributePrefix)(.*)/;
3927e970b884SJoe Perches			my $attr_prefix = $1;
3928e970b884SJoe Perches			my $attr_type = $2;
3929e970b884SJoe Perches			if (ERROR("INIT_ATTRIBUTE",
3930e970b884SJoe Perches				  "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3931e970b884SJoe Perches			    $fix) {
3932e970b884SJoe Perches				$fixed[$linenr - 1] =~
3933e970b884SJoe Perches				    s/$InitAttributeData/${attr_prefix}initconst/;
3934e970b884SJoe Perches			}
3935e970b884SJoe Perches		}
3936e970b884SJoe Perches
3937e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const
3938e970b884SJoe Perches		if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3939e970b884SJoe Perches			my $attr = $1;
3940e970b884SJoe Perches			if (ERROR("INIT_ATTRIBUTE",
3941e970b884SJoe Perches				  "Use of $attr requires a separate use of const\n" . $herecurr) &&
3942e970b884SJoe Perches			    $fix) {
3943e970b884SJoe Perches				my $lead = $fixed[$linenr - 1] =~
3944e970b884SJoe Perches				    /(^\+\s*(?:static\s+))/;
3945e970b884SJoe Perches				$lead = rtrim($1);
3946e970b884SJoe Perches				$lead = "$lead " if ($lead !~ /^\+$/);
3947e970b884SJoe Perches				$lead = "${lead}const ";
3948e970b884SJoe Perches				$fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3949e970b884SJoe Perches			}
3950e970b884SJoe Perches		}
3951e970b884SJoe Perches
3952fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/
3953fbdb8138SJoe Perches		if ($realfile !~ m@^include/uapi/@ &&
3954fbdb8138SJoe Perches		    $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
3955fbdb8138SJoe Perches			my $constant_func = $1;
3956fbdb8138SJoe Perches			my $func = $constant_func;
3957fbdb8138SJoe Perches			$func =~ s/^__constant_//;
3958fbdb8138SJoe Perches			if (WARN("CONSTANT_CONVERSION",
3959fbdb8138SJoe Perches				 "$constant_func should be $func\n" . $herecurr) &&
3960fbdb8138SJoe Perches			    $fix) {
3961fbdb8138SJoe Perches				$fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
3962fbdb8138SJoe Perches			}
3963fbdb8138SJoe Perches		}
3964fbdb8138SJoe Perches
39651a15a250SPatrick Pannuto# prefer usleep_range over udelay
396637581c28SBruce Allan		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
396743c1d77cSJoe Perches			my $delay = $1;
39681a15a250SPatrick Pannuto			# ignore udelay's < 10, however
396943c1d77cSJoe Perches			if (! ($delay < 10) ) {
3970000d1cc1SJoe Perches				CHK("USLEEP_RANGE",
397143c1d77cSJoe Perches				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
397243c1d77cSJoe Perches			}
397343c1d77cSJoe Perches			if ($delay > 2000) {
397443c1d77cSJoe Perches				WARN("LONG_UDELAY",
397543c1d77cSJoe Perches				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
39761a15a250SPatrick Pannuto			}
39771a15a250SPatrick Pannuto		}
39781a15a250SPatrick Pannuto
397909ef8725SPatrick Pannuto# warn about unexpectedly long msleep's
398009ef8725SPatrick Pannuto		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
398109ef8725SPatrick Pannuto			if ($1 < 20) {
3982000d1cc1SJoe Perches				WARN("MSLEEP",
398343c1d77cSJoe Perches				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
398409ef8725SPatrick Pannuto			}
398509ef8725SPatrick Pannuto		}
398609ef8725SPatrick Pannuto
398736ec1939SJoe Perches# check for comparisons of jiffies
398836ec1939SJoe Perches		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
398936ec1939SJoe Perches			WARN("JIFFIES_COMPARISON",
399036ec1939SJoe Perches			     "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
399136ec1939SJoe Perches		}
399236ec1939SJoe Perches
39939d7a34a5SJoe Perches# check for comparisons of get_jiffies_64()
39949d7a34a5SJoe Perches		if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
39959d7a34a5SJoe Perches			WARN("JIFFIES_COMPARISON",
39969d7a34a5SJoe Perches			     "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
39979d7a34a5SJoe Perches		}
39989d7a34a5SJoe Perches
399900df344fSAndy Whitcroft# warn about #ifdefs in C files
4000c45dcabdSAndy Whitcroft#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
400100df344fSAndy Whitcroft#			print "#ifdef in C files should be avoided\n";
400200df344fSAndy Whitcroft#			print "$herecurr";
400300df344fSAndy Whitcroft#			$clean = 0;
400400df344fSAndy Whitcroft#		}
400500df344fSAndy Whitcroft
400622f2a2efSAndy Whitcroft# warn about spacing in #ifdefs
4007c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
40083705ce5bSJoe Perches			if (ERROR("SPACING",
40093705ce5bSJoe Perches				  "exactly one space required after that #$1\n" . $herecurr) &&
40103705ce5bSJoe Perches			    $fix) {
40113705ce5bSJoe Perches				$fixed[$linenr - 1] =~
40123705ce5bSJoe Perches				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
40133705ce5bSJoe Perches			}
40143705ce5bSJoe Perches
401522f2a2efSAndy Whitcroft		}
401622f2a2efSAndy Whitcroft
40174a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment.
4018171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4019171ae1a4SAndy Whitcroft		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
40204a0df2efSAndy Whitcroft			my $which = $1;
40214a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
4022000d1cc1SJoe Perches				CHK("UNCOMMENTED_DEFINITION",
4023000d1cc1SJoe Perches				    "$1 definition without comment\n" . $herecurr);
40244a0df2efSAndy Whitcroft			}
40254a0df2efSAndy Whitcroft		}
40264a0df2efSAndy Whitcroft# check for memory barriers without a comment.
40274a0df2efSAndy Whitcroft		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
40284a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
4029c1fd7bb9SJoe Perches				WARN("MEMORY_BARRIER",
4030000d1cc1SJoe Perches				     "memory barrier without comment\n" . $herecurr);
40314a0df2efSAndy Whitcroft			}
40324a0df2efSAndy Whitcroft		}
40334a0df2efSAndy Whitcroft# check of hardware specific defines
4034c45dcabdSAndy Whitcroft		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4035000d1cc1SJoe Perches			CHK("ARCH_DEFINES",
4036000d1cc1SJoe Perches			    "architecture specific defines should be avoided\n" .  $herecurr);
40370a920b5bSAndy Whitcroft		}
4038653d4876SAndy Whitcroft
4039d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration
4040d4977c78STobias Klauser		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4041000d1cc1SJoe Perches			WARN("STORAGE_CLASS",
4042000d1cc1SJoe Perches			     "storage class should be at the beginning of the declaration\n" . $herecurr)
4043d4977c78STobias Klauser		}
4044d4977c78STobias Klauser
4045de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between
4046de7d4f0eSAndy Whitcroft# storage class and type.
40479c0ca6f9SAndy Whitcroft		if ($line =~ /\b$Type\s+$Inline\b/ ||
40489c0ca6f9SAndy Whitcroft		    $line =~ /\b$Inline\s+$Storage\b/) {
4049000d1cc1SJoe Perches			ERROR("INLINE_LOCATION",
4050000d1cc1SJoe Perches			      "inline keyword should sit between storage class and type\n" . $herecurr);
4051de7d4f0eSAndy Whitcroft		}
4052de7d4f0eSAndy Whitcroft
40538905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline
40542b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
40552b7ab453SJoe Perches		    $line =~ /\b(__inline__|__inline)\b/) {
4056d5e616fcSJoe Perches			if (WARN("INLINE",
4057d5e616fcSJoe Perches				 "plain inline is preferred over $1\n" . $herecurr) &&
4058d5e616fcSJoe Perches			    $fix) {
4059d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4060d5e616fcSJoe Perches
4061d5e616fcSJoe Perches			}
40628905a67cSAndy Whitcroft		}
40638905a67cSAndy Whitcroft
40643d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed
40652b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
40662b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4067000d1cc1SJoe Perches			WARN("PREFER_PACKED",
4068000d1cc1SJoe Perches			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
40693d130fd0SJoe Perches		}
40703d130fd0SJoe Perches
407139b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned
40722b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
40732b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4074000d1cc1SJoe Perches			WARN("PREFER_ALIGNED",
4075000d1cc1SJoe Perches			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
407639b7e287SJoe Perches		}
407739b7e287SJoe Perches
40785f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf
40792b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
40802b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4081d5e616fcSJoe Perches			if (WARN("PREFER_PRINTF",
4082d5e616fcSJoe Perches				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4083d5e616fcSJoe Perches			    $fix) {
4084d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4085d5e616fcSJoe Perches
4086d5e616fcSJoe Perches			}
40875f14d3bdSJoe Perches		}
40885f14d3bdSJoe Perches
40896061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf
40902b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
40912b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4092d5e616fcSJoe Perches			if (WARN("PREFER_SCANF",
4093d5e616fcSJoe Perches				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4094d5e616fcSJoe Perches			    $fix) {
4095d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4096d5e616fcSJoe Perches			}
40976061d949SJoe Perches		}
40986061d949SJoe Perches
40998f53a9b8SJoe Perches# check for sizeof(&)
41008f53a9b8SJoe Perches		if ($line =~ /\bsizeof\s*\(\s*\&/) {
4101000d1cc1SJoe Perches			WARN("SIZEOF_ADDRESS",
4102000d1cc1SJoe Perches			     "sizeof(& should be avoided\n" . $herecurr);
41038f53a9b8SJoe Perches		}
41048f53a9b8SJoe Perches
410566c80b60SJoe Perches# check for sizeof without parenthesis
410666c80b60SJoe Perches		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4107d5e616fcSJoe Perches			if (WARN("SIZEOF_PARENTHESIS",
4108d5e616fcSJoe Perches				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4109d5e616fcSJoe Perches			    $fix) {
4110d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4111d5e616fcSJoe Perches			}
411266c80b60SJoe Perches		}
411366c80b60SJoe Perches
4114428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of "
4115428e2fdcSJoe Perches		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4116000d1cc1SJoe Perches			WARN("LINE_CONTINUATIONS",
4117000d1cc1SJoe Perches			     "Avoid line continuations in quoted strings\n" . $herecurr);
4118428e2fdcSJoe Perches		}
4119428e2fdcSJoe Perches
412088982feaSJoe Perches# check for struct spinlock declarations
412188982feaSJoe Perches		if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
412288982feaSJoe Perches			WARN("USE_SPINLOCK_T",
412388982feaSJoe Perches			     "struct spinlock should be spinlock_t\n" . $herecurr);
412488982feaSJoe Perches		}
412588982feaSJoe Perches
4126a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts
412706668727SJoe Perches		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4128a6962d72SJoe Perches			my $fmt = get_quoted_string($line, $rawline);
412906668727SJoe Perches			if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4130d5e616fcSJoe Perches				if (WARN("PREFER_SEQ_PUTS",
4131d5e616fcSJoe Perches					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4132d5e616fcSJoe Perches				    $fix) {
4133d5e616fcSJoe Perches					$fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4134d5e616fcSJoe Perches				}
4135a6962d72SJoe Perches			}
4136a6962d72SJoe Perches		}
4137a6962d72SJoe Perches
4138554e165cSAndy Whitcroft# Check for misused memsets
4139d1fe9c09SJoe Perches		if ($^V && $^V ge 5.10.0 &&
4140d1fe9c09SJoe Perches		    defined $stat &&
4141d7c76ba7SJoe Perches		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4142554e165cSAndy Whitcroft
4143d7c76ba7SJoe Perches			my $ms_addr = $2;
4144d1fe9c09SJoe Perches			my $ms_val = $7;
4145d1fe9c09SJoe Perches			my $ms_size = $12;
4146d7c76ba7SJoe Perches
4147554e165cSAndy Whitcroft			if ($ms_size =~ /^(0x|)0$/i) {
4148554e165cSAndy Whitcroft				ERROR("MEMSET",
4149d7c76ba7SJoe Perches				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4150554e165cSAndy Whitcroft			} elsif ($ms_size =~ /^(0x|)1$/i) {
4151554e165cSAndy Whitcroft				WARN("MEMSET",
4152d7c76ba7SJoe Perches				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4153d7c76ba7SJoe Perches			}
4154d7c76ba7SJoe Perches		}
4155d7c76ba7SJoe Perches
415698a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
415798a9bba5SJoe Perches		if ($^V && $^V ge 5.10.0 &&
415898a9bba5SJoe Perches		    $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
415998a9bba5SJoe Perches			if (WARN("PREFER_ETHER_ADDR_COPY",
416098a9bba5SJoe Perches				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
416198a9bba5SJoe Perches			    $fix) {
416298a9bba5SJoe Perches				$fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
416398a9bba5SJoe Perches			}
416498a9bba5SJoe Perches		}
416598a9bba5SJoe Perches
4166d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t
4167d1fe9c09SJoe Perches		if ($^V && $^V ge 5.10.0 &&
4168d1fe9c09SJoe Perches		    defined $stat &&
4169d7c76ba7SJoe Perches		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4170d1fe9c09SJoe Perches			if (defined $2 || defined $7) {
4171d7c76ba7SJoe Perches				my $call = $1;
4172d7c76ba7SJoe Perches				my $cast1 = deparenthesize($2);
4173d7c76ba7SJoe Perches				my $arg1 = $3;
4174d1fe9c09SJoe Perches				my $cast2 = deparenthesize($7);
4175d1fe9c09SJoe Perches				my $arg2 = $8;
4176d7c76ba7SJoe Perches				my $cast;
4177d7c76ba7SJoe Perches
4178d1fe9c09SJoe Perches				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4179d7c76ba7SJoe Perches					$cast = "$cast1 or $cast2";
4180d7c76ba7SJoe Perches				} elsif ($cast1 ne "") {
4181d7c76ba7SJoe Perches					$cast = $cast1;
4182d7c76ba7SJoe Perches				} else {
4183d7c76ba7SJoe Perches					$cast = $cast2;
4184d7c76ba7SJoe Perches				}
4185d7c76ba7SJoe Perches				WARN("MINMAX",
4186d7c76ba7SJoe Perches				     "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4187554e165cSAndy Whitcroft			}
4188554e165cSAndy Whitcroft		}
4189554e165cSAndy Whitcroft
41904a273195SJoe Perches# check usleep_range arguments
41914a273195SJoe Perches		if ($^V && $^V ge 5.10.0 &&
41924a273195SJoe Perches		    defined $stat &&
41934a273195SJoe Perches		    $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
41944a273195SJoe Perches			my $min = $1;
41954a273195SJoe Perches			my $max = $7;
41964a273195SJoe Perches			if ($min eq $max) {
41974a273195SJoe Perches				WARN("USLEEP_RANGE",
41984a273195SJoe Perches				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
41994a273195SJoe Perches			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
42004a273195SJoe Perches				 $min > $max) {
42014a273195SJoe Perches				WARN("USLEEP_RANGE",
42024a273195SJoe Perches				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
42034a273195SJoe Perches			}
42044a273195SJoe Perches		}
42054a273195SJoe Perches
4206823b794cSJoe Perches# check for naked sscanf
4207823b794cSJoe Perches		if ($^V && $^V ge 5.10.0 &&
4208823b794cSJoe Perches		    defined $stat &&
42096c8bd707SJoe Perches		    $line =~ /\bsscanf\b/ &&
4210823b794cSJoe Perches		    ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4211823b794cSJoe Perches		     $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4212823b794cSJoe Perches		     $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4213823b794cSJoe Perches			my $lc = $stat =~ tr@\n@@;
4214823b794cSJoe Perches			$lc = $lc + $linenr;
4215823b794cSJoe Perches			my $stat_real = raw_line($linenr, 0);
4216823b794cSJoe Perches		        for (my $count = $linenr + 1; $count <= $lc; $count++) {
4217823b794cSJoe Perches				$stat_real = $stat_real . "\n" . raw_line($count, 0);
4218823b794cSJoe Perches			}
4219823b794cSJoe Perches			WARN("NAKED_SSCANF",
4220823b794cSJoe Perches			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4221823b794cSJoe Perches		}
4222823b794cSJoe Perches
422370dc8a48SJoe Perches# check for new externs in .h files.
422470dc8a48SJoe Perches		if ($realfile =~ /\.h$/ &&
422570dc8a48SJoe Perches		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4226d1d85780SJoe Perches			if (CHK("AVOID_EXTERNS",
422770dc8a48SJoe Perches				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
422870dc8a48SJoe Perches			    $fix) {
422970dc8a48SJoe Perches				$fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
423070dc8a48SJoe Perches			}
423170dc8a48SJoe Perches		}
423270dc8a48SJoe Perches
4233de7d4f0eSAndy Whitcroft# check for new externs in .c files.
4234171ae1a4SAndy Whitcroft		if ($realfile =~ /\.c$/ && defined $stat &&
4235c45dcabdSAndy Whitcroft		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4236171ae1a4SAndy Whitcroft		{
4237c45dcabdSAndy Whitcroft			my $function_name = $1;
4238c45dcabdSAndy Whitcroft			my $paren_space = $2;
4239171ae1a4SAndy Whitcroft
4240171ae1a4SAndy Whitcroft			my $s = $stat;
4241171ae1a4SAndy Whitcroft			if (defined $cond) {
4242171ae1a4SAndy Whitcroft				substr($s, 0, length($cond), '');
4243171ae1a4SAndy Whitcroft			}
4244c45dcabdSAndy Whitcroft			if ($s =~ /^\s*;/ &&
4245c45dcabdSAndy Whitcroft			    $function_name ne 'uninitialized_var')
4246c45dcabdSAndy Whitcroft			{
4247000d1cc1SJoe Perches				WARN("AVOID_EXTERNS",
4248000d1cc1SJoe Perches				     "externs should be avoided in .c files\n" .  $herecurr);
4249de7d4f0eSAndy Whitcroft			}
4250de7d4f0eSAndy Whitcroft
4251171ae1a4SAndy Whitcroft			if ($paren_space =~ /\n/) {
4252000d1cc1SJoe Perches				WARN("FUNCTION_ARGUMENTS",
4253000d1cc1SJoe Perches				     "arguments for function declarations should follow identifier\n" . $herecurr);
4254171ae1a4SAndy Whitcroft			}
42559c9ba34eSAndy Whitcroft
42569c9ba34eSAndy Whitcroft		} elsif ($realfile =~ /\.c$/ && defined $stat &&
42579c9ba34eSAndy Whitcroft		    $stat =~ /^.\s*extern\s+/)
42589c9ba34eSAndy Whitcroft		{
4259000d1cc1SJoe Perches			WARN("AVOID_EXTERNS",
4260000d1cc1SJoe Perches			     "externs should be avoided in .c files\n" .  $herecurr);
4261171ae1a4SAndy Whitcroft		}
4262171ae1a4SAndy Whitcroft
4263de7d4f0eSAndy Whitcroft# checks for new __setup's
4264de7d4f0eSAndy Whitcroft		if ($rawline =~ /\b__setup\("([^"]*)"/) {
4265de7d4f0eSAndy Whitcroft			my $name = $1;
4266de7d4f0eSAndy Whitcroft
4267de7d4f0eSAndy Whitcroft			if (!grep(/$name/, @setup_docs)) {
4268000d1cc1SJoe Perches				CHK("UNDOCUMENTED_SETUP",
4269000d1cc1SJoe Perches				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4270de7d4f0eSAndy Whitcroft			}
4271653d4876SAndy Whitcroft		}
42729c0ca6f9SAndy Whitcroft
42739c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return
4274caf2a54fSJoe Perches		if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
4275000d1cc1SJoe Perches			WARN("UNNECESSARY_CASTS",
4276000d1cc1SJoe Perches			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
42779c0ca6f9SAndy Whitcroft		}
427813214adfSAndy Whitcroft
4279a640d25cSJoe Perches# alloc style
4280a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4281a640d25cSJoe Perches		if ($^V && $^V ge 5.10.0 &&
4282a640d25cSJoe Perches		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4283a640d25cSJoe Perches			CHK("ALLOC_SIZEOF_STRUCT",
4284a640d25cSJoe Perches			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4285a640d25cSJoe Perches		}
4286a640d25cSJoe Perches
4287972fdea2SJoe Perches# check for krealloc arg reuse
4288972fdea2SJoe Perches		if ($^V && $^V ge 5.10.0 &&
4289972fdea2SJoe Perches		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4290972fdea2SJoe Perches			WARN("KREALLOC_ARG_REUSE",
4291972fdea2SJoe Perches			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4292972fdea2SJoe Perches		}
4293972fdea2SJoe Perches
42945ce59ae0SJoe Perches# check for alloc argument mismatch
42955ce59ae0SJoe Perches		if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
42965ce59ae0SJoe Perches			WARN("ALLOC_ARRAY_ARGS",
42975ce59ae0SJoe Perches			     "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
42985ce59ae0SJoe Perches		}
42995ce59ae0SJoe Perches
43007e4915e7SDavid Rientjes# check for GFP_NOWAIT use
43017e4915e7SDavid Rientjes		if ($line =~ /\b__GFP_NOFAIL\b/) {
43027e4915e7SDavid Rientjes			WARN("__GFP_NOFAIL",
43037e4915e7SDavid Rientjes			     "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr);
43047e4915e7SDavid Rientjes		}
43057e4915e7SDavid Rientjes
4306caf2a54fSJoe Perches# check for multiple semicolons
4307caf2a54fSJoe Perches		if ($line =~ /;\s*;\s*$/) {
4308d5e616fcSJoe Perches			if (WARN("ONE_SEMICOLON",
4309d5e616fcSJoe Perches				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4310d5e616fcSJoe Perches			    $fix) {
4311d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4312d5e616fcSJoe Perches			}
4313d1e2ad07SJoe Perches		}
4314d1e2ad07SJoe Perches
4315c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch
4316c34c09a8SJoe Perches		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4317c34c09a8SJoe Perches			my $has_break = 0;
4318c34c09a8SJoe Perches			my $has_statement = 0;
4319c34c09a8SJoe Perches			my $count = 0;
4320c34c09a8SJoe Perches			my $prevline = $linenr;
4321c34c09a8SJoe Perches			while ($prevline > 1 && $count < 3 && !$has_break) {
4322c34c09a8SJoe Perches				$prevline--;
4323c34c09a8SJoe Perches				my $rline = $rawlines[$prevline - 1];
4324c34c09a8SJoe Perches				my $fline = $lines[$prevline - 1];
4325c34c09a8SJoe Perches				last if ($fline =~ /^\@\@/);
4326c34c09a8SJoe Perches				next if ($fline =~ /^\-/);
4327c34c09a8SJoe Perches				next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4328c34c09a8SJoe Perches				$has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4329c34c09a8SJoe Perches				next if ($fline =~ /^.[\s$;]*$/);
4330c34c09a8SJoe Perches				$has_statement = 1;
4331c34c09a8SJoe Perches				$count++;
4332c34c09a8SJoe Perches				$has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4333c34c09a8SJoe Perches			}
4334c34c09a8SJoe Perches			if (!$has_break && $has_statement) {
4335c34c09a8SJoe Perches				WARN("MISSING_BREAK",
4336c34c09a8SJoe Perches				     "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4337c34c09a8SJoe Perches			}
4338c34c09a8SJoe Perches		}
4339c34c09a8SJoe Perches
4340d1e2ad07SJoe Perches# check for switch/default statements without a break;
4341d1e2ad07SJoe Perches		if ($^V && $^V ge 5.10.0 &&
4342d1e2ad07SJoe Perches		    defined $stat &&
4343d1e2ad07SJoe Perches		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4344d1e2ad07SJoe Perches			my $ctx = '';
4345d1e2ad07SJoe Perches			my $herectx = $here . "\n";
4346d1e2ad07SJoe Perches			my $cnt = statement_rawlines($stat);
4347d1e2ad07SJoe Perches			for (my $n = 0; $n < $cnt; $n++) {
4348d1e2ad07SJoe Perches				$herectx .= raw_line($linenr, $n) . "\n";
4349d1e2ad07SJoe Perches			}
4350d1e2ad07SJoe Perches			WARN("DEFAULT_NO_BREAK",
4351d1e2ad07SJoe Perches			     "switch default: should use break\n" . $herectx);
4352caf2a54fSJoe Perches		}
4353caf2a54fSJoe Perches
435413214adfSAndy Whitcroft# check for gcc specific __FUNCTION__
4355d5e616fcSJoe Perches		if ($line =~ /\b__FUNCTION__\b/) {
4356d5e616fcSJoe Perches			if (WARN("USE_FUNC",
4357d5e616fcSJoe Perches				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
4358d5e616fcSJoe Perches			    $fix) {
4359d5e616fcSJoe Perches				$fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4360d5e616fcSJoe Perches			}
436113214adfSAndy Whitcroft		}
4362773647a0SAndy Whitcroft
43632c92488aSJoe Perches# check for use of yield()
43642c92488aSJoe Perches		if ($line =~ /\byield\s*\(\s*\)/) {
43652c92488aSJoe Perches			WARN("YIELD",
43662c92488aSJoe Perches			     "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
43672c92488aSJoe Perches		}
43682c92488aSJoe Perches
4369179f8f40SJoe Perches# check for comparisons against true and false
4370179f8f40SJoe Perches		if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4371179f8f40SJoe Perches			my $lead = $1;
4372179f8f40SJoe Perches			my $arg = $2;
4373179f8f40SJoe Perches			my $test = $3;
4374179f8f40SJoe Perches			my $otype = $4;
4375179f8f40SJoe Perches			my $trail = $5;
4376179f8f40SJoe Perches			my $op = "!";
4377179f8f40SJoe Perches
4378179f8f40SJoe Perches			($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4379179f8f40SJoe Perches
4380179f8f40SJoe Perches			my $type = lc($otype);
4381179f8f40SJoe Perches			if ($type =~ /^(?:true|false)$/) {
4382179f8f40SJoe Perches				if (("$test" eq "==" && "$type" eq "true") ||
4383179f8f40SJoe Perches				    ("$test" eq "!=" && "$type" eq "false")) {
4384179f8f40SJoe Perches					$op = "";
4385179f8f40SJoe Perches				}
4386179f8f40SJoe Perches
4387179f8f40SJoe Perches				CHK("BOOL_COMPARISON",
4388179f8f40SJoe Perches				    "Using comparison to $otype is error prone\n" . $herecurr);
4389179f8f40SJoe Perches
4390179f8f40SJoe Perches## maybe suggesting a correct construct would better
4391179f8f40SJoe Perches##				    "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4392179f8f40SJoe Perches
4393179f8f40SJoe Perches			}
4394179f8f40SJoe Perches		}
4395179f8f40SJoe Perches
43964882720bSThomas Gleixner# check for semaphores initialized locked
43974882720bSThomas Gleixner		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4398000d1cc1SJoe Perches			WARN("CONSIDER_COMPLETION",
4399000d1cc1SJoe Perches			     "consider using a completion\n" . $herecurr);
4400773647a0SAndy Whitcroft		}
44016712d858SJoe Perches
440267d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto*
440367d0a075SJoe Perches		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4404000d1cc1SJoe Perches			WARN("CONSIDER_KSTRTO",
440567d0a075SJoe Perches			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
4406773647a0SAndy Whitcroft		}
44076712d858SJoe Perches
4408f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please
4409f3db6639SMichael Ellerman		if ($line =~ /^.\s*__initcall\s*\(/) {
4410000d1cc1SJoe Perches			WARN("USE_DEVICE_INITCALL",
4411000d1cc1SJoe Perches			     "please use device_initcall() instead of __initcall()\n" . $herecurr);
4412f3db6639SMichael Ellerman		}
44136712d858SJoe Perches
441479404849SEmese Revfy# check for various ops structs, ensure they are const.
441579404849SEmese Revfy		my $struct_ops = qr{acpi_dock_ops|
441679404849SEmese Revfy				address_space_operations|
441779404849SEmese Revfy				backlight_ops|
441879404849SEmese Revfy				block_device_operations|
441979404849SEmese Revfy				dentry_operations|
442079404849SEmese Revfy				dev_pm_ops|
442179404849SEmese Revfy				dma_map_ops|
442279404849SEmese Revfy				extent_io_ops|
442379404849SEmese Revfy				file_lock_operations|
442479404849SEmese Revfy				file_operations|
442579404849SEmese Revfy				hv_ops|
442679404849SEmese Revfy				ide_dma_ops|
442779404849SEmese Revfy				intel_dvo_dev_ops|
442879404849SEmese Revfy				item_operations|
442979404849SEmese Revfy				iwl_ops|
443079404849SEmese Revfy				kgdb_arch|
443179404849SEmese Revfy				kgdb_io|
443279404849SEmese Revfy				kset_uevent_ops|
443379404849SEmese Revfy				lock_manager_operations|
443479404849SEmese Revfy				microcode_ops|
443579404849SEmese Revfy				mtrr_ops|
443679404849SEmese Revfy				neigh_ops|
443779404849SEmese Revfy				nlmsvc_binding|
443879404849SEmese Revfy				pci_raw_ops|
443979404849SEmese Revfy				pipe_buf_operations|
444079404849SEmese Revfy				platform_hibernation_ops|
444179404849SEmese Revfy				platform_suspend_ops|
444279404849SEmese Revfy				proto_ops|
444379404849SEmese Revfy				rpc_pipe_ops|
444479404849SEmese Revfy				seq_operations|
444579404849SEmese Revfy				snd_ac97_build_ops|
444679404849SEmese Revfy				soc_pcmcia_socket_ops|
444779404849SEmese Revfy				stacktrace_ops|
444879404849SEmese Revfy				sysfs_ops|
444979404849SEmese Revfy				tty_operations|
445079404849SEmese Revfy				usb_mon_operations|
445179404849SEmese Revfy				wd_ops}x;
44526903ffb2SAndy Whitcroft		if ($line !~ /\bconst\b/ &&
445379404849SEmese Revfy		    $line =~ /\bstruct\s+($struct_ops)\b/) {
4454000d1cc1SJoe Perches			WARN("CONST_STRUCT",
4455000d1cc1SJoe Perches			     "struct $1 should normally be const\n" .
44566903ffb2SAndy Whitcroft				$herecurr);
44572b6db5cbSAndy Whitcroft		}
4458773647a0SAndy Whitcroft
4459773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong
4460773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right
4461773647a0SAndy Whitcroft		if ($line =~ /\bNR_CPUS\b/ &&
4462c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4463c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4464171ae1a4SAndy Whitcroft		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4465171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4466171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4467773647a0SAndy Whitcroft		{
4468000d1cc1SJoe Perches			WARN("NR_CPUS",
4469000d1cc1SJoe Perches			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4470773647a0SAndy Whitcroft		}
44719c9ba34eSAndy Whitcroft
447252ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
447352ea8506SJoe Perches		if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
447452ea8506SJoe Perches			ERROR("DEFINE_ARCH_HAS",
447552ea8506SJoe Perches			      "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
447652ea8506SJoe Perches		}
447752ea8506SJoe Perches
44789c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings
44799c9ba34eSAndy Whitcroft		my $string;
44809c9ba34eSAndy Whitcroft		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
44819c9ba34eSAndy Whitcroft			$string = substr($rawline, $-[1], $+[1] - $-[1]);
44822a1bc5d5SAndy Whitcroft			$string =~ s/%%/__/g;
44839c9ba34eSAndy Whitcroft			if ($string =~ /(?<!%)%L[udi]/) {
4484000d1cc1SJoe Perches				WARN("PRINTF_L",
4485000d1cc1SJoe Perches				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
44869c9ba34eSAndy Whitcroft				last;
44879c9ba34eSAndy Whitcroft			}
44889c9ba34eSAndy Whitcroft		}
4489691d77b6SAndy Whitcroft
4490691d77b6SAndy Whitcroft# whine mightly about in_atomic
4491691d77b6SAndy Whitcroft		if ($line =~ /\bin_atomic\s*\(/) {
4492691d77b6SAndy Whitcroft			if ($realfile =~ m@^drivers/@) {
4493000d1cc1SJoe Perches				ERROR("IN_ATOMIC",
4494000d1cc1SJoe Perches				      "do not use in_atomic in drivers\n" . $herecurr);
4495f4a87736SAndy Whitcroft			} elsif ($realfile !~ m@^kernel/@) {
4496000d1cc1SJoe Perches				WARN("IN_ATOMIC",
4497000d1cc1SJoe Perches				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4498691d77b6SAndy Whitcroft			}
4499691d77b6SAndy Whitcroft		}
45001704f47bSPeter Zijlstra
45011704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class
45021704f47bSPeter Zijlstra		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
45031704f47bSPeter Zijlstra		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
45041704f47bSPeter Zijlstra			if ($realfile !~ m@^kernel/lockdep@ &&
45051704f47bSPeter Zijlstra			    $realfile !~ m@^include/linux/lockdep@ &&
45061704f47bSPeter Zijlstra			    $realfile !~ m@^drivers/base/core@) {
4507000d1cc1SJoe Perches				ERROR("LOCKDEP",
4508000d1cc1SJoe Perches				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
45091704f47bSPeter Zijlstra			}
45101704f47bSPeter Zijlstra		}
451188f8831cSDave Jones
451288f8831cSDave Jones		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
451388f8831cSDave Jones		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4514000d1cc1SJoe Perches			WARN("EXPORTED_WORLD_WRITABLE",
4515000d1cc1SJoe Perches			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
451688f8831cSDave Jones		}
45172435880fSJoe Perches
45182435880fSJoe Perches		foreach my $entry (@mode_permission_funcs) {
45192435880fSJoe Perches			my $func = $entry->[0];
45202435880fSJoe Perches			my $arg_pos = $entry->[1];
45212435880fSJoe Perches
45222435880fSJoe Perches			my $skip_args = "";
45232435880fSJoe Perches			if ($arg_pos > 1) {
45242435880fSJoe Perches				$arg_pos--;
45252435880fSJoe Perches				$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
45262435880fSJoe Perches			}
45272435880fSJoe Perches			my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
45282435880fSJoe Perches			if ($^V && $^V ge 5.10.0 &&
45292435880fSJoe Perches			    $line =~ /$test/) {
45302435880fSJoe Perches				my $val = $1;
45312435880fSJoe Perches				$val = $6 if ($skip_args ne "");
45322435880fSJoe Perches
45331727cc70SJoe Perches				if ($val !~ /^0$/ &&
45341727cc70SJoe Perches				    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
45351727cc70SJoe Perches				     length($val) ne 4)) {
45362435880fSJoe Perches					ERROR("NON_OCTAL_PERMISSIONS",
45371727cc70SJoe Perches					      "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
45382435880fSJoe Perches				}
45392435880fSJoe Perches			}
45402435880fSJoe Perches		}
454113214adfSAndy Whitcroft	}
454213214adfSAndy Whitcroft
454313214adfSAndy Whitcroft	# If we have no input at all, then there is nothing to report on
454413214adfSAndy Whitcroft	# so just keep quiet.
454513214adfSAndy Whitcroft	if ($#rawlines == -1) {
454613214adfSAndy Whitcroft		exit(0);
45470a920b5bSAndy Whitcroft	}
45480a920b5bSAndy Whitcroft
45498905a67cSAndy Whitcroft	# In mailback mode only produce a report in the negative, for
45508905a67cSAndy Whitcroft	# things that appear to be patches.
45518905a67cSAndy Whitcroft	if ($mailback && ($clean == 1 || !$is_patch)) {
45528905a67cSAndy Whitcroft		exit(0);
45538905a67cSAndy Whitcroft	}
45548905a67cSAndy Whitcroft
45558905a67cSAndy Whitcroft	# This is not a patch, and we are are in 'no-patch' mode so
45568905a67cSAndy Whitcroft	# just keep quiet.
45578905a67cSAndy Whitcroft	if (!$chk_patch && !$is_patch) {
45588905a67cSAndy Whitcroft		exit(0);
45598905a67cSAndy Whitcroft	}
45608905a67cSAndy Whitcroft
45618905a67cSAndy Whitcroft	if (!$is_patch) {
4562000d1cc1SJoe Perches		ERROR("NOT_UNIFIED_DIFF",
4563000d1cc1SJoe Perches		      "Does not appear to be a unified-diff format patch\n");
45640a920b5bSAndy Whitcroft	}
45650a920b5bSAndy Whitcroft	if ($is_patch && $chk_signoff && $signoff == 0) {
4566000d1cc1SJoe Perches		ERROR("MISSING_SIGN_OFF",
4567000d1cc1SJoe Perches		      "Missing Signed-off-by: line(s)\n");
45680a920b5bSAndy Whitcroft	}
45690a920b5bSAndy Whitcroft
4570f0a594c1SAndy Whitcroft	print report_dump();
457113214adfSAndy Whitcroft	if ($summary && !($clean == 1 && $quiet == 1)) {
457213214adfSAndy Whitcroft		print "$filename " if ($summary_file);
45736c72ffaaSAndy Whitcroft		print "total: $cnt_error errors, $cnt_warn warnings, " .
45746c72ffaaSAndy Whitcroft			(($check)? "$cnt_chk checks, " : "") .
45756c72ffaaSAndy Whitcroft			"$cnt_lines lines checked\n";
45768905a67cSAndy Whitcroft		print "\n" if ($quiet == 0);
45776c72ffaaSAndy Whitcroft	}
45788905a67cSAndy Whitcroft
4579d2c0a235SAndy Whitcroft	if ($quiet == 0) {
4580d1fe9c09SJoe Perches
4581d1fe9c09SJoe Perches		if ($^V lt 5.10.0) {
4582d1fe9c09SJoe Perches			print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4583d1fe9c09SJoe Perches			print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4584d1fe9c09SJoe Perches		}
4585d1fe9c09SJoe Perches
4586d2c0a235SAndy Whitcroft		# If there were whitespace errors which cleanpatch can fix
4587d2c0a235SAndy Whitcroft		# then suggest that.
4588d2c0a235SAndy Whitcroft		if ($rpt_cleaners) {
4589d2c0a235SAndy Whitcroft			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4590d2c0a235SAndy Whitcroft			print "      scripts/cleanfile\n\n";
4591b0781216SMike Frysinger			$rpt_cleaners = 0;
4592d2c0a235SAndy Whitcroft		}
4593d2c0a235SAndy Whitcroft	}
4594d2c0a235SAndy Whitcroft
459591bfe484SJoe Perches	hash_show_words(\%use_type, "Used");
459691bfe484SJoe Perches	hash_show_words(\%ignore_type, "Ignored");
4597000d1cc1SJoe Perches
45983705ce5bSJoe Perches	if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
45999624b8d6SJoe Perches		my $newfile = $filename;
46009624b8d6SJoe Perches		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
46013705ce5bSJoe Perches		my $linecount = 0;
46023705ce5bSJoe Perches		my $f;
46033705ce5bSJoe Perches
46043705ce5bSJoe Perches		open($f, '>', $newfile)
46053705ce5bSJoe Perches		    or die "$P: Can't open $newfile for write\n";
46063705ce5bSJoe Perches		foreach my $fixed_line (@fixed) {
46073705ce5bSJoe Perches			$linecount++;
46083705ce5bSJoe Perches			if ($file) {
46093705ce5bSJoe Perches				if ($linecount > 3) {
46103705ce5bSJoe Perches					$fixed_line =~ s/^\+//;
46113705ce5bSJoe Perches					print $f $fixed_line. "\n";
46123705ce5bSJoe Perches				}
46133705ce5bSJoe Perches			} else {
46143705ce5bSJoe Perches				print $f $fixed_line . "\n";
46153705ce5bSJoe Perches			}
46163705ce5bSJoe Perches		}
46173705ce5bSJoe Perches		close($f);
46183705ce5bSJoe Perches
46193705ce5bSJoe Perches		if (!$quiet) {
46203705ce5bSJoe Perches			print << "EOM";
46213705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile'
46223705ce5bSJoe Perches
46233705ce5bSJoe PerchesDo _NOT_ trust the results written to this file.
46243705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness.
46253705ce5bSJoe Perches
46263705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches.
46273705ce5bSJoe PerchesNo warranties, expressed or implied...
46283705ce5bSJoe Perches
46293705ce5bSJoe PerchesEOM
46303705ce5bSJoe Perches		}
46313705ce5bSJoe Perches	}
46323705ce5bSJoe Perches
46330a920b5bSAndy Whitcroft	if ($clean == 1 && $quiet == 0) {
4634c2fdda0dSAndy Whitcroft		print "$vname has no obvious style problems and is ready for submission.\n"
46350a920b5bSAndy Whitcroft	}
46360a920b5bSAndy Whitcroft	if ($clean == 0 && $quiet == 0) {
4637000d1cc1SJoe Perches		print << "EOM";
4638000d1cc1SJoe Perches$vname has style problems, please review.
4639000d1cc1SJoe Perches
4640000d1cc1SJoe PerchesIf any of these errors are false positives, please report
4641000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS.
4642000d1cc1SJoe PerchesEOM
46430a920b5bSAndy Whitcroft	}
464413214adfSAndy Whitcroft
46450a920b5bSAndy Whitcroft	return $clean;
46460a920b5bSAndy Whitcroft}
4647