xref: /linux/scripts/checkpatch.pl (revision aaa3e7fb81d8a8598b993c8012f4b8aa18d92b20)
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3#
4# (c) 2001, Dave Jones. (the file handling bit)
5# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8# (c) 2010-2018 Joe Perches <joe@perches.com>
9
10use strict;
11use warnings;
12use POSIX;
13use File::Basename;
14use Cwd 'abs_path';
15use Term::ANSIColor qw(:constants);
16use Encode qw(decode encode);
17
18my $P = $0;
19my $D = dirname(abs_path($P));
20
21my $V = '0.32';
22
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $tree = 1;
27my $chk_signoff = 1;
28my $chk_patch = 1;
29my $tst_only;
30my $emacs = 0;
31my $terse = 0;
32my $showfile = 0;
33my $file = 0;
34my $git = 0;
35my %git_commits = ();
36my $check = 0;
37my $check_orig = 0;
38my $summary = 1;
39my $mailback = 0;
40my $summary_file = 0;
41my $show_types = 0;
42my $list_types = 0;
43my $fix = 0;
44my $fix_inplace = 0;
45my $root;
46my %debug;
47my %camelcase = ();
48my %use_type = ();
49my @use = ();
50my %ignore_type = ();
51my @ignore = ();
52my $help = 0;
53my $configuration_file = ".checkpatch.conf";
54my $max_line_length = 100;
55my $ignore_perl_version = 0;
56my $minimum_perl_version = 5.10.0;
57my $min_conf_desc_length = 4;
58my $spelling_file = "$D/spelling.txt";
59my $codespell = 0;
60my $codespellfile = "/usr/share/codespell/dictionary.txt";
61my $conststructsfile = "$D/const_structs.checkpatch";
62my $typedefsfile;
63my $color = "auto";
64my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
65# git output parsing needs US English output, so first set backtick child process LANGUAGE
66my $git_command ='export LANGUAGE=en_US.UTF-8; git';
67my $tabsize = 8;
68
69sub help {
70	my ($exitcode) = @_;
71
72	print << "EOM";
73Usage: $P [OPTION]... [FILE]...
74Version: $V
75
76Options:
77  -q, --quiet                quiet
78  --no-tree                  run without a kernel tree
79  --no-signoff               do not check for 'Signed-off-by' line
80  --patch                    treat FILE as patchfile (default)
81  --emacs                    emacs compile window format
82  --terse                    one line per report
83  --showfile                 emit diffed file position, not input file position
84  -g, --git                  treat FILE as a single commit or git revision range
85                             single git commit with:
86                               <rev>
87                               <rev>^
88                               <rev>~n
89                             multiple git commits with:
90                               <rev1>..<rev2>
91                               <rev1>...<rev2>
92                               <rev>-<count>
93                             git merges are ignored
94  -f, --file                 treat FILE as regular source file
95  --subjective, --strict     enable more subjective tests
96  --list-types               list the possible message types
97  --types TYPE(,TYPE2...)    show only these comma separated message types
98  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
99  --show-types               show the specific message type in the output
100  --max-line-length=n        set the maximum line length, (default $max_line_length)
101                             if exceeded, warn on patches
102                             requires --strict for use with --file
103  --min-conf-desc-length=n   set the min description length, if shorter, warn
104  --tab-size=n               set the number of spaces for tab (default $tabsize)
105  --root=PATH                PATH to the kernel tree root
106  --no-summary               suppress the per-file summary
107  --mailback                 only produce a report in case of warnings/errors
108  --summary-file             include the filename in summary
109  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
110                             'values', 'possible', 'type', and 'attr' (default
111                             is all off)
112  --test-only=WORD           report only warnings/errors containing WORD
113                             literally
114  --fix                      EXPERIMENTAL - may create horrible results
115                             If correctable single-line errors exist, create
116                             "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
117                             with potential errors corrected to the preferred
118                             checkpatch style
119  --fix-inplace              EXPERIMENTAL - may create horrible results
120                             Is the same as --fix, but overwrites the input
121                             file.  It's your fault if there's no backup or git
122  --ignore-perl-version      override checking of perl version.  expect
123                             runtime errors.
124  --codespell                Use the codespell dictionary for spelling/typos
125                             (default:/usr/share/codespell/dictionary.txt)
126  --codespellfile            Use this codespell dictionary
127  --typedefsfile             Read additional types from this file
128  --color[=WHEN]             Use colors 'always', 'never', or only when output
129                             is a terminal ('auto'). Default is 'auto'.
130  -h, --help, --version      display this help and exit
131
132When FILE is - read standard input.
133EOM
134
135	exit($exitcode);
136}
137
138sub uniq {
139	my %seen;
140	return grep { !$seen{$_}++ } @_;
141}
142
143sub list_types {
144	my ($exitcode) = @_;
145
146	my $count = 0;
147
148	local $/ = undef;
149
150	open(my $script, '<', abs_path($P)) or
151	    die "$P: Can't read '$P' $!\n";
152
153	my $text = <$script>;
154	close($script);
155
156	my @types = ();
157	# Also catch when type or level is passed through a variable
158	for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
159		push (@types, $_);
160	}
161	@types = sort(uniq(@types));
162	print("#\tMessage type\n\n");
163	foreach my $type (@types) {
164		print(++$count . "\t" . $type . "\n");
165	}
166
167	exit($exitcode);
168}
169
170my $conf = which_conf($configuration_file);
171if (-f $conf) {
172	my @conf_args;
173	open(my $conffile, '<', "$conf")
174	    or warn "$P: Can't find a readable $configuration_file file $!\n";
175
176	while (<$conffile>) {
177		my $line = $_;
178
179		$line =~ s/\s*\n?$//g;
180		$line =~ s/^\s*//g;
181		$line =~ s/\s+/ /g;
182
183		next if ($line =~ m/^\s*#/);
184		next if ($line =~ m/^\s*$/);
185
186		my @words = split(" ", $line);
187		foreach my $word (@words) {
188			last if ($word =~ m/^#/);
189			push (@conf_args, $word);
190		}
191	}
192	close($conffile);
193	unshift(@ARGV, @conf_args) if @conf_args;
194}
195
196# Perl's Getopt::Long allows options to take optional arguments after a space.
197# Prevent --color by itself from consuming other arguments
198foreach (@ARGV) {
199	if ($_ eq "--color" || $_ eq "-color") {
200		$_ = "--color=$color";
201	}
202}
203
204GetOptions(
205	'q|quiet+'	=> \$quiet,
206	'tree!'		=> \$tree,
207	'signoff!'	=> \$chk_signoff,
208	'patch!'	=> \$chk_patch,
209	'emacs!'	=> \$emacs,
210	'terse!'	=> \$terse,
211	'showfile!'	=> \$showfile,
212	'f|file!'	=> \$file,
213	'g|git!'	=> \$git,
214	'subjective!'	=> \$check,
215	'strict!'	=> \$check,
216	'ignore=s'	=> \@ignore,
217	'types=s'	=> \@use,
218	'show-types!'	=> \$show_types,
219	'list-types!'	=> \$list_types,
220	'max-line-length=i' => \$max_line_length,
221	'min-conf-desc-length=i' => \$min_conf_desc_length,
222	'tab-size=i'	=> \$tabsize,
223	'root=s'	=> \$root,
224	'summary!'	=> \$summary,
225	'mailback!'	=> \$mailback,
226	'summary-file!'	=> \$summary_file,
227	'fix!'		=> \$fix,
228	'fix-inplace!'	=> \$fix_inplace,
229	'ignore-perl-version!' => \$ignore_perl_version,
230	'debug=s'	=> \%debug,
231	'test-only=s'	=> \$tst_only,
232	'codespell!'	=> \$codespell,
233	'codespellfile=s'	=> \$codespellfile,
234	'typedefsfile=s'	=> \$typedefsfile,
235	'color=s'	=> \$color,
236	'no-color'	=> \$color,	#keep old behaviors of -nocolor
237	'nocolor'	=> \$color,	#keep old behaviors of -nocolor
238	'h|help'	=> \$help,
239	'version'	=> \$help
240) or help(1);
241
242help(0) if ($help);
243
244list_types(0) if ($list_types);
245
246$fix = 1 if ($fix_inplace);
247$check_orig = $check;
248
249die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
250
251my $exit = 0;
252
253my $perl_version_ok = 1;
254if ($^V && $^V lt $minimum_perl_version) {
255	$perl_version_ok = 0;
256	printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
257	exit(1) if (!$ignore_perl_version);
258}
259
260#if no filenames are given, push '-' to read patch from stdin
261if ($#ARGV < 0) {
262	push(@ARGV, '-');
263}
264
265if ($color =~ /^[01]$/) {
266	$color = !$color;
267} elsif ($color =~ /^always$/i) {
268	$color = 1;
269} elsif ($color =~ /^never$/i) {
270	$color = 0;
271} elsif ($color =~ /^auto$/i) {
272	$color = (-t STDOUT);
273} else {
274	die "$P: Invalid color mode: $color\n";
275}
276
277# skip TAB size 1 to avoid additional checks on $tabsize - 1
278die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
279
280sub hash_save_array_words {
281	my ($hashRef, $arrayRef) = @_;
282
283	my @array = split(/,/, join(',', @$arrayRef));
284	foreach my $word (@array) {
285		$word =~ s/\s*\n?$//g;
286		$word =~ s/^\s*//g;
287		$word =~ s/\s+/ /g;
288		$word =~ tr/[a-z]/[A-Z]/;
289
290		next if ($word =~ m/^\s*#/);
291		next if ($word =~ m/^\s*$/);
292
293		$hashRef->{$word}++;
294	}
295}
296
297sub hash_show_words {
298	my ($hashRef, $prefix) = @_;
299
300	if (keys %$hashRef) {
301		print "\nNOTE: $prefix message types:";
302		foreach my $word (sort keys %$hashRef) {
303			print " $word";
304		}
305		print "\n";
306	}
307}
308
309hash_save_array_words(\%ignore_type, \@ignore);
310hash_save_array_words(\%use_type, \@use);
311
312my $dbg_values = 0;
313my $dbg_possible = 0;
314my $dbg_type = 0;
315my $dbg_attr = 0;
316for my $key (keys %debug) {
317	## no critic
318	eval "\${dbg_$key} = '$debug{$key}';";
319	die "$@" if ($@);
320}
321
322my $rpt_cleaners = 0;
323
324if ($terse) {
325	$emacs = 1;
326	$quiet++;
327}
328
329if ($tree) {
330	if (defined $root) {
331		if (!top_of_kernel_tree($root)) {
332			die "$P: $root: --root does not point at a valid tree\n";
333		}
334	} else {
335		if (top_of_kernel_tree('.')) {
336			$root = '.';
337		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
338						top_of_kernel_tree($1)) {
339			$root = $1;
340		}
341	}
342
343	if (!defined $root) {
344		print "Must be run from the top-level dir. of a kernel tree\n";
345		exit(2);
346	}
347}
348
349my $emitted_corrupt = 0;
350
351our $Ident	= qr{
352			[A-Za-z_][A-Za-z\d_]*
353			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
354		}x;
355our $Storage	= qr{extern|static|asmlinkage};
356our $Sparse	= qr{
357			__user|
358			__kernel|
359			__force|
360			__iomem|
361			__must_check|
362			__kprobes|
363			__ref|
364			__refconst|
365			__refdata|
366			__rcu|
367			__private
368		}x;
369our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
370our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
371our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
372our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
373our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
374
375# Notes to $Attribute:
376# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
377our $Attribute	= qr{
378			const|
379			__percpu|
380			__nocast|
381			__safe|
382			__bitwise|
383			__packed__|
384			__packed2__|
385			__naked|
386			__maybe_unused|
387			__always_unused|
388			__noreturn|
389			__used|
390			__cold|
391			__pure|
392			__noclone|
393			__deprecated|
394			__read_mostly|
395			__ro_after_init|
396			__kprobes|
397			$InitAttribute|
398			____cacheline_aligned|
399			____cacheline_aligned_in_smp|
400			____cacheline_internodealigned_in_smp|
401			__weak
402		  }x;
403our $Modifier;
404our $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
405our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
406our $Lval	= qr{$Ident(?:$Member)*};
407
408our $Int_type	= qr{(?i)llu|ull|ll|lu|ul|l|u};
409our $Binary	= qr{(?i)0b[01]+$Int_type?};
410our $Hex	= qr{(?i)0x[0-9a-f]+$Int_type?};
411our $Int	= qr{[0-9]+$Int_type?};
412our $Octal	= qr{0[0-7]+$Int_type?};
413our $String	= qr{"[X\t]*"};
414our $Float_hex	= qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
415our $Float_dec	= qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
416our $Float_int	= qr{(?i)[0-9]+e-?[0-9]+[fl]?};
417our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
418our $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
419our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
420our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
421our $Arithmetic = qr{\+|-|\*|\/|%};
422our $Operators	= qr{
423			<=|>=|==|!=|
424			=>|->|<<|>>|<|>|!|~|
425			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
426		  }x;
427
428our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
429
430our $BasicType;
431our $NonptrType;
432our $NonptrTypeMisordered;
433our $NonptrTypeWithAttr;
434our $Type;
435our $TypeMisordered;
436our $Declare;
437our $DeclareMisordered;
438
439our $NON_ASCII_UTF8	= qr{
440	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
441	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
442	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
443	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
444	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
445	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
446	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
447}x;
448
449our $UTF8	= qr{
450	[\x09\x0A\x0D\x20-\x7E]              # ASCII
451	| $NON_ASCII_UTF8
452}x;
453
454our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
455our $typeOtherOSTypedefs = qr{(?x:
456	u_(?:char|short|int|long) |          # bsd
457	u(?:nchar|short|int|long)            # sysv
458)};
459our $typeKernelTypedefs = qr{(?x:
460	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
461	atomic_t
462)};
463our $typeTypedefs = qr{(?x:
464	$typeC99Typedefs\b|
465	$typeOtherOSTypedefs\b|
466	$typeKernelTypedefs\b
467)};
468
469our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
470
471our $logFunctions = qr{(?x:
472	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
473	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
474	TP_printk|
475	WARN(?:_RATELIMIT|_ONCE|)|
476	panic|
477	MODULE_[A-Z_]+|
478	seq_vprintf|seq_printf|seq_puts
479)};
480
481our $allocFunctions = qr{(?x:
482	(?:(?:devm_)?
483		(?:kv|k|v)[czm]alloc(?:_node|_array)? |
484		kstrdup(?:_const)? |
485		kmemdup(?:_nul)?) |
486	(?:\w+)?alloc_skb(?:_ip_align)? |
487				# dev_alloc_skb/netdev_alloc_skb, et al
488	dma_alloc_coherent
489)};
490
491our $signature_tags = qr{(?xi:
492	Signed-off-by:|
493	Co-developed-by:|
494	Acked-by:|
495	Tested-by:|
496	Reviewed-by:|
497	Reported-by:|
498	Suggested-by:|
499	To:|
500	Cc:
501)};
502
503our @typeListMisordered = (
504	qr{char\s+(?:un)?signed},
505	qr{int\s+(?:(?:un)?signed\s+)?short\s},
506	qr{int\s+short(?:\s+(?:un)?signed)},
507	qr{short\s+int(?:\s+(?:un)?signed)},
508	qr{(?:un)?signed\s+int\s+short},
509	qr{short\s+(?:un)?signed},
510	qr{long\s+int\s+(?:un)?signed},
511	qr{int\s+long\s+(?:un)?signed},
512	qr{long\s+(?:un)?signed\s+int},
513	qr{int\s+(?:un)?signed\s+long},
514	qr{int\s+(?:un)?signed},
515	qr{int\s+long\s+long\s+(?:un)?signed},
516	qr{long\s+long\s+int\s+(?:un)?signed},
517	qr{long\s+long\s+(?:un)?signed\s+int},
518	qr{long\s+long\s+(?:un)?signed},
519	qr{long\s+(?:un)?signed},
520);
521
522our @typeList = (
523	qr{void},
524	qr{(?:(?:un)?signed\s+)?char},
525	qr{(?:(?:un)?signed\s+)?short\s+int},
526	qr{(?:(?:un)?signed\s+)?short},
527	qr{(?:(?:un)?signed\s+)?int},
528	qr{(?:(?:un)?signed\s+)?long\s+int},
529	qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
530	qr{(?:(?:un)?signed\s+)?long\s+long},
531	qr{(?:(?:un)?signed\s+)?long},
532	qr{(?:un)?signed},
533	qr{float},
534	qr{double},
535	qr{bool},
536	qr{struct\s+$Ident},
537	qr{union\s+$Ident},
538	qr{enum\s+$Ident},
539	qr{${Ident}_t},
540	qr{${Ident}_handler},
541	qr{${Ident}_handler_fn},
542	@typeListMisordered,
543);
544
545our $C90_int_types = qr{(?x:
546	long\s+long\s+int\s+(?:un)?signed|
547	long\s+long\s+(?:un)?signed\s+int|
548	long\s+long\s+(?:un)?signed|
549	(?:(?:un)?signed\s+)?long\s+long\s+int|
550	(?:(?:un)?signed\s+)?long\s+long|
551	int\s+long\s+long\s+(?:un)?signed|
552	int\s+(?:(?:un)?signed\s+)?long\s+long|
553
554	long\s+int\s+(?:un)?signed|
555	long\s+(?:un)?signed\s+int|
556	long\s+(?:un)?signed|
557	(?:(?:un)?signed\s+)?long\s+int|
558	(?:(?:un)?signed\s+)?long|
559	int\s+long\s+(?:un)?signed|
560	int\s+(?:(?:un)?signed\s+)?long|
561
562	int\s+(?:un)?signed|
563	(?:(?:un)?signed\s+)?int
564)};
565
566our @typeListFile = ();
567our @typeListWithAttr = (
568	@typeList,
569	qr{struct\s+$InitAttribute\s+$Ident},
570	qr{union\s+$InitAttribute\s+$Ident},
571);
572
573our @modifierList = (
574	qr{fastcall},
575);
576our @modifierListFile = ();
577
578our @mode_permission_funcs = (
579	["module_param", 3],
580	["module_param_(?:array|named|string)", 4],
581	["module_param_array_named", 5],
582	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
583	["proc_create(?:_data|)", 2],
584	["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
585	["IIO_DEV_ATTR_[A-Z_]+", 1],
586	["SENSOR_(?:DEVICE_|)ATTR_2", 2],
587	["SENSOR_TEMPLATE(?:_2|)", 3],
588	["__ATTR", 2],
589);
590
591my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
592
593#Create a search pattern for all these functions to speed up a loop below
594our $mode_perms_search = "";
595foreach my $entry (@mode_permission_funcs) {
596	$mode_perms_search .= '|' if ($mode_perms_search ne "");
597	$mode_perms_search .= $entry->[0];
598}
599$mode_perms_search = "(?:${mode_perms_search})";
600
601our %deprecated_apis = (
602	"synchronize_rcu_bh"			=> "synchronize_rcu",
603	"synchronize_rcu_bh_expedited"		=> "synchronize_rcu_expedited",
604	"call_rcu_bh"				=> "call_rcu",
605	"rcu_barrier_bh"			=> "rcu_barrier",
606	"synchronize_sched"			=> "synchronize_rcu",
607	"synchronize_sched_expedited"		=> "synchronize_rcu_expedited",
608	"call_rcu_sched"			=> "call_rcu",
609	"rcu_barrier_sched"			=> "rcu_barrier",
610	"get_state_synchronize_sched"		=> "get_state_synchronize_rcu",
611	"cond_synchronize_sched"		=> "cond_synchronize_rcu",
612);
613
614#Create a search pattern for all these strings to speed up a loop below
615our $deprecated_apis_search = "";
616foreach my $entry (keys %deprecated_apis) {
617	$deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
618	$deprecated_apis_search .= $entry;
619}
620$deprecated_apis_search = "(?:${deprecated_apis_search})";
621
622our $mode_perms_world_writable = qr{
623	S_IWUGO		|
624	S_IWOTH		|
625	S_IRWXUGO	|
626	S_IALLUGO	|
627	0[0-7][0-7][2367]
628}x;
629
630our %mode_permission_string_types = (
631	"S_IRWXU" => 0700,
632	"S_IRUSR" => 0400,
633	"S_IWUSR" => 0200,
634	"S_IXUSR" => 0100,
635	"S_IRWXG" => 0070,
636	"S_IRGRP" => 0040,
637	"S_IWGRP" => 0020,
638	"S_IXGRP" => 0010,
639	"S_IRWXO" => 0007,
640	"S_IROTH" => 0004,
641	"S_IWOTH" => 0002,
642	"S_IXOTH" => 0001,
643	"S_IRWXUGO" => 0777,
644	"S_IRUGO" => 0444,
645	"S_IWUGO" => 0222,
646	"S_IXUGO" => 0111,
647);
648
649#Create a search pattern for all these strings to speed up a loop below
650our $mode_perms_string_search = "";
651foreach my $entry (keys %mode_permission_string_types) {
652	$mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
653	$mode_perms_string_search .= $entry;
654}
655our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
656our $multi_mode_perms_string_search = qr{
657	${single_mode_perms_string_search}
658	(?:\s*\|\s*${single_mode_perms_string_search})*
659}x;
660
661sub perms_to_octal {
662	my ($string) = @_;
663
664	return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
665
666	my $val = "";
667	my $oval = "";
668	my $to = 0;
669	my $curpos = 0;
670	my $lastpos = 0;
671	while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
672		$curpos = pos($string);
673		my $match = $2;
674		my $omatch = $1;
675		last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
676		$lastpos = $curpos;
677		$to |= $mode_permission_string_types{$match};
678		$val .= '\s*\|\s*' if ($val ne "");
679		$val .= $match;
680		$oval .= $omatch;
681	}
682	$oval =~ s/^\s*\|\s*//;
683	$oval =~ s/\s*\|\s*$//;
684	return sprintf("%04o", $to);
685}
686
687our $allowed_asm_includes = qr{(?x:
688	irq|
689	memory|
690	time|
691	reboot
692)};
693# memory.h: ARM has a custom one
694
695# Load common spelling mistakes and build regular expression list.
696my $misspellings;
697my %spelling_fix;
698
699if (open(my $spelling, '<', $spelling_file)) {
700	while (<$spelling>) {
701		my $line = $_;
702
703		$line =~ s/\s*\n?$//g;
704		$line =~ s/^\s*//g;
705
706		next if ($line =~ m/^\s*#/);
707		next if ($line =~ m/^\s*$/);
708
709		my ($suspect, $fix) = split(/\|\|/, $line);
710
711		$spelling_fix{$suspect} = $fix;
712	}
713	close($spelling);
714} else {
715	warn "No typos will be found - file '$spelling_file': $!\n";
716}
717
718if ($codespell) {
719	if (open(my $spelling, '<', $codespellfile)) {
720		while (<$spelling>) {
721			my $line = $_;
722
723			$line =~ s/\s*\n?$//g;
724			$line =~ s/^\s*//g;
725
726			next if ($line =~ m/^\s*#/);
727			next if ($line =~ m/^\s*$/);
728			next if ($line =~ m/, disabled/i);
729
730			$line =~ s/,.*$//;
731
732			my ($suspect, $fix) = split(/->/, $line);
733
734			$spelling_fix{$suspect} = $fix;
735		}
736		close($spelling);
737	} else {
738		warn "No codespell typos will be found - file '$codespellfile': $!\n";
739	}
740}
741
742$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
743
744sub read_words {
745	my ($wordsRef, $file) = @_;
746
747	if (open(my $words, '<', $file)) {
748		while (<$words>) {
749			my $line = $_;
750
751			$line =~ s/\s*\n?$//g;
752			$line =~ s/^\s*//g;
753
754			next if ($line =~ m/^\s*#/);
755			next if ($line =~ m/^\s*$/);
756			if ($line =~ /\s/) {
757				print("$file: '$line' invalid - ignored\n");
758				next;
759			}
760
761			$$wordsRef .= '|' if (defined $$wordsRef);
762			$$wordsRef .= $line;
763		}
764		close($file);
765		return 1;
766	}
767
768	return 0;
769}
770
771my $const_structs;
772if (show_type("CONST_STRUCT")) {
773	read_words(\$const_structs, $conststructsfile)
774	    or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
775}
776
777if (defined($typedefsfile)) {
778	my $typeOtherTypedefs;
779	read_words(\$typeOtherTypedefs, $typedefsfile)
780	    or warn "No additional types will be considered - file '$typedefsfile': $!\n";
781	$typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
782}
783
784sub build_types {
785	my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
786	my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
787	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
788	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
789	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
790	$BasicType	= qr{
791				(?:$typeTypedefs\b)|
792				(?:${all}\b)
793		}x;
794	$NonptrType	= qr{
795			(?:$Modifier\s+|const\s+)*
796			(?:
797				(?:typeof|__typeof__)\s*\([^\)]*\)|
798				(?:$typeTypedefs\b)|
799				(?:${all}\b)
800			)
801			(?:\s+$Modifier|\s+const)*
802		  }x;
803	$NonptrTypeMisordered	= qr{
804			(?:$Modifier\s+|const\s+)*
805			(?:
806				(?:${Misordered}\b)
807			)
808			(?:\s+$Modifier|\s+const)*
809		  }x;
810	$NonptrTypeWithAttr	= qr{
811			(?:$Modifier\s+|const\s+)*
812			(?:
813				(?:typeof|__typeof__)\s*\([^\)]*\)|
814				(?:$typeTypedefs\b)|
815				(?:${allWithAttr}\b)
816			)
817			(?:\s+$Modifier|\s+const)*
818		  }x;
819	$Type	= qr{
820			$NonptrType
821			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
822			(?:\s+$Inline|\s+$Modifier)*
823		  }x;
824	$TypeMisordered	= qr{
825			$NonptrTypeMisordered
826			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
827			(?:\s+$Inline|\s+$Modifier)*
828		  }x;
829	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
830	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
831}
832build_types();
833
834our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
835
836# Using $balanced_parens, $LvalOrFunc, or $FuncArg
837# requires at least perl version v5.10.0
838# Any use must be runtime checked with $^V
839
840our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
841our $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
842our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
843
844our $declaration_macros = qr{(?x:
845	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
846	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
847	(?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
848)};
849
850sub deparenthesize {
851	my ($string) = @_;
852	return "" if (!defined($string));
853
854	while ($string =~ /^\s*\(.*\)\s*$/) {
855		$string =~ s@^\s*\(\s*@@;
856		$string =~ s@\s*\)\s*$@@;
857	}
858
859	$string =~ s@\s+@ @g;
860
861	return $string;
862}
863
864sub seed_camelcase_file {
865	my ($file) = @_;
866
867	return if (!(-f $file));
868
869	local $/;
870
871	open(my $include_file, '<', "$file")
872	    or warn "$P: Can't read '$file' $!\n";
873	my $text = <$include_file>;
874	close($include_file);
875
876	my @lines = split('\n', $text);
877
878	foreach my $line (@lines) {
879		next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
880		if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
881			$camelcase{$1} = 1;
882		} elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
883			$camelcase{$1} = 1;
884		} elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
885			$camelcase{$1} = 1;
886		}
887	}
888}
889
890our %maintained_status = ();
891
892sub is_maintained_obsolete {
893	my ($filename) = @_;
894
895	return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
896
897	if (!exists($maintained_status{$filename})) {
898		$maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
899	}
900
901	return $maintained_status{$filename} =~ /obsolete/i;
902}
903
904sub is_SPDX_License_valid {
905	my ($license) = @_;
906
907	return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
908
909	my $root_path = abs_path($root);
910	my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
911	return 0 if ($status ne "");
912	return 1;
913}
914
915my $camelcase_seeded = 0;
916sub seed_camelcase_includes {
917	return if ($camelcase_seeded);
918
919	my $files;
920	my $camelcase_cache = "";
921	my @include_files = ();
922
923	$camelcase_seeded = 1;
924
925	if (-e ".git") {
926		my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
927		chomp $git_last_include_commit;
928		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
929	} else {
930		my $last_mod_date = 0;
931		$files = `find $root/include -name "*.h"`;
932		@include_files = split('\n', $files);
933		foreach my $file (@include_files) {
934			my $date = POSIX::strftime("%Y%m%d%H%M",
935						   localtime((stat $file)[9]));
936			$last_mod_date = $date if ($last_mod_date < $date);
937		}
938		$camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
939	}
940
941	if ($camelcase_cache ne "" && -f $camelcase_cache) {
942		open(my $camelcase_file, '<', "$camelcase_cache")
943		    or warn "$P: Can't read '$camelcase_cache' $!\n";
944		while (<$camelcase_file>) {
945			chomp;
946			$camelcase{$_} = 1;
947		}
948		close($camelcase_file);
949
950		return;
951	}
952
953	if (-e ".git") {
954		$files = `${git_command} ls-files "include/*.h"`;
955		@include_files = split('\n', $files);
956	}
957
958	foreach my $file (@include_files) {
959		seed_camelcase_file($file);
960	}
961
962	if ($camelcase_cache ne "") {
963		unlink glob ".checkpatch-camelcase.*";
964		open(my $camelcase_file, '>', "$camelcase_cache")
965		    or warn "$P: Can't write '$camelcase_cache' $!\n";
966		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
967			print $camelcase_file ("$_\n");
968		}
969		close($camelcase_file);
970	}
971}
972
973sub git_commit_info {
974	my ($commit, $id, $desc) = @_;
975
976	return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
977
978	my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
979	$output =~ s/^\s*//gm;
980	my @lines = split("\n", $output);
981
982	return ($id, $desc) if ($#lines < 0);
983
984	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
985# Maybe one day convert this block of bash into something that returns
986# all matching commit ids, but it's very slow...
987#
988#		echo "checking commits $1..."
989#		git rev-list --remotes | grep -i "^$1" |
990#		while read line ; do
991#		    git log --format='%H %s' -1 $line |
992#		    echo "commit $(cut -c 1-12,41-)"
993#		done
994	} elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
995		$id = undef;
996	} else {
997		$id = substr($lines[0], 0, 12);
998		$desc = substr($lines[0], 41);
999	}
1000
1001	return ($id, $desc);
1002}
1003
1004$chk_signoff = 0 if ($file);
1005
1006my @rawlines = ();
1007my @lines = ();
1008my @fixed = ();
1009my @fixed_inserted = ();
1010my @fixed_deleted = ();
1011my $fixlinenr = -1;
1012
1013# If input is git commits, extract all commits from the commit expressions.
1014# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1015die "$P: No git repository found\n" if ($git && !-e ".git");
1016
1017if ($git) {
1018	my @commits = ();
1019	foreach my $commit_expr (@ARGV) {
1020		my $git_range;
1021		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1022			$git_range = "-$2 $1";
1023		} elsif ($commit_expr =~ m/\.\./) {
1024			$git_range = "$commit_expr";
1025		} else {
1026			$git_range = "-1 $commit_expr";
1027		}
1028		my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1029		foreach my $line (split(/\n/, $lines)) {
1030			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1031			next if (!defined($1) || !defined($2));
1032			my $sha1 = $1;
1033			my $subject = $2;
1034			unshift(@commits, $sha1);
1035			$git_commits{$sha1} = $subject;
1036		}
1037	}
1038	die "$P: no git commits after extraction!\n" if (@commits == 0);
1039	@ARGV = @commits;
1040}
1041
1042my $vname;
1043$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1044for my $filename (@ARGV) {
1045	my $FILE;
1046	if ($git) {
1047		open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1048			die "$P: $filename: git format-patch failed - $!\n";
1049	} elsif ($file) {
1050		open($FILE, '-|', "diff -u /dev/null $filename") ||
1051			die "$P: $filename: diff failed - $!\n";
1052	} elsif ($filename eq '-') {
1053		open($FILE, '<&STDIN');
1054	} else {
1055		open($FILE, '<', "$filename") ||
1056			die "$P: $filename: open failed - $!\n";
1057	}
1058	if ($filename eq '-') {
1059		$vname = 'Your patch';
1060	} elsif ($git) {
1061		$vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1062	} else {
1063		$vname = $filename;
1064	}
1065	while (<$FILE>) {
1066		chomp;
1067		push(@rawlines, $_);
1068		$vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
1069	}
1070	close($FILE);
1071
1072	if ($#ARGV > 0 && $quiet == 0) {
1073		print '-' x length($vname) . "\n";
1074		print "$vname\n";
1075		print '-' x length($vname) . "\n";
1076	}
1077
1078	if (!process($filename)) {
1079		$exit = 1;
1080	}
1081	@rawlines = ();
1082	@lines = ();
1083	@fixed = ();
1084	@fixed_inserted = ();
1085	@fixed_deleted = ();
1086	$fixlinenr = -1;
1087	@modifierListFile = ();
1088	@typeListFile = ();
1089	build_types();
1090}
1091
1092if (!$quiet) {
1093	hash_show_words(\%use_type, "Used");
1094	hash_show_words(\%ignore_type, "Ignored");
1095
1096	if (!$perl_version_ok) {
1097		print << "EOM"
1098
1099NOTE: perl $^V is not modern enough to detect all possible issues.
1100      An upgrade to at least perl $minimum_perl_version is suggested.
1101EOM
1102	}
1103	if ($exit) {
1104		print << "EOM"
1105
1106NOTE: If any of the errors are false positives, please report
1107      them to the maintainer, see CHECKPATCH in MAINTAINERS.
1108EOM
1109	}
1110}
1111
1112exit($exit);
1113
1114sub top_of_kernel_tree {
1115	my ($root) = @_;
1116
1117	my @tree_check = (
1118		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1119		"README", "Documentation", "arch", "include", "drivers",
1120		"fs", "init", "ipc", "kernel", "lib", "scripts",
1121	);
1122
1123	foreach my $check (@tree_check) {
1124		if (! -e $root . '/' . $check) {
1125			return 0;
1126		}
1127	}
1128	return 1;
1129}
1130
1131sub parse_email {
1132	my ($formatted_email) = @_;
1133
1134	my $name = "";
1135	my $name_comment = "";
1136	my $address = "";
1137	my $comment = "";
1138
1139	if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1140		$name = $1;
1141		$address = $2;
1142		$comment = $3 if defined $3;
1143	} elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1144		$address = $1;
1145		$comment = $2 if defined $2;
1146	} elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1147		$address = $1;
1148		$comment = $2 if defined $2;
1149		$formatted_email =~ s/\Q$address\E.*$//;
1150		$name = $formatted_email;
1151		$name = trim($name);
1152		$name =~ s/^\"|\"$//g;
1153		# If there's a name left after stripping spaces and
1154		# leading quotes, and the address doesn't have both
1155		# leading and trailing angle brackets, the address
1156		# is invalid. ie:
1157		#   "joe smith joe@smith.com" bad
1158		#   "joe smith <joe@smith.com" bad
1159		if ($name ne "" && $address !~ /^<[^>]+>$/) {
1160			$name = "";
1161			$address = "";
1162			$comment = "";
1163		}
1164	}
1165
1166	$name = trim($name);
1167	$name =~ s/^\"|\"$//g;
1168	$name =~ s/(\s*\([^\)]+\))\s*//;
1169	if (defined($1)) {
1170		$name_comment = trim($1);
1171	}
1172	$address = trim($address);
1173	$address =~ s/^\<|\>$//g;
1174
1175	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1176		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1177		$name = "\"$name\"";
1178	}
1179
1180	return ($name, $name_comment, $address, $comment);
1181}
1182
1183sub format_email {
1184	my ($name, $address) = @_;
1185
1186	my $formatted_email;
1187
1188	$name = trim($name);
1189	$name =~ s/^\"|\"$//g;
1190	$address = trim($address);
1191
1192	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1193		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1194		$name = "\"$name\"";
1195	}
1196
1197	if ("$name" eq "") {
1198		$formatted_email = "$address";
1199	} else {
1200		$formatted_email = "$name <$address>";
1201	}
1202
1203	return $formatted_email;
1204}
1205
1206sub reformat_email {
1207	my ($email) = @_;
1208
1209	my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1210	return format_email($email_name, $email_address);
1211}
1212
1213sub same_email_addresses {
1214	my ($email1, $email2) = @_;
1215
1216	my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1217	my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1218
1219	return $email1_name eq $email2_name &&
1220	       $email1_address eq $email2_address;
1221}
1222
1223sub which {
1224	my ($bin) = @_;
1225
1226	foreach my $path (split(/:/, $ENV{PATH})) {
1227		if (-e "$path/$bin") {
1228			return "$path/$bin";
1229		}
1230	}
1231
1232	return "";
1233}
1234
1235sub which_conf {
1236	my ($conf) = @_;
1237
1238	foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1239		if (-e "$path/$conf") {
1240			return "$path/$conf";
1241		}
1242	}
1243
1244	return "";
1245}
1246
1247sub expand_tabs {
1248	my ($str) = @_;
1249
1250	my $res = '';
1251	my $n = 0;
1252	for my $c (split(//, $str)) {
1253		if ($c eq "\t") {
1254			$res .= ' ';
1255			$n++;
1256			for (; ($n % $tabsize) != 0; $n++) {
1257				$res .= ' ';
1258			}
1259			next;
1260		}
1261		$res .= $c;
1262		$n++;
1263	}
1264
1265	return $res;
1266}
1267sub copy_spacing {
1268	(my $res = shift) =~ tr/\t/ /c;
1269	return $res;
1270}
1271
1272sub line_stats {
1273	my ($line) = @_;
1274
1275	# Drop the diff line leader and expand tabs
1276	$line =~ s/^.//;
1277	$line = expand_tabs($line);
1278
1279	# Pick the indent from the front of the line.
1280	my ($white) = ($line =~ /^(\s*)/);
1281
1282	return (length($line), length($white));
1283}
1284
1285my $sanitise_quote = '';
1286
1287sub sanitise_line_reset {
1288	my ($in_comment) = @_;
1289
1290	if ($in_comment) {
1291		$sanitise_quote = '*/';
1292	} else {
1293		$sanitise_quote = '';
1294	}
1295}
1296sub sanitise_line {
1297	my ($line) = @_;
1298
1299	my $res = '';
1300	my $l = '';
1301
1302	my $qlen = 0;
1303	my $off = 0;
1304	my $c;
1305
1306	# Always copy over the diff marker.
1307	$res = substr($line, 0, 1);
1308
1309	for ($off = 1; $off < length($line); $off++) {
1310		$c = substr($line, $off, 1);
1311
1312		# Comments we are whacking completely including the begin
1313		# and end, all to $;.
1314		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1315			$sanitise_quote = '*/';
1316
1317			substr($res, $off, 2, "$;$;");
1318			$off++;
1319			next;
1320		}
1321		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1322			$sanitise_quote = '';
1323			substr($res, $off, 2, "$;$;");
1324			$off++;
1325			next;
1326		}
1327		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1328			$sanitise_quote = '//';
1329
1330			substr($res, $off, 2, $sanitise_quote);
1331			$off++;
1332			next;
1333		}
1334
1335		# A \ in a string means ignore the next character.
1336		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1337		    $c eq "\\") {
1338			substr($res, $off, 2, 'XX');
1339			$off++;
1340			next;
1341		}
1342		# Regular quotes.
1343		if ($c eq "'" || $c eq '"') {
1344			if ($sanitise_quote eq '') {
1345				$sanitise_quote = $c;
1346
1347				substr($res, $off, 1, $c);
1348				next;
1349			} elsif ($sanitise_quote eq $c) {
1350				$sanitise_quote = '';
1351			}
1352		}
1353
1354		#print "c<$c> SQ<$sanitise_quote>\n";
1355		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1356			substr($res, $off, 1, $;);
1357		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1358			substr($res, $off, 1, $;);
1359		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1360			substr($res, $off, 1, 'X');
1361		} else {
1362			substr($res, $off, 1, $c);
1363		}
1364	}
1365
1366	if ($sanitise_quote eq '//') {
1367		$sanitise_quote = '';
1368	}
1369
1370	# The pathname on a #include may be surrounded by '<' and '>'.
1371	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1372		my $clean = 'X' x length($1);
1373		$res =~ s@\<.*\>@<$clean>@;
1374
1375	# The whole of a #error is a string.
1376	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1377		my $clean = 'X' x length($1);
1378		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1379	}
1380
1381	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1382		my $match = $1;
1383		$res =~ s/\Q$match\E/"$;" x length($match)/e;
1384	}
1385
1386	return $res;
1387}
1388
1389sub get_quoted_string {
1390	my ($line, $rawline) = @_;
1391
1392	return "" if (!defined($line) || !defined($rawline));
1393	return "" if ($line !~ m/($String)/g);
1394	return substr($rawline, $-[0], $+[0] - $-[0]);
1395}
1396
1397sub ctx_statement_block {
1398	my ($linenr, $remain, $off) = @_;
1399	my $line = $linenr - 1;
1400	my $blk = '';
1401	my $soff = $off;
1402	my $coff = $off - 1;
1403	my $coff_set = 0;
1404
1405	my $loff = 0;
1406
1407	my $type = '';
1408	my $level = 0;
1409	my @stack = ();
1410	my $p;
1411	my $c;
1412	my $len = 0;
1413
1414	my $remainder;
1415	while (1) {
1416		@stack = (['', 0]) if ($#stack == -1);
1417
1418		#warn "CSB: blk<$blk> remain<$remain>\n";
1419		# If we are about to drop off the end, pull in more
1420		# context.
1421		if ($off >= $len) {
1422			for (; $remain > 0; $line++) {
1423				last if (!defined $lines[$line]);
1424				next if ($lines[$line] =~ /^-/);
1425				$remain--;
1426				$loff = $len;
1427				$blk .= $lines[$line] . "\n";
1428				$len = length($blk);
1429				$line++;
1430				last;
1431			}
1432			# Bail if there is no further context.
1433			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1434			if ($off >= $len) {
1435				last;
1436			}
1437			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1438				$level++;
1439				$type = '#';
1440			}
1441		}
1442		$p = $c;
1443		$c = substr($blk, $off, 1);
1444		$remainder = substr($blk, $off);
1445
1446		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1447
1448		# Handle nested #if/#else.
1449		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1450			push(@stack, [ $type, $level ]);
1451		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1452			($type, $level) = @{$stack[$#stack - 1]};
1453		} elsif ($remainder =~ /^#\s*endif\b/) {
1454			($type, $level) = @{pop(@stack)};
1455		}
1456
1457		# Statement ends at the ';' or a close '}' at the
1458		# outermost level.
1459		if ($level == 0 && $c eq ';') {
1460			last;
1461		}
1462
1463		# An else is really a conditional as long as its not else if
1464		if ($level == 0 && $coff_set == 0 &&
1465				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1466				$remainder =~ /^(else)(?:\s|{)/ &&
1467				$remainder !~ /^else\s+if\b/) {
1468			$coff = $off + length($1) - 1;
1469			$coff_set = 1;
1470			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1471			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1472		}
1473
1474		if (($type eq '' || $type eq '(') && $c eq '(') {
1475			$level++;
1476			$type = '(';
1477		}
1478		if ($type eq '(' && $c eq ')') {
1479			$level--;
1480			$type = ($level != 0)? '(' : '';
1481
1482			if ($level == 0 && $coff < $soff) {
1483				$coff = $off;
1484				$coff_set = 1;
1485				#warn "CSB: mark coff<$coff>\n";
1486			}
1487		}
1488		if (($type eq '' || $type eq '{') && $c eq '{') {
1489			$level++;
1490			$type = '{';
1491		}
1492		if ($type eq '{' && $c eq '}') {
1493			$level--;
1494			$type = ($level != 0)? '{' : '';
1495
1496			if ($level == 0) {
1497				if (substr($blk, $off + 1, 1) eq ';') {
1498					$off++;
1499				}
1500				last;
1501			}
1502		}
1503		# Preprocessor commands end at the newline unless escaped.
1504		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1505			$level--;
1506			$type = '';
1507			$off++;
1508			last;
1509		}
1510		$off++;
1511	}
1512	# We are truly at the end, so shuffle to the next line.
1513	if ($off == $len) {
1514		$loff = $len + 1;
1515		$line++;
1516		$remain--;
1517	}
1518
1519	my $statement = substr($blk, $soff, $off - $soff + 1);
1520	my $condition = substr($blk, $soff, $coff - $soff + 1);
1521
1522	#warn "STATEMENT<$statement>\n";
1523	#warn "CONDITION<$condition>\n";
1524
1525	#print "coff<$coff> soff<$off> loff<$loff>\n";
1526
1527	return ($statement, $condition,
1528			$line, $remain + 1, $off - $loff + 1, $level);
1529}
1530
1531sub statement_lines {
1532	my ($stmt) = @_;
1533
1534	# Strip the diff line prefixes and rip blank lines at start and end.
1535	$stmt =~ s/(^|\n)./$1/g;
1536	$stmt =~ s/^\s*//;
1537	$stmt =~ s/\s*$//;
1538
1539	my @stmt_lines = ($stmt =~ /\n/g);
1540
1541	return $#stmt_lines + 2;
1542}
1543
1544sub statement_rawlines {
1545	my ($stmt) = @_;
1546
1547	my @stmt_lines = ($stmt =~ /\n/g);
1548
1549	return $#stmt_lines + 2;
1550}
1551
1552sub statement_block_size {
1553	my ($stmt) = @_;
1554
1555	$stmt =~ s/(^|\n)./$1/g;
1556	$stmt =~ s/^\s*{//;
1557	$stmt =~ s/}\s*$//;
1558	$stmt =~ s/^\s*//;
1559	$stmt =~ s/\s*$//;
1560
1561	my @stmt_lines = ($stmt =~ /\n/g);
1562	my @stmt_statements = ($stmt =~ /;/g);
1563
1564	my $stmt_lines = $#stmt_lines + 2;
1565	my $stmt_statements = $#stmt_statements + 1;
1566
1567	if ($stmt_lines > $stmt_statements) {
1568		return $stmt_lines;
1569	} else {
1570		return $stmt_statements;
1571	}
1572}
1573
1574sub ctx_statement_full {
1575	my ($linenr, $remain, $off) = @_;
1576	my ($statement, $condition, $level);
1577
1578	my (@chunks);
1579
1580	# Grab the first conditional/block pair.
1581	($statement, $condition, $linenr, $remain, $off, $level) =
1582				ctx_statement_block($linenr, $remain, $off);
1583	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1584	push(@chunks, [ $condition, $statement ]);
1585	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1586		return ($level, $linenr, @chunks);
1587	}
1588
1589	# Pull in the following conditional/block pairs and see if they
1590	# could continue the statement.
1591	for (;;) {
1592		($statement, $condition, $linenr, $remain, $off, $level) =
1593				ctx_statement_block($linenr, $remain, $off);
1594		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1595		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1596		#print "C: push\n";
1597		push(@chunks, [ $condition, $statement ]);
1598	}
1599
1600	return ($level, $linenr, @chunks);
1601}
1602
1603sub ctx_block_get {
1604	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1605	my $line;
1606	my $start = $linenr - 1;
1607	my $blk = '';
1608	my @o;
1609	my @c;
1610	my @res = ();
1611
1612	my $level = 0;
1613	my @stack = ($level);
1614	for ($line = $start; $remain > 0; $line++) {
1615		next if ($rawlines[$line] =~ /^-/);
1616		$remain--;
1617
1618		$blk .= $rawlines[$line];
1619
1620		# Handle nested #if/#else.
1621		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1622			push(@stack, $level);
1623		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1624			$level = $stack[$#stack - 1];
1625		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1626			$level = pop(@stack);
1627		}
1628
1629		foreach my $c (split(//, $lines[$line])) {
1630			##print "C<$c>L<$level><$open$close>O<$off>\n";
1631			if ($off > 0) {
1632				$off--;
1633				next;
1634			}
1635
1636			if ($c eq $close && $level > 0) {
1637				$level--;
1638				last if ($level == 0);
1639			} elsif ($c eq $open) {
1640				$level++;
1641			}
1642		}
1643
1644		if (!$outer || $level <= 1) {
1645			push(@res, $rawlines[$line]);
1646		}
1647
1648		last if ($level == 0);
1649	}
1650
1651	return ($level, @res);
1652}
1653sub ctx_block_outer {
1654	my ($linenr, $remain) = @_;
1655
1656	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1657	return @r;
1658}
1659sub ctx_block {
1660	my ($linenr, $remain) = @_;
1661
1662	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1663	return @r;
1664}
1665sub ctx_statement {
1666	my ($linenr, $remain, $off) = @_;
1667
1668	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1669	return @r;
1670}
1671sub ctx_block_level {
1672	my ($linenr, $remain) = @_;
1673
1674	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1675}
1676sub ctx_statement_level {
1677	my ($linenr, $remain, $off) = @_;
1678
1679	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1680}
1681
1682sub ctx_locate_comment {
1683	my ($first_line, $end_line) = @_;
1684
1685	# If c99 comment on the current line, or the line before or after
1686	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1687	return $current_comment if (defined $current_comment);
1688	($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1689	return $current_comment if (defined $current_comment);
1690	($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1691	return $current_comment if (defined $current_comment);
1692
1693	# Catch a comment on the end of the line itself.
1694	($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1695	return $current_comment if (defined $current_comment);
1696
1697	# Look through the context and try and figure out if there is a
1698	# comment.
1699	my $in_comment = 0;
1700	$current_comment = '';
1701	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1702		my $line = $rawlines[$linenr - 1];
1703		#warn "           $line\n";
1704		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1705			$in_comment = 1;
1706		}
1707		if ($line =~ m@/\*@) {
1708			$in_comment = 1;
1709		}
1710		if (!$in_comment && $current_comment ne '') {
1711			$current_comment = '';
1712		}
1713		$current_comment .= $line . "\n" if ($in_comment);
1714		if ($line =~ m@\*/@) {
1715			$in_comment = 0;
1716		}
1717	}
1718
1719	chomp($current_comment);
1720	return($current_comment);
1721}
1722sub ctx_has_comment {
1723	my ($first_line, $end_line) = @_;
1724	my $cmt = ctx_locate_comment($first_line, $end_line);
1725
1726	##print "LINE: $rawlines[$end_line - 1 ]\n";
1727	##print "CMMT: $cmt\n";
1728
1729	return ($cmt ne '');
1730}
1731
1732sub raw_line {
1733	my ($linenr, $cnt) = @_;
1734
1735	my $offset = $linenr - 1;
1736	$cnt++;
1737
1738	my $line;
1739	while ($cnt) {
1740		$line = $rawlines[$offset++];
1741		next if (defined($line) && $line =~ /^-/);
1742		$cnt--;
1743	}
1744
1745	return $line;
1746}
1747
1748sub get_stat_real {
1749	my ($linenr, $lc) = @_;
1750
1751	my $stat_real = raw_line($linenr, 0);
1752	for (my $count = $linenr + 1; $count <= $lc; $count++) {
1753		$stat_real = $stat_real . "\n" . raw_line($count, 0);
1754	}
1755
1756	return $stat_real;
1757}
1758
1759sub get_stat_here {
1760	my ($linenr, $cnt, $here) = @_;
1761
1762	my $herectx = $here . "\n";
1763	for (my $n = 0; $n < $cnt; $n++) {
1764		$herectx .= raw_line($linenr, $n) . "\n";
1765	}
1766
1767	return $herectx;
1768}
1769
1770sub cat_vet {
1771	my ($vet) = @_;
1772	my ($res, $coded);
1773
1774	$res = '';
1775	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1776		$res .= $1;
1777		if ($2 ne '') {
1778			$coded = sprintf("^%c", unpack('C', $2) + 64);
1779			$res .= $coded;
1780		}
1781	}
1782	$res =~ s/$/\$/;
1783
1784	return $res;
1785}
1786
1787my $av_preprocessor = 0;
1788my $av_pending;
1789my @av_paren_type;
1790my $av_pend_colon;
1791
1792sub annotate_reset {
1793	$av_preprocessor = 0;
1794	$av_pending = '_';
1795	@av_paren_type = ('E');
1796	$av_pend_colon = 'O';
1797}
1798
1799sub annotate_values {
1800	my ($stream, $type) = @_;
1801
1802	my $res;
1803	my $var = '_' x length($stream);
1804	my $cur = $stream;
1805
1806	print "$stream\n" if ($dbg_values > 1);
1807
1808	while (length($cur)) {
1809		@av_paren_type = ('E') if ($#av_paren_type < 0);
1810		print " <" . join('', @av_paren_type) .
1811				"> <$type> <$av_pending>" if ($dbg_values > 1);
1812		if ($cur =~ /^(\s+)/o) {
1813			print "WS($1)\n" if ($dbg_values > 1);
1814			if ($1 =~ /\n/ && $av_preprocessor) {
1815				$type = pop(@av_paren_type);
1816				$av_preprocessor = 0;
1817			}
1818
1819		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1820			print "CAST($1)\n" if ($dbg_values > 1);
1821			push(@av_paren_type, $type);
1822			$type = 'c';
1823
1824		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1825			print "DECLARE($1)\n" if ($dbg_values > 1);
1826			$type = 'T';
1827
1828		} elsif ($cur =~ /^($Modifier)\s*/) {
1829			print "MODIFIER($1)\n" if ($dbg_values > 1);
1830			$type = 'T';
1831
1832		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1833			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1834			$av_preprocessor = 1;
1835			push(@av_paren_type, $type);
1836			if ($2 ne '') {
1837				$av_pending = 'N';
1838			}
1839			$type = 'E';
1840
1841		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1842			print "UNDEF($1)\n" if ($dbg_values > 1);
1843			$av_preprocessor = 1;
1844			push(@av_paren_type, $type);
1845
1846		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1847			print "PRE_START($1)\n" if ($dbg_values > 1);
1848			$av_preprocessor = 1;
1849
1850			push(@av_paren_type, $type);
1851			push(@av_paren_type, $type);
1852			$type = 'E';
1853
1854		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1855			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1856			$av_preprocessor = 1;
1857
1858			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1859
1860			$type = 'E';
1861
1862		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1863			print "PRE_END($1)\n" if ($dbg_values > 1);
1864
1865			$av_preprocessor = 1;
1866
1867			# Assume all arms of the conditional end as this
1868			# one does, and continue as if the #endif was not here.
1869			pop(@av_paren_type);
1870			push(@av_paren_type, $type);
1871			$type = 'E';
1872
1873		} elsif ($cur =~ /^(\\\n)/o) {
1874			print "PRECONT($1)\n" if ($dbg_values > 1);
1875
1876		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1877			print "ATTR($1)\n" if ($dbg_values > 1);
1878			$av_pending = $type;
1879			$type = 'N';
1880
1881		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1882			print "SIZEOF($1)\n" if ($dbg_values > 1);
1883			if (defined $2) {
1884				$av_pending = 'V';
1885			}
1886			$type = 'N';
1887
1888		} elsif ($cur =~ /^(if|while|for)\b/o) {
1889			print "COND($1)\n" if ($dbg_values > 1);
1890			$av_pending = 'E';
1891			$type = 'N';
1892
1893		} elsif ($cur =~/^(case)/o) {
1894			print "CASE($1)\n" if ($dbg_values > 1);
1895			$av_pend_colon = 'C';
1896			$type = 'N';
1897
1898		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1899			print "KEYWORD($1)\n" if ($dbg_values > 1);
1900			$type = 'N';
1901
1902		} elsif ($cur =~ /^(\()/o) {
1903			print "PAREN('$1')\n" if ($dbg_values > 1);
1904			push(@av_paren_type, $av_pending);
1905			$av_pending = '_';
1906			$type = 'N';
1907
1908		} elsif ($cur =~ /^(\))/o) {
1909			my $new_type = pop(@av_paren_type);
1910			if ($new_type ne '_') {
1911				$type = $new_type;
1912				print "PAREN('$1') -> $type\n"
1913							if ($dbg_values > 1);
1914			} else {
1915				print "PAREN('$1')\n" if ($dbg_values > 1);
1916			}
1917
1918		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1919			print "FUNC($1)\n" if ($dbg_values > 1);
1920			$type = 'V';
1921			$av_pending = 'V';
1922
1923		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1924			if (defined $2 && $type eq 'C' || $type eq 'T') {
1925				$av_pend_colon = 'B';
1926			} elsif ($type eq 'E') {
1927				$av_pend_colon = 'L';
1928			}
1929			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1930			$type = 'V';
1931
1932		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1933			print "IDENT($1)\n" if ($dbg_values > 1);
1934			$type = 'V';
1935
1936		} elsif ($cur =~ /^($Assignment)/o) {
1937			print "ASSIGN($1)\n" if ($dbg_values > 1);
1938			$type = 'N';
1939
1940		} elsif ($cur =~/^(;|{|})/) {
1941			print "END($1)\n" if ($dbg_values > 1);
1942			$type = 'E';
1943			$av_pend_colon = 'O';
1944
1945		} elsif ($cur =~/^(,)/) {
1946			print "COMMA($1)\n" if ($dbg_values > 1);
1947			$type = 'C';
1948
1949		} elsif ($cur =~ /^(\?)/o) {
1950			print "QUESTION($1)\n" if ($dbg_values > 1);
1951			$type = 'N';
1952
1953		} elsif ($cur =~ /^(:)/o) {
1954			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1955
1956			substr($var, length($res), 1, $av_pend_colon);
1957			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1958				$type = 'E';
1959			} else {
1960				$type = 'N';
1961			}
1962			$av_pend_colon = 'O';
1963
1964		} elsif ($cur =~ /^(\[)/o) {
1965			print "CLOSE($1)\n" if ($dbg_values > 1);
1966			$type = 'N';
1967
1968		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1969			my $variant;
1970
1971			print "OPV($1)\n" if ($dbg_values > 1);
1972			if ($type eq 'V') {
1973				$variant = 'B';
1974			} else {
1975				$variant = 'U';
1976			}
1977
1978			substr($var, length($res), 1, $variant);
1979			$type = 'N';
1980
1981		} elsif ($cur =~ /^($Operators)/o) {
1982			print "OP($1)\n" if ($dbg_values > 1);
1983			if ($1 ne '++' && $1 ne '--') {
1984				$type = 'N';
1985			}
1986
1987		} elsif ($cur =~ /(^.)/o) {
1988			print "C($1)\n" if ($dbg_values > 1);
1989		}
1990		if (defined $1) {
1991			$cur = substr($cur, length($1));
1992			$res .= $type x length($1);
1993		}
1994	}
1995
1996	return ($res, $var);
1997}
1998
1999sub possible {
2000	my ($possible, $line) = @_;
2001	my $notPermitted = qr{(?:
2002		^(?:
2003			$Modifier|
2004			$Storage|
2005			$Type|
2006			DEFINE_\S+
2007		)$|
2008		^(?:
2009			goto|
2010			return|
2011			case|
2012			else|
2013			asm|__asm__|
2014			do|
2015			\#|
2016			\#\#|
2017		)(?:\s|$)|
2018		^(?:typedef|struct|enum)\b
2019	    )}x;
2020	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2021	if ($possible !~ $notPermitted) {
2022		# Check for modifiers.
2023		$possible =~ s/\s*$Storage\s*//g;
2024		$possible =~ s/\s*$Sparse\s*//g;
2025		if ($possible =~ /^\s*$/) {
2026
2027		} elsif ($possible =~ /\s/) {
2028			$possible =~ s/\s*$Type\s*//g;
2029			for my $modifier (split(' ', $possible)) {
2030				if ($modifier !~ $notPermitted) {
2031					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2032					push(@modifierListFile, $modifier);
2033				}
2034			}
2035
2036		} else {
2037			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2038			push(@typeListFile, $possible);
2039		}
2040		build_types();
2041	} else {
2042		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2043	}
2044}
2045
2046my $prefix = '';
2047
2048sub show_type {
2049	my ($type) = @_;
2050
2051	$type =~ tr/[a-z]/[A-Z]/;
2052
2053	return defined $use_type{$type} if (scalar keys %use_type > 0);
2054
2055	return !defined $ignore_type{$type};
2056}
2057
2058sub report {
2059	my ($level, $type, $msg) = @_;
2060
2061	if (!show_type($type) ||
2062	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2063		return 0;
2064	}
2065	my $output = '';
2066	if ($color) {
2067		if ($level eq 'ERROR') {
2068			$output .= RED;
2069		} elsif ($level eq 'WARNING') {
2070			$output .= YELLOW;
2071		} else {
2072			$output .= GREEN;
2073		}
2074	}
2075	$output .= $prefix . $level . ':';
2076	if ($show_types) {
2077		$output .= BLUE if ($color);
2078		$output .= "$type:";
2079	}
2080	$output .= RESET if ($color);
2081	$output .= ' ' . $msg . "\n";
2082
2083	if ($showfile) {
2084		my @lines = split("\n", $output, -1);
2085		splice(@lines, 1, 1);
2086		$output = join("\n", @lines);
2087	}
2088	$output = (split('\n', $output))[0] . "\n" if ($terse);
2089
2090	push(our @report, $output);
2091
2092	return 1;
2093}
2094
2095sub report_dump {
2096	our @report;
2097}
2098
2099sub fixup_current_range {
2100	my ($lineRef, $offset, $length) = @_;
2101
2102	if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2103		my $o = $1;
2104		my $l = $2;
2105		my $no = $o + $offset;
2106		my $nl = $l + $length;
2107		$$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2108	}
2109}
2110
2111sub fix_inserted_deleted_lines {
2112	my ($linesRef, $insertedRef, $deletedRef) = @_;
2113
2114	my $range_last_linenr = 0;
2115	my $delta_offset = 0;
2116
2117	my $old_linenr = 0;
2118	my $new_linenr = 0;
2119
2120	my $next_insert = 0;
2121	my $next_delete = 0;
2122
2123	my @lines = ();
2124
2125	my $inserted = @{$insertedRef}[$next_insert++];
2126	my $deleted = @{$deletedRef}[$next_delete++];
2127
2128	foreach my $old_line (@{$linesRef}) {
2129		my $save_line = 1;
2130		my $line = $old_line;	#don't modify the array
2131		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
2132			$delta_offset = 0;
2133		} elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {	#new hunk
2134			$range_last_linenr = $new_linenr;
2135			fixup_current_range(\$line, $delta_offset, 0);
2136		}
2137
2138		while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2139			$deleted = @{$deletedRef}[$next_delete++];
2140			$save_line = 0;
2141			fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2142		}
2143
2144		while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2145			push(@lines, ${$inserted}{'LINE'});
2146			$inserted = @{$insertedRef}[$next_insert++];
2147			$new_linenr++;
2148			fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2149		}
2150
2151		if ($save_line) {
2152			push(@lines, $line);
2153			$new_linenr++;
2154		}
2155
2156		$old_linenr++;
2157	}
2158
2159	return @lines;
2160}
2161
2162sub fix_insert_line {
2163	my ($linenr, $line) = @_;
2164
2165	my $inserted = {
2166		LINENR => $linenr,
2167		LINE => $line,
2168	};
2169	push(@fixed_inserted, $inserted);
2170}
2171
2172sub fix_delete_line {
2173	my ($linenr, $line) = @_;
2174
2175	my $deleted = {
2176		LINENR => $linenr,
2177		LINE => $line,
2178	};
2179
2180	push(@fixed_deleted, $deleted);
2181}
2182
2183sub ERROR {
2184	my ($type, $msg) = @_;
2185
2186	if (report("ERROR", $type, $msg)) {
2187		our $clean = 0;
2188		our $cnt_error++;
2189		return 1;
2190	}
2191	return 0;
2192}
2193sub WARN {
2194	my ($type, $msg) = @_;
2195
2196	if (report("WARNING", $type, $msg)) {
2197		our $clean = 0;
2198		our $cnt_warn++;
2199		return 1;
2200	}
2201	return 0;
2202}
2203sub CHK {
2204	my ($type, $msg) = @_;
2205
2206	if ($check && report("CHECK", $type, $msg)) {
2207		our $clean = 0;
2208		our $cnt_chk++;
2209		return 1;
2210	}
2211	return 0;
2212}
2213
2214sub check_absolute_file {
2215	my ($absolute, $herecurr) = @_;
2216	my $file = $absolute;
2217
2218	##print "absolute<$absolute>\n";
2219
2220	# See if any suffix of this path is a path within the tree.
2221	while ($file =~ s@^[^/]*/@@) {
2222		if (-f "$root/$file") {
2223			##print "file<$file>\n";
2224			last;
2225		}
2226	}
2227	if (! -f _)  {
2228		return 0;
2229	}
2230
2231	# It is, so see if the prefix is acceptable.
2232	my $prefix = $absolute;
2233	substr($prefix, -length($file)) = '';
2234
2235	##print "prefix<$prefix>\n";
2236	if ($prefix ne ".../") {
2237		WARN("USE_RELATIVE_PATH",
2238		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2239	}
2240}
2241
2242sub trim {
2243	my ($string) = @_;
2244
2245	$string =~ s/^\s+|\s+$//g;
2246
2247	return $string;
2248}
2249
2250sub ltrim {
2251	my ($string) = @_;
2252
2253	$string =~ s/^\s+//;
2254
2255	return $string;
2256}
2257
2258sub rtrim {
2259	my ($string) = @_;
2260
2261	$string =~ s/\s+$//;
2262
2263	return $string;
2264}
2265
2266sub string_find_replace {
2267	my ($string, $find, $replace) = @_;
2268
2269	$string =~ s/$find/$replace/g;
2270
2271	return $string;
2272}
2273
2274sub tabify {
2275	my ($leading) = @_;
2276
2277	my $source_indent = $tabsize;
2278	my $max_spaces_before_tab = $source_indent - 1;
2279	my $spaces_to_tab = " " x $source_indent;
2280
2281	#convert leading spaces to tabs
2282	1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2283	#Remove spaces before a tab
2284	1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2285
2286	return "$leading";
2287}
2288
2289sub pos_last_openparen {
2290	my ($line) = @_;
2291
2292	my $pos = 0;
2293
2294	my $opens = $line =~ tr/\(/\(/;
2295	my $closes = $line =~ tr/\)/\)/;
2296
2297	my $last_openparen = 0;
2298
2299	if (($opens == 0) || ($closes >= $opens)) {
2300		return -1;
2301	}
2302
2303	my $len = length($line);
2304
2305	for ($pos = 0; $pos < $len; $pos++) {
2306		my $string = substr($line, $pos);
2307		if ($string =~ /^($FuncArg|$balanced_parens)/) {
2308			$pos += length($1) - 1;
2309		} elsif (substr($line, $pos, 1) eq '(') {
2310			$last_openparen = $pos;
2311		} elsif (index($string, '(') == -1) {
2312			last;
2313		}
2314	}
2315
2316	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2317}
2318
2319sub get_raw_comment {
2320	my ($line, $rawline) = @_;
2321	my $comment = '';
2322
2323	for my $i (0 .. (length($line) - 1)) {
2324		if (substr($line, $i, 1) eq "$;") {
2325			$comment .= substr($rawline, $i, 1);
2326		}
2327	}
2328
2329	return $comment;
2330}
2331
2332sub process {
2333	my $filename = shift;
2334
2335	my $linenr=0;
2336	my $prevline="";
2337	my $prevrawline="";
2338	my $stashline="";
2339	my $stashrawline="";
2340
2341	my $length;
2342	my $indent;
2343	my $previndent=0;
2344	my $stashindent=0;
2345
2346	our $clean = 1;
2347	my $signoff = 0;
2348	my $author = '';
2349	my $authorsignoff = 0;
2350	my $is_patch = 0;
2351	my $is_binding_patch = -1;
2352	my $in_header_lines = $file ? 0 : 1;
2353	my $in_commit_log = 0;		#Scanning lines before patch
2354	my $has_patch_separator = 0;	#Found a --- line
2355	my $has_commit_log = 0;		#Encountered lines before patch
2356	my $commit_log_lines = 0;	#Number of commit log lines
2357	my $commit_log_possible_stack_dump = 0;
2358	my $commit_log_long_line = 0;
2359	my $commit_log_has_diff = 0;
2360	my $reported_maintainer_file = 0;
2361	my $non_utf8_charset = 0;
2362
2363	my $last_blank_line = 0;
2364	my $last_coalesced_string_linenr = -1;
2365
2366	our @report = ();
2367	our $cnt_lines = 0;
2368	our $cnt_error = 0;
2369	our $cnt_warn = 0;
2370	our $cnt_chk = 0;
2371
2372	# Trace the real file/line as we go.
2373	my $realfile = '';
2374	my $realline = 0;
2375	my $realcnt = 0;
2376	my $here = '';
2377	my $context_function;		#undef'd unless there's a known function
2378	my $in_comment = 0;
2379	my $comment_edge = 0;
2380	my $first_line = 0;
2381	my $p1_prefix = '';
2382
2383	my $prev_values = 'E';
2384
2385	# suppression flags
2386	my %suppress_ifbraces;
2387	my %suppress_whiletrailers;
2388	my %suppress_export;
2389	my $suppress_statement = 0;
2390
2391	my %signatures = ();
2392
2393	# Pre-scan the patch sanitizing the lines.
2394	# Pre-scan the patch looking for any __setup documentation.
2395	#
2396	my @setup_docs = ();
2397	my $setup_docs = 0;
2398
2399	my $camelcase_file_seeded = 0;
2400
2401	my $checklicenseline = 1;
2402
2403	sanitise_line_reset();
2404	my $line;
2405	foreach my $rawline (@rawlines) {
2406		$linenr++;
2407		$line = $rawline;
2408
2409		push(@fixed, $rawline) if ($fix);
2410
2411		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2412			$setup_docs = 0;
2413			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
2414				$setup_docs = 1;
2415			}
2416			#next;
2417		}
2418		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2419			$realline=$1-1;
2420			if (defined $2) {
2421				$realcnt=$3+1;
2422			} else {
2423				$realcnt=1+1;
2424			}
2425			$in_comment = 0;
2426
2427			# Guestimate if this is a continuing comment.  Run
2428			# the context looking for a comment "edge".  If this
2429			# edge is a close comment then we must be in a comment
2430			# at context start.
2431			my $edge;
2432			my $cnt = $realcnt;
2433			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2434				next if (defined $rawlines[$ln - 1] &&
2435					 $rawlines[$ln - 1] =~ /^-/);
2436				$cnt--;
2437				#print "RAW<$rawlines[$ln - 1]>\n";
2438				last if (!defined $rawlines[$ln - 1]);
2439				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2440				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2441					($edge) = $1;
2442					last;
2443				}
2444			}
2445			if (defined $edge && $edge eq '*/') {
2446				$in_comment = 1;
2447			}
2448
2449			# Guestimate if this is a continuing comment.  If this
2450			# is the start of a diff block and this line starts
2451			# ' *' then it is very likely a comment.
2452			if (!defined $edge &&
2453			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2454			{
2455				$in_comment = 1;
2456			}
2457
2458			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2459			sanitise_line_reset($in_comment);
2460
2461		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2462			# Standardise the strings and chars within the input to
2463			# simplify matching -- only bother with positive lines.
2464			$line = sanitise_line($rawline);
2465		}
2466		push(@lines, $line);
2467
2468		if ($realcnt > 1) {
2469			$realcnt-- if ($line =~ /^(?:\+| |$)/);
2470		} else {
2471			$realcnt = 0;
2472		}
2473
2474		#print "==>$rawline\n";
2475		#print "-->$line\n";
2476
2477		if ($setup_docs && $line =~ /^\+/) {
2478			push(@setup_docs, $line);
2479		}
2480	}
2481
2482	$prefix = '';
2483
2484	$realcnt = 0;
2485	$linenr = 0;
2486	$fixlinenr = -1;
2487	foreach my $line (@lines) {
2488		$linenr++;
2489		$fixlinenr++;
2490		my $sline = $line;	#copy of $line
2491		$sline =~ s/$;/ /g;	#with comments as spaces
2492
2493		my $rawline = $rawlines[$linenr - 1];
2494		my $raw_comment = get_raw_comment($line, $rawline);
2495
2496# check if it's a mode change, rename or start of a patch
2497		if (!$in_commit_log &&
2498		    ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2499		    ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2500		     $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2501			$is_patch = 1;
2502		}
2503
2504#extract the line range in the file after the patch is applied
2505		if (!$in_commit_log &&
2506		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2507			my $context = $4;
2508			$is_patch = 1;
2509			$first_line = $linenr + 1;
2510			$realline=$1-1;
2511			if (defined $2) {
2512				$realcnt=$3+1;
2513			} else {
2514				$realcnt=1+1;
2515			}
2516			annotate_reset();
2517			$prev_values = 'E';
2518
2519			%suppress_ifbraces = ();
2520			%suppress_whiletrailers = ();
2521			%suppress_export = ();
2522			$suppress_statement = 0;
2523			if ($context =~ /\b(\w+)\s*\(/) {
2524				$context_function = $1;
2525			} else {
2526				undef $context_function;
2527			}
2528			next;
2529
2530# track the line number as we move through the hunk, note that
2531# new versions of GNU diff omit the leading space on completely
2532# blank context lines so we need to count that too.
2533		} elsif ($line =~ /^( |\+|$)/) {
2534			$realline++;
2535			$realcnt-- if ($realcnt != 0);
2536
2537			# Measure the line length and indent.
2538			($length, $indent) = line_stats($rawline);
2539
2540			# Track the previous line.
2541			($prevline, $stashline) = ($stashline, $line);
2542			($previndent, $stashindent) = ($stashindent, $indent);
2543			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2544
2545			#warn "line<$line>\n";
2546
2547		} elsif ($realcnt == 1) {
2548			$realcnt--;
2549		}
2550
2551		my $hunk_line = ($realcnt != 0);
2552
2553		$here = "#$linenr: " if (!$file);
2554		$here = "#$realline: " if ($file);
2555
2556		my $found_file = 0;
2557		# extract the filename as it passes
2558		if ($line =~ /^diff --git.*?(\S+)$/) {
2559			$realfile = $1;
2560			$realfile =~ s@^([^/]*)/@@ if (!$file);
2561			$in_commit_log = 0;
2562			$found_file = 1;
2563		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2564			$realfile = $1;
2565			$realfile =~ s@^([^/]*)/@@ if (!$file);
2566			$in_commit_log = 0;
2567
2568			$p1_prefix = $1;
2569			if (!$file && $tree && $p1_prefix ne '' &&
2570			    -e "$root/$p1_prefix") {
2571				WARN("PATCH_PREFIX",
2572				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2573			}
2574
2575			if ($realfile =~ m@^include/asm/@) {
2576				ERROR("MODIFIED_INCLUDE_ASM",
2577				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2578			}
2579			$found_file = 1;
2580		}
2581
2582#make up the handle for any error we report on this line
2583		if ($showfile) {
2584			$prefix = "$realfile:$realline: "
2585		} elsif ($emacs) {
2586			if ($file) {
2587				$prefix = "$filename:$realline: ";
2588			} else {
2589				$prefix = "$filename:$linenr: ";
2590			}
2591		}
2592
2593		if ($found_file) {
2594			if (is_maintained_obsolete($realfile)) {
2595				WARN("OBSOLETE",
2596				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
2597			}
2598			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2599				$check = 1;
2600			} else {
2601				$check = $check_orig;
2602			}
2603			$checklicenseline = 1;
2604
2605			if ($realfile !~ /^MAINTAINERS/) {
2606				my $last_binding_patch = $is_binding_patch;
2607
2608				$is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2609
2610				if (($last_binding_patch != -1) &&
2611				    ($last_binding_patch ^ $is_binding_patch)) {
2612					WARN("DT_SPLIT_BINDING_PATCH",
2613					     "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2614				}
2615			}
2616
2617			next;
2618		}
2619
2620		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2621
2622		my $hereline = "$here\n$rawline\n";
2623		my $herecurr = "$here\n$rawline\n";
2624		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2625
2626		$cnt_lines++ if ($realcnt != 0);
2627
2628# Verify the existence of a commit log if appropriate
2629# 2 is used because a $signature is counted in $commit_log_lines
2630		if ($in_commit_log) {
2631			if ($line !~ /^\s*$/) {
2632				$commit_log_lines++;	#could be a $signature
2633			}
2634		} elsif ($has_commit_log && $commit_log_lines < 2) {
2635			WARN("COMMIT_MESSAGE",
2636			     "Missing commit description - Add an appropriate one\n");
2637			$commit_log_lines = 2;	#warn only once
2638		}
2639
2640# Check if the commit log has what seems like a diff which can confuse patch
2641		if ($in_commit_log && !$commit_log_has_diff &&
2642		    (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2643		      $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2644		     $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2645		     $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2646			ERROR("DIFF_IN_COMMIT_MSG",
2647			      "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2648			$commit_log_has_diff = 1;
2649		}
2650
2651# Check for incorrect file permissions
2652		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2653			my $permhere = $here . "FILE: $realfile\n";
2654			if ($realfile !~ m@scripts/@ &&
2655			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2656				ERROR("EXECUTE_PERMISSIONS",
2657				      "do not set execute permissions for source files\n" . $permhere);
2658			}
2659		}
2660
2661# Check the patch for a From:
2662		if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2663			$author = $1;
2664			$author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2665			$author =~ s/"//g;
2666			$author = reformat_email($author);
2667		}
2668
2669# Check the patch for a signoff:
2670		if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
2671			$signoff++;
2672			$in_commit_log = 0;
2673			if ($author ne '') {
2674				if (same_email_addresses($1, $author)) {
2675					$authorsignoff = 1;
2676				}
2677			}
2678		}
2679
2680# Check for patch separator
2681		if ($line =~ /^---$/) {
2682			$has_patch_separator = 1;
2683			$in_commit_log = 0;
2684		}
2685
2686# Check if MAINTAINERS is being updated.  If so, there's probably no need to
2687# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2688		if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2689			$reported_maintainer_file = 1;
2690		}
2691
2692# Check signature styles
2693		if (!$in_header_lines &&
2694		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2695			my $space_before = $1;
2696			my $sign_off = $2;
2697			my $space_after = $3;
2698			my $email = $4;
2699			my $ucfirst_sign_off = ucfirst(lc($sign_off));
2700
2701			if ($sign_off !~ /$signature_tags/) {
2702				WARN("BAD_SIGN_OFF",
2703				     "Non-standard signature: $sign_off\n" . $herecurr);
2704			}
2705			if (defined $space_before && $space_before ne "") {
2706				if (WARN("BAD_SIGN_OFF",
2707					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2708				    $fix) {
2709					$fixed[$fixlinenr] =
2710					    "$ucfirst_sign_off $email";
2711				}
2712			}
2713			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2714				if (WARN("BAD_SIGN_OFF",
2715					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2716				    $fix) {
2717					$fixed[$fixlinenr] =
2718					    "$ucfirst_sign_off $email";
2719				}
2720
2721			}
2722			if (!defined $space_after || $space_after ne " ") {
2723				if (WARN("BAD_SIGN_OFF",
2724					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2725				    $fix) {
2726					$fixed[$fixlinenr] =
2727					    "$ucfirst_sign_off $email";
2728				}
2729			}
2730
2731			my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
2732			my $suggested_email = format_email(($email_name, $email_address));
2733			if ($suggested_email eq "") {
2734				ERROR("BAD_SIGN_OFF",
2735				      "Unrecognized email address: '$email'\n" . $herecurr);
2736			} else {
2737				my $dequoted = $suggested_email;
2738				$dequoted =~ s/^"//;
2739				$dequoted =~ s/" </ </;
2740				# Don't force email to have quotes
2741				# Allow just an angle bracketed address
2742				if (!same_email_addresses($email, $suggested_email)) {
2743					WARN("BAD_SIGN_OFF",
2744					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2745				}
2746			}
2747
2748# Check for duplicate signatures
2749			my $sig_nospace = $line;
2750			$sig_nospace =~ s/\s//g;
2751			$sig_nospace = lc($sig_nospace);
2752			if (defined $signatures{$sig_nospace}) {
2753				WARN("BAD_SIGN_OFF",
2754				     "Duplicate signature\n" . $herecurr);
2755			} else {
2756				$signatures{$sig_nospace} = 1;
2757			}
2758
2759# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2760			if ($sign_off =~ /^co-developed-by:$/i) {
2761				if ($email eq $author) {
2762					WARN("BAD_SIGN_OFF",
2763					      "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2764				}
2765				if (!defined $lines[$linenr]) {
2766					WARN("BAD_SIGN_OFF",
2767                                             "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2768				} elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2769					WARN("BAD_SIGN_OFF",
2770					     "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2771				} elsif ($1 ne $email) {
2772					WARN("BAD_SIGN_OFF",
2773					     "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2774				}
2775			}
2776		}
2777
2778# Check email subject for common tools that don't need to be mentioned
2779		if ($in_header_lines &&
2780		    $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2781			WARN("EMAIL_SUBJECT",
2782			     "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2783		}
2784
2785# Check for Gerrit Change-Ids not in any patch context
2786		if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
2787			ERROR("GERRIT_CHANGE_ID",
2788			      "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
2789		}
2790
2791# Check if the commit log is in a possible stack dump
2792		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2793		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2794		     $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2795					# timestamp
2796		     $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2797		     $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2798		     $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2799					# stack dump address styles
2800			$commit_log_possible_stack_dump = 1;
2801		}
2802
2803# Check for line lengths > 75 in commit log, warn once
2804		if ($in_commit_log && !$commit_log_long_line &&
2805		    length($line) > 75 &&
2806		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2807					# file delta changes
2808		      $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2809					# filename then :
2810		      $line =~ /^\s*(?:Fixes:|Link:)/i ||
2811					# A Fixes: or Link: line
2812		      $commit_log_possible_stack_dump)) {
2813			WARN("COMMIT_LOG_LONG_LINE",
2814			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2815			$commit_log_long_line = 1;
2816		}
2817
2818# Reset possible stack dump if a blank line is found
2819		if ($in_commit_log && $commit_log_possible_stack_dump &&
2820		    $line =~ /^\s*$/) {
2821			$commit_log_possible_stack_dump = 0;
2822		}
2823
2824# Check for git id commit length and improperly formed commit descriptions
2825		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2826		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
2827		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2828		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2829		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2830		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2831		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2832			my $init_char = "c";
2833			my $orig_commit = "";
2834			my $short = 1;
2835			my $long = 0;
2836			my $case = 1;
2837			my $space = 1;
2838			my $hasdesc = 0;
2839			my $hasparens = 0;
2840			my $id = '0123456789ab';
2841			my $orig_desc = "commit description";
2842			my $description = "";
2843
2844			if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2845				$init_char = $1;
2846				$orig_commit = lc($2);
2847			} elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2848				$orig_commit = lc($1);
2849			}
2850
2851			$short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2852			$long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2853			$space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2854			$case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2855			if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2856				$orig_desc = $1;
2857				$hasparens = 1;
2858			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2859				 defined $rawlines[$linenr] &&
2860				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2861				$orig_desc = $1;
2862				$hasparens = 1;
2863			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2864				 defined $rawlines[$linenr] &&
2865				 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2866				$line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2867				$orig_desc = $1;
2868				$rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2869				$orig_desc .= " " . $1;
2870				$hasparens = 1;
2871			}
2872
2873			($id, $description) = git_commit_info($orig_commit,
2874							      $id, $orig_desc);
2875
2876			if (defined($id) &&
2877			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2878				ERROR("GIT_COMMIT_ID",
2879				      "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2880			}
2881		}
2882
2883# Check for added, moved or deleted files
2884		if (!$reported_maintainer_file && !$in_commit_log &&
2885		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2886		     $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2887		     ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2888		      (defined($1) || defined($2))))) {
2889			$is_patch = 1;
2890			$reported_maintainer_file = 1;
2891			WARN("FILE_PATH_CHANGES",
2892			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2893		}
2894
2895# Check for adding new DT bindings not in schema format
2896		if (!$in_commit_log &&
2897		    ($line =~ /^new file mode\s*\d+\s*$/) &&
2898		    ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2899			WARN("DT_SCHEMA_BINDING_PATCH",
2900			     "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2901		}
2902
2903# Check for wrappage within a valid hunk of the file
2904		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2905			ERROR("CORRUPTED_PATCH",
2906			      "patch seems to be corrupt (line wrapped?)\n" .
2907				$herecurr) if (!$emitted_corrupt++);
2908		}
2909
2910# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2911		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2912		    $rawline !~ m/^$UTF8*$/) {
2913			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2914
2915			my $blank = copy_spacing($rawline);
2916			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2917			my $hereptr = "$hereline$ptr\n";
2918
2919			CHK("INVALID_UTF8",
2920			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2921		}
2922
2923# Check if it's the start of a commit log
2924# (not a header line and we haven't seen the patch filename)
2925		if ($in_header_lines && $realfile =~ /^$/ &&
2926		    !($rawline =~ /^\s+(?:\S|$)/ ||
2927		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2928			$in_header_lines = 0;
2929			$in_commit_log = 1;
2930			$has_commit_log = 1;
2931		}
2932
2933# Check if there is UTF-8 in a commit log when a mail header has explicitly
2934# declined it, i.e defined some charset where it is missing.
2935		if ($in_header_lines &&
2936		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2937		    $1 !~ /utf-8/i) {
2938			$non_utf8_charset = 1;
2939		}
2940
2941		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2942		    $rawline =~ /$NON_ASCII_UTF8/) {
2943			WARN("UTF8_BEFORE_PATCH",
2944			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2945		}
2946
2947# Check for absolute kernel paths in commit message
2948		if ($tree && $in_commit_log) {
2949			while ($line =~ m{(?:^|\s)(/\S*)}g) {
2950				my $file = $1;
2951
2952				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2953				    check_absolute_file($1, $herecurr)) {
2954					#
2955				} else {
2956					check_absolute_file($file, $herecurr);
2957				}
2958			}
2959		}
2960
2961# Check for various typo / spelling mistakes
2962		if (defined($misspellings) &&
2963		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2964			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2965				my $typo = $1;
2966				my $typo_fix = $spelling_fix{lc($typo)};
2967				$typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2968				$typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2969				my $msg_level = \&WARN;
2970				$msg_level = \&CHK if ($file);
2971				if (&{$msg_level}("TYPO_SPELLING",
2972						  "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2973				    $fix) {
2974					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2975				}
2976			}
2977		}
2978
2979# check for invalid commit id
2980		if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2981			my $id;
2982			my $description;
2983			($id, $description) = git_commit_info($2, undef, undef);
2984			if (!defined($id)) {
2985				WARN("UNKNOWN_COMMIT_ID",
2986				     "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2987			}
2988		}
2989
2990# ignore non-hunk lines and lines being removed
2991		next if (!$hunk_line || $line =~ /^-/);
2992
2993#trailing whitespace
2994		if ($line =~ /^\+.*\015/) {
2995			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2996			if (ERROR("DOS_LINE_ENDINGS",
2997				  "DOS line endings\n" . $herevet) &&
2998			    $fix) {
2999				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
3000			}
3001		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3002			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3003			if (ERROR("TRAILING_WHITESPACE",
3004				  "trailing whitespace\n" . $herevet) &&
3005			    $fix) {
3006				$fixed[$fixlinenr] =~ s/\s+$//;
3007			}
3008
3009			$rpt_cleaners = 1;
3010		}
3011
3012# Check for FSF mailing addresses.
3013		if ($rawline =~ /\bwrite to the Free/i ||
3014		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
3015		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
3016		    $rawline =~ /\b51\s+Franklin\s+St/i) {
3017			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3018			my $msg_level = \&ERROR;
3019			$msg_level = \&CHK if ($file);
3020			&{$msg_level}("FSF_MAILING_ADDRESS",
3021				      "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)
3022		}
3023
3024# check for Kconfig help text having a real description
3025# Only applies when adding the entry originally, after that we do not have
3026# sufficient context to determine whether it is indeed long enough.
3027		if ($realfile =~ /Kconfig/ &&
3028		    # 'choice' is usually the last thing on the line (though
3029		    # Kconfig supports named choices), so use a word boundary
3030		    # (\b) rather than a whitespace character (\s)
3031		    $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3032			my $length = 0;
3033			my $cnt = $realcnt;
3034			my $ln = $linenr + 1;
3035			my $f;
3036			my $is_start = 0;
3037			my $is_end = 0;
3038			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
3039				$f = $lines[$ln - 1];
3040				$cnt-- if ($lines[$ln - 1] !~ /^-/);
3041				$is_end = $lines[$ln - 1] =~ /^\+/;
3042
3043				next if ($f =~ /^-/);
3044				last if (!$file && $f =~ /^\@\@/);
3045
3046				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3047					$is_start = 1;
3048				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
3049					if ($lines[$ln - 1] =~ "---help---") {
3050						WARN("CONFIG_DESCRIPTION",
3051						     "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
3052					}
3053					$length = -1;
3054				}
3055
3056				$f =~ s/^.//;
3057				$f =~ s/#.*//;
3058				$f =~ s/^\s+//;
3059				next if ($f =~ /^$/);
3060
3061				# This only checks context lines in the patch
3062				# and so hopefully shouldn't trigger false
3063				# positives, even though some of these are
3064				# common words in help texts
3065				if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3066						  if|endif|menu|endmenu|source)\b/x) {
3067					$is_end = 1;
3068					last;
3069				}
3070				$length++;
3071			}
3072			if ($is_start && $is_end && $length < $min_conf_desc_length) {
3073				WARN("CONFIG_DESCRIPTION",
3074				     "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3075			}
3076			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3077		}
3078
3079# check MAINTAINERS entries
3080		if ($realfile =~ /^MAINTAINERS$/) {
3081# check MAINTAINERS entries for the right form
3082			if ($rawline =~ /^\+[A-Z]:/ &&
3083			    $rawline !~ /^\+[A-Z]:\t\S/) {
3084				if (WARN("MAINTAINERS_STYLE",
3085					 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3086				    $fix) {
3087					$fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3088				}
3089			}
3090# check MAINTAINERS entries for the right ordering too
3091			my $preferred_order = 'MRLSWQBCPTFXNK';
3092			if ($rawline =~ /^\+[A-Z]:/ &&
3093			    $prevrawline =~ /^[\+ ][A-Z]:/) {
3094				$rawline =~ /^\+([A-Z]):\s*(.*)/;
3095				my $cur = $1;
3096				my $curval = $2;
3097				$prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3098				my $prev = $1;
3099				my $prevval = $2;
3100				my $curindex = index($preferred_order, $cur);
3101				my $previndex = index($preferred_order, $prev);
3102				if ($curindex < 0) {
3103					WARN("MAINTAINERS_STYLE",
3104					     "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3105				} else {
3106					if ($previndex >= 0 && $curindex < $previndex) {
3107						WARN("MAINTAINERS_STYLE",
3108						     "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3109					} elsif ((($prev eq 'F' && $cur eq 'F') ||
3110						  ($prev eq 'X' && $cur eq 'X')) &&
3111						 ($prevval cmp $curval) > 0) {
3112						WARN("MAINTAINERS_STYLE",
3113						     "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3114					}
3115				}
3116			}
3117		}
3118
3119# discourage the use of boolean for type definition attributes of Kconfig options
3120		if ($realfile =~ /Kconfig/ &&
3121		    $line =~ /^\+\s*\bboolean\b/) {
3122			WARN("CONFIG_TYPE_BOOLEAN",
3123			     "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3124		}
3125
3126		if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3127		    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3128			my $flag = $1;
3129			my $replacement = {
3130				'EXTRA_AFLAGS' =>   'asflags-y',
3131				'EXTRA_CFLAGS' =>   'ccflags-y',
3132				'EXTRA_CPPFLAGS' => 'cppflags-y',
3133				'EXTRA_LDFLAGS' =>  'ldflags-y',
3134			};
3135
3136			WARN("DEPRECATED_VARIABLE",
3137			     "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3138		}
3139
3140# check for DT compatible documentation
3141		if (defined $root &&
3142			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3143			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3144
3145			my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3146
3147			my $dt_path = $root . "/Documentation/devicetree/bindings/";
3148			my $vp_file = $dt_path . "vendor-prefixes.yaml";
3149
3150			foreach my $compat (@compats) {
3151				my $compat2 = $compat;
3152				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3153				my $compat3 = $compat;
3154				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3155				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3156				if ( $? >> 8 ) {
3157					WARN("UNDOCUMENTED_DT_STRING",
3158					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3159				}
3160
3161				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3162				my $vendor = $1;
3163				`grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3164				if ( $? >> 8 ) {
3165					WARN("UNDOCUMENTED_DT_STRING",
3166					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3167				}
3168			}
3169		}
3170
3171# check for using SPDX license tag at beginning of files
3172		if ($realline == $checklicenseline) {
3173			if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3174				$checklicenseline = 2;
3175			} elsif ($rawline =~ /^\+/) {
3176				my $comment = "";
3177				if ($realfile =~ /\.(h|s|S)$/) {
3178					$comment = '/*';
3179				} elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3180					$comment = '//';
3181				} elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
3182					$comment = '#';
3183				} elsif ($realfile =~ /\.rst$/) {
3184					$comment = '..';
3185				}
3186
3187# check SPDX comment style for .[chsS] files
3188				if ($realfile =~ /\.[chsS]$/ &&
3189				    $rawline =~ /SPDX-License-Identifier:/ &&
3190				    $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3191					WARN("SPDX_LICENSE_TAG",
3192					     "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3193				}
3194
3195				if ($comment !~ /^$/ &&
3196				    $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3197					WARN("SPDX_LICENSE_TAG",
3198					     "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3199				} elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3200					my $spdx_license = $1;
3201					if (!is_SPDX_License_valid($spdx_license)) {
3202						WARN("SPDX_LICENSE_TAG",
3203						     "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3204					}
3205					if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3206					    not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3207						my $msg_level = \&WARN;
3208						$msg_level = \&CHK if ($file);
3209						if (&{$msg_level}("SPDX_LICENSE_TAG",
3210
3211								  "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3212						    $fix) {
3213							$fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3214						}
3215					}
3216				}
3217			}
3218		}
3219
3220# check we are in a valid source file if not then ignore this hunk
3221		next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3222
3223# check for using SPDX-License-Identifier on the wrong line number
3224		if ($realline != $checklicenseline &&
3225		    $rawline =~ /\bSPDX-License-Identifier:/ &&
3226		    substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3227			WARN("SPDX_LICENSE_TAG",
3228			     "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3229		}
3230
3231# line length limit (with some exclusions)
3232#
3233# There are a few types of lines that may extend beyond $max_line_length:
3234#	logging functions like pr_info that end in a string
3235#	lines with a single string
3236#	#defines that are a single string
3237#	lines with an RFC3986 like URL
3238#
3239# There are 3 different line length message types:
3240# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
3241# LONG_LINE_STRING	a string starts before but extends beyond $max_line_length
3242# LONG_LINE		all other lines longer than $max_line_length
3243#
3244# if LONG_LINE is ignored, the other 2 types are also ignored
3245#
3246
3247		if ($line =~ /^\+/ && $length > $max_line_length) {
3248			my $msg_type = "LONG_LINE";
3249
3250			# Check the allowed long line types first
3251
3252			# logging functions that end in a string that starts
3253			# before $max_line_length
3254			if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3255			    length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3256				$msg_type = "";
3257
3258			# lines with only strings (w/ possible termination)
3259			# #defines with only strings
3260			} elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3261				 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3262				$msg_type = "";
3263
3264			# More special cases
3265			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3266				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3267				$msg_type = "";
3268
3269			# URL ($rawline is used in case the URL is in a comment)
3270			} elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3271				$msg_type = "";
3272
3273			# Otherwise set the alternate message types
3274
3275			# a comment starts before $max_line_length
3276			} elsif ($line =~ /($;[\s$;]*)$/ &&
3277				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3278				$msg_type = "LONG_LINE_COMMENT"
3279
3280			# a quoted string starts before $max_line_length
3281			} elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3282				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3283				$msg_type = "LONG_LINE_STRING"
3284			}
3285
3286			if ($msg_type ne "" &&
3287			    (show_type("LONG_LINE") || show_type($msg_type))) {
3288				my $msg_level = \&WARN;
3289				$msg_level = \&CHK if ($file);
3290				&{$msg_level}($msg_type,
3291					      "line length of $length exceeds $max_line_length columns\n" . $herecurr);
3292			}
3293		}
3294
3295# check for adding lines without a newline.
3296		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3297			WARN("MISSING_EOF_NEWLINE",
3298			     "adding a line without newline at end of file\n" . $herecurr);
3299		}
3300
3301# check we are in a valid source file C or perl if not then ignore this hunk
3302		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3303
3304# at the beginning of a line any tabs must come first and anything
3305# more than $tabsize must use tabs.
3306		if ($rawline =~ /^\+\s* \t\s*\S/ ||
3307		    $rawline =~ /^\+\s*        \s*/) {
3308			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3309			$rpt_cleaners = 1;
3310			if (ERROR("CODE_INDENT",
3311				  "code indent should use tabs where possible\n" . $herevet) &&
3312			    $fix) {
3313				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3314			}
3315		}
3316
3317# check for repeated words separated by a single space
3318		if ($rawline =~ /^\+/) {
3319			while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3320
3321				my $first = $1;
3322				my $second = $2;
3323
3324				if ($first =~ /(?:struct|union|enum)/) {
3325					pos($rawline) += length($first) + length($second) + 1;
3326					next;
3327				}
3328
3329				next if ($first ne $second);
3330				next if ($first eq 'long');
3331
3332				if (WARN("REPEATED_WORD",
3333					 "Possible repeated word: '$first'\n" . $herecurr) &&
3334				    $fix) {
3335					$fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3336				}
3337			}
3338
3339			# if it's a repeated word on consecutive lines in a comment block
3340			if ($prevline =~ /$;+\s*$/ &&
3341			    $prevrawline =~ /($word_pattern)\s*$/) {
3342				my $last_word = $1;
3343				if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3344					if (WARN("REPEATED_WORD",
3345						 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3346					    $fix) {
3347						$fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3348					}
3349				}
3350			}
3351		}
3352
3353# check for space before tabs.
3354		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3355			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3356			if (WARN("SPACE_BEFORE_TAB",
3357				"please, no space before tabs\n" . $herevet) &&
3358			    $fix) {
3359				while ($fixed[$fixlinenr] =~
3360					   s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3361				while ($fixed[$fixlinenr] =~
3362					   s/(^\+.*) +\t/$1\t/) {}
3363			}
3364		}
3365
3366# check for assignments on the start of a line
3367		if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3368			CHK("ASSIGNMENT_CONTINUATIONS",
3369			    "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3370		}
3371
3372# check for && or || at the start of a line
3373		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3374			CHK("LOGICAL_CONTINUATIONS",
3375			    "Logical continuations should be on the previous line\n" . $hereprev);
3376		}
3377
3378# check indentation starts on a tab stop
3379		if ($perl_version_ok &&
3380		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3381			my $indent = length($1);
3382			if ($indent % $tabsize) {
3383				if (WARN("TABSTOP",
3384					 "Statements should start on a tabstop\n" . $herecurr) &&
3385				    $fix) {
3386					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3387				}
3388			}
3389		}
3390
3391# check multi-line statement indentation matches previous line
3392		if ($perl_version_ok &&
3393		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3394			$prevline =~ /^\+(\t*)(.*)$/;
3395			my $oldindent = $1;
3396			my $rest = $2;
3397
3398			my $pos = pos_last_openparen($rest);
3399			if ($pos >= 0) {
3400				$line =~ /^(\+| )([ \t]*)/;
3401				my $newindent = $2;
3402
3403				my $goodtabindent = $oldindent .
3404					"\t" x ($pos / $tabsize) .
3405					" "  x ($pos % $tabsize);
3406				my $goodspaceindent = $oldindent . " "  x $pos;
3407
3408				if ($newindent ne $goodtabindent &&
3409				    $newindent ne $goodspaceindent) {
3410
3411					if (CHK("PARENTHESIS_ALIGNMENT",
3412						"Alignment should match open parenthesis\n" . $hereprev) &&
3413					    $fix && $line =~ /^\+/) {
3414						$fixed[$fixlinenr] =~
3415						    s/^\+[ \t]*/\+$goodtabindent/;
3416					}
3417				}
3418			}
3419		}
3420
3421# check for space after cast like "(int) foo" or "(struct foo) bar"
3422# avoid checking a few false positives:
3423#   "sizeof(<type>)" or "__alignof__(<type>)"
3424#   function pointer declarations like "(*foo)(int) = bar;"
3425#   structure definitions like "(struct foo) { 0 };"
3426#   multiline macros that define functions
3427#   known attributes or the __attribute__ keyword
3428		if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3429		    (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3430			if (CHK("SPACING",
3431				"No space is necessary after a cast\n" . $herecurr) &&
3432			    $fix) {
3433				$fixed[$fixlinenr] =~
3434				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
3435			}
3436		}
3437
3438# Block comment styles
3439# Networking with an initial /*
3440		if ($realfile =~ m@^(drivers/net/|net/)@ &&
3441		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3442		    $rawline =~ /^\+[ \t]*\*/ &&
3443		    $realline > 2) {
3444			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3445			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3446		}
3447
3448# Block comments use * on subsequent lines
3449		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3450		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
3451		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
3452		    $rawline =~ /^\+/ &&			#line is new
3453		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
3454			WARN("BLOCK_COMMENT_STYLE",
3455			     "Block comments use * on subsequent lines\n" . $hereprev);
3456		}
3457
3458# Block comments use */ on trailing lines
3459		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
3460		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
3461		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
3462		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
3463			WARN("BLOCK_COMMENT_STYLE",
3464			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
3465		}
3466
3467# Block comment * alignment
3468		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3469		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
3470		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
3471		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
3472		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
3473		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
3474			my $oldindent;
3475			$prevrawline =~ m@^\+([ \t]*/?)\*@;
3476			if (defined($1)) {
3477				$oldindent = expand_tabs($1);
3478			} else {
3479				$prevrawline =~ m@^\+(.*/?)\*@;
3480				$oldindent = expand_tabs($1);
3481			}
3482			$rawline =~ m@^\+([ \t]*)\*@;
3483			my $newindent = $1;
3484			$newindent = expand_tabs($newindent);
3485			if (length($oldindent) ne length($newindent)) {
3486				WARN("BLOCK_COMMENT_STYLE",
3487				     "Block comments should align the * on each line\n" . $hereprev);
3488			}
3489		}
3490
3491# check for missing blank lines after struct/union declarations
3492# with exceptions for various attributes and macros
3493		if ($prevline =~ /^[\+ ]};?\s*$/ &&
3494		    $line =~ /^\+/ &&
3495		    !($line =~ /^\+\s*$/ ||
3496		      $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3497		      $line =~ /^\+\s*MODULE_/i ||
3498		      $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3499		      $line =~ /^\+[a-z_]*init/ ||
3500		      $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3501		      $line =~ /^\+\s*DECLARE/ ||
3502		      $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3503		      $line =~ /^\+\s*__setup/)) {
3504			if (CHK("LINE_SPACING",
3505				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3506			    $fix) {
3507				fix_insert_line($fixlinenr, "\+");
3508			}
3509		}
3510
3511# check for multiple consecutive blank lines
3512		if ($prevline =~ /^[\+ ]\s*$/ &&
3513		    $line =~ /^\+\s*$/ &&
3514		    $last_blank_line != ($linenr - 1)) {
3515			if (CHK("LINE_SPACING",
3516				"Please don't use multiple blank lines\n" . $hereprev) &&
3517			    $fix) {
3518				fix_delete_line($fixlinenr, $rawline);
3519			}
3520
3521			$last_blank_line = $linenr;
3522		}
3523
3524# check for missing blank lines after declarations
3525		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
3526			# actual declarations
3527		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3528			# function pointer declarations
3529		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3530			# foo bar; where foo is some local typedef or #define
3531		     $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3532			# known declaration macros
3533		     $prevline =~ /^\+\s+$declaration_macros/) &&
3534			# for "else if" which can look like "$Ident $Ident"
3535		    !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3536			# other possible extensions of declaration lines
3537		      $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3538			# not starting a section or a macro "\" extended line
3539		      $prevline =~ /(?:\{\s*|\\)$/) &&
3540			# looks like a declaration
3541		    !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3542			# function pointer declarations
3543		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3544			# foo bar; where foo is some local typedef or #define
3545		      $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3546			# known declaration macros
3547		      $sline =~ /^\+\s+$declaration_macros/ ||
3548			# start of struct or union or enum
3549		      $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3550			# start or end of block or continuation of declaration
3551		      $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3552			# bitfield continuation
3553		      $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3554			# other possible extensions of declaration lines
3555		      $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3556			# indentation of previous and current line are the same
3557		    (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3558			if (WARN("LINE_SPACING",
3559				 "Missing a blank line after declarations\n" . $hereprev) &&
3560			    $fix) {
3561				fix_insert_line($fixlinenr, "\+");
3562			}
3563		}
3564
3565# check for spaces at the beginning of a line.
3566# Exceptions:
3567#  1) within comments
3568#  2) indented preprocessor commands
3569#  3) hanging labels
3570		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
3571			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3572			if (WARN("LEADING_SPACE",
3573				 "please, no spaces at the start of a line\n" . $herevet) &&
3574			    $fix) {
3575				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3576			}
3577		}
3578
3579# check we are in a valid C source file if not then ignore this hunk
3580		next if ($realfile !~ /\.(h|c)$/);
3581
3582# check for unusual line ending [ or (
3583		if ($line =~ /^\+.*([\[\(])\s*$/) {
3584			CHK("OPEN_ENDED_LINE",
3585			    "Lines should not end with a '$1'\n" . $herecurr);
3586		}
3587
3588# check if this appears to be the start function declaration, save the name
3589		if ($sline =~ /^\+\{\s*$/ &&
3590		    $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3591			$context_function = $1;
3592		}
3593
3594# check if this appears to be the end of function declaration
3595		if ($sline =~ /^\+\}\s*$/) {
3596			undef $context_function;
3597		}
3598
3599# check indentation of any line with a bare else
3600# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3601# if the previous line is a break or return and is indented 1 tab more...
3602		if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3603			my $tabs = length($1) + 1;
3604			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3605			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3606			     defined $lines[$linenr] &&
3607			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3608				WARN("UNNECESSARY_ELSE",
3609				     "else is not generally useful after a break or return\n" . $hereprev);
3610			}
3611		}
3612
3613# check indentation of a line with a break;
3614# if the previous line is a goto or return and is indented the same # of tabs
3615		if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3616			my $tabs = $1;
3617			if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3618				WARN("UNNECESSARY_BREAK",
3619				     "break is not useful after a goto or return\n" . $hereprev);
3620			}
3621		}
3622
3623# check for RCS/CVS revision markers
3624		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3625			WARN("CVS_KEYWORD",
3626			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3627		}
3628
3629# check for old HOTPLUG __dev<foo> section markings
3630		if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3631			WARN("HOTPLUG_SECTION",
3632			     "Using $1 is unnecessary\n" . $herecurr);
3633		}
3634
3635# Check for potential 'bare' types
3636		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3637		    $realline_next);
3638#print "LINE<$line>\n";
3639		if ($linenr > $suppress_statement &&
3640		    $realcnt && $sline =~ /.\s*\S/) {
3641			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3642				ctx_statement_block($linenr, $realcnt, 0);
3643			$stat =~ s/\n./\n /g;
3644			$cond =~ s/\n./\n /g;
3645
3646#print "linenr<$linenr> <$stat>\n";
3647			# If this statement has no statement boundaries within
3648			# it there is no point in retrying a statement scan
3649			# until we hit end of it.
3650			my $frag = $stat; $frag =~ s/;+\s*$//;
3651			if ($frag !~ /(?:{|;)/) {
3652#print "skip<$line_nr_next>\n";
3653				$suppress_statement = $line_nr_next;
3654			}
3655
3656			# Find the real next line.
3657			$realline_next = $line_nr_next;
3658			if (defined $realline_next &&
3659			    (!defined $lines[$realline_next - 1] ||
3660			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3661				$realline_next++;
3662			}
3663
3664			my $s = $stat;
3665			$s =~ s/{.*$//s;
3666
3667			# Ignore goto labels.
3668			if ($s =~ /$Ident:\*$/s) {
3669
3670			# Ignore functions being called
3671			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3672
3673			} elsif ($s =~ /^.\s*else\b/s) {
3674
3675			# declarations always start with types
3676			} 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) {
3677				my $type = $1;
3678				$type =~ s/\s+/ /g;
3679				possible($type, "A:" . $s);
3680
3681			# definitions in global scope can only start with types
3682			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3683				possible($1, "B:" . $s);
3684			}
3685
3686			# any (foo ... *) is a pointer cast, and foo is a type
3687			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3688				possible($1, "C:" . $s);
3689			}
3690
3691			# Check for any sort of function declaration.
3692			# int foo(something bar, other baz);
3693			# void (*store_gdt)(x86_descr_ptr *);
3694			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3695				my ($name_len) = length($1);
3696
3697				my $ctx = $s;
3698				substr($ctx, 0, $name_len + 1, '');
3699				$ctx =~ s/\)[^\)]*$//;
3700
3701				for my $arg (split(/\s*,\s*/, $ctx)) {
3702					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3703
3704						possible($1, "D:" . $s);
3705					}
3706				}
3707			}
3708
3709		}
3710
3711#
3712# Checks which may be anchored in the context.
3713#
3714
3715# Check for switch () and associated case and default
3716# statements should be at the same indent.
3717		if ($line=~/\bswitch\s*\(.*\)/) {
3718			my $err = '';
3719			my $sep = '';
3720			my @ctx = ctx_block_outer($linenr, $realcnt);
3721			shift(@ctx);
3722			for my $ctx (@ctx) {
3723				my ($clen, $cindent) = line_stats($ctx);
3724				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3725							$indent != $cindent) {
3726					$err .= "$sep$ctx\n";
3727					$sep = '';
3728				} else {
3729					$sep = "[...]\n";
3730				}
3731			}
3732			if ($err ne '') {
3733				ERROR("SWITCH_CASE_INDENT_LEVEL",
3734				      "switch and case should be at the same indent\n$hereline$err");
3735			}
3736		}
3737
3738# if/while/etc brace do not go on next line, unless defining a do while loop,
3739# or if that brace on the next line is for something else
3740		if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3741			my $pre_ctx = "$1$2";
3742
3743			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3744
3745			if ($line =~ /^\+\t{6,}/) {
3746				WARN("DEEP_INDENTATION",
3747				     "Too many leading tabs - consider code refactoring\n" . $herecurr);
3748			}
3749
3750			my $ctx_cnt = $realcnt - $#ctx - 1;
3751			my $ctx = join("\n", @ctx);
3752
3753			my $ctx_ln = $linenr;
3754			my $ctx_skip = $realcnt;
3755
3756			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3757					defined $lines[$ctx_ln - 1] &&
3758					$lines[$ctx_ln - 1] =~ /^-/)) {
3759				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3760				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3761				$ctx_ln++;
3762			}
3763
3764			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3765			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3766
3767			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3768				ERROR("OPEN_BRACE",
3769				      "that open brace { should be on the previous line\n" .
3770					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3771			}
3772			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3773			    $ctx =~ /\)\s*\;\s*$/ &&
3774			    defined $lines[$ctx_ln - 1])
3775			{
3776				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3777				if ($nindent > $indent) {
3778					WARN("TRAILING_SEMICOLON",
3779					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
3780						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3781				}
3782			}
3783		}
3784
3785# Check relative indent for conditionals and blocks.
3786		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3787			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3788				ctx_statement_block($linenr, $realcnt, 0)
3789					if (!defined $stat);
3790			my ($s, $c) = ($stat, $cond);
3791
3792			substr($s, 0, length($c), '');
3793
3794			# remove inline comments
3795			$s =~ s/$;/ /g;
3796			$c =~ s/$;/ /g;
3797
3798			# Find out how long the conditional actually is.
3799			my @newlines = ($c =~ /\n/gs);
3800			my $cond_lines = 1 + $#newlines;
3801
3802			# Make sure we remove the line prefixes as we have
3803			# none on the first line, and are going to readd them
3804			# where necessary.
3805			$s =~ s/\n./\n/gs;
3806			while ($s =~ /\n\s+\\\n/) {
3807				$cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3808			}
3809
3810			# We want to check the first line inside the block
3811			# starting at the end of the conditional, so remove:
3812			#  1) any blank line termination
3813			#  2) any opening brace { on end of the line
3814			#  3) any do (...) {
3815			my $continuation = 0;
3816			my $check = 0;
3817			$s =~ s/^.*\bdo\b//;
3818			$s =~ s/^\s*{//;
3819			if ($s =~ s/^\s*\\//) {
3820				$continuation = 1;
3821			}
3822			if ($s =~ s/^\s*?\n//) {
3823				$check = 1;
3824				$cond_lines++;
3825			}
3826
3827			# Also ignore a loop construct at the end of a
3828			# preprocessor statement.
3829			if (($prevline =~ /^.\s*#\s*define\s/ ||
3830			    $prevline =~ /\\\s*$/) && $continuation == 0) {
3831				$check = 0;
3832			}
3833
3834			my $cond_ptr = -1;
3835			$continuation = 0;
3836			while ($cond_ptr != $cond_lines) {
3837				$cond_ptr = $cond_lines;
3838
3839				# If we see an #else/#elif then the code
3840				# is not linear.
3841				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3842					$check = 0;
3843				}
3844
3845				# Ignore:
3846				#  1) blank lines, they should be at 0,
3847				#  2) preprocessor lines, and
3848				#  3) labels.
3849				if ($continuation ||
3850				    $s =~ /^\s*?\n/ ||
3851				    $s =~ /^\s*#\s*?/ ||
3852				    $s =~ /^\s*$Ident\s*:/) {
3853					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3854					if ($s =~ s/^.*?\n//) {
3855						$cond_lines++;
3856					}
3857				}
3858			}
3859
3860			my (undef, $sindent) = line_stats("+" . $s);
3861			my $stat_real = raw_line($linenr, $cond_lines);
3862
3863			# Check if either of these lines are modified, else
3864			# this is not this patch's fault.
3865			if (!defined($stat_real) ||
3866			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3867				$check = 0;
3868			}
3869			if (defined($stat_real) && $cond_lines > 1) {
3870				$stat_real = "[...]\n$stat_real";
3871			}
3872
3873			#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";
3874
3875			if ($check && $s ne '' &&
3876			    (($sindent % $tabsize) != 0 ||
3877			     ($sindent < $indent) ||
3878			     ($sindent == $indent &&
3879			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3880			     ($sindent > $indent + $tabsize))) {
3881				WARN("SUSPECT_CODE_INDENT",
3882				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3883			}
3884		}
3885
3886		# Track the 'values' across context and added lines.
3887		my $opline = $line; $opline =~ s/^./ /;
3888		my ($curr_values, $curr_vars) =
3889				annotate_values($opline . "\n", $prev_values);
3890		$curr_values = $prev_values . $curr_values;
3891		if ($dbg_values) {
3892			my $outline = $opline; $outline =~ s/\t/ /g;
3893			print "$linenr > .$outline\n";
3894			print "$linenr > $curr_values\n";
3895			print "$linenr >  $curr_vars\n";
3896		}
3897		$prev_values = substr($curr_values, -1);
3898
3899#ignore lines not being added
3900		next if ($line =~ /^[^\+]/);
3901
3902# check for dereferences that span multiple lines
3903		if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3904		    $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3905			$prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3906			my $ref = $1;
3907			$line =~ /^.\s*($Lval)/;
3908			$ref .= $1;
3909			$ref =~ s/\s//g;
3910			WARN("MULTILINE_DEREFERENCE",
3911			     "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3912		}
3913
3914# check for declarations of signed or unsigned without int
3915		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3916			my $type = $1;
3917			my $var = $2;
3918			$var = "" if (!defined $var);
3919			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3920				my $sign = $1;
3921				my $pointer = $2;
3922
3923				$pointer = "" if (!defined $pointer);
3924
3925				if (WARN("UNSPECIFIED_INT",
3926					 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3927				    $fix) {
3928					my $decl = trim($sign) . " int ";
3929					my $comp_pointer = $pointer;
3930					$comp_pointer =~ s/\s//g;
3931					$decl .= $comp_pointer;
3932					$decl = rtrim($decl) if ($var eq "");
3933					$fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3934				}
3935			}
3936		}
3937
3938# TEST: allow direct testing of the type matcher.
3939		if ($dbg_type) {
3940			if ($line =~ /^.\s*$Declare\s*$/) {
3941				ERROR("TEST_TYPE",
3942				      "TEST: is type\n" . $herecurr);
3943			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3944				ERROR("TEST_NOT_TYPE",
3945				      "TEST: is not type ($1 is)\n". $herecurr);
3946			}
3947			next;
3948		}
3949# TEST: allow direct testing of the attribute matcher.
3950		if ($dbg_attr) {
3951			if ($line =~ /^.\s*$Modifier\s*$/) {
3952				ERROR("TEST_ATTR",
3953				      "TEST: is attr\n" . $herecurr);
3954			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3955				ERROR("TEST_NOT_ATTR",
3956				      "TEST: is not attr ($1 is)\n". $herecurr);
3957			}
3958			next;
3959		}
3960
3961# check for initialisation to aggregates open brace on the next line
3962		if ($line =~ /^.\s*{/ &&
3963		    $prevline =~ /(?:^|[^=])=\s*$/) {
3964			if (ERROR("OPEN_BRACE",
3965				  "that open brace { should be on the previous line\n" . $hereprev) &&
3966			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3967				fix_delete_line($fixlinenr - 1, $prevrawline);
3968				fix_delete_line($fixlinenr, $rawline);
3969				my $fixedline = $prevrawline;
3970				$fixedline =~ s/\s*=\s*$/ = {/;
3971				fix_insert_line($fixlinenr, $fixedline);
3972				$fixedline = $line;
3973				$fixedline =~ s/^(.\s*)\{\s*/$1/;
3974				fix_insert_line($fixlinenr, $fixedline);
3975			}
3976		}
3977
3978#
3979# Checks which are anchored on the added line.
3980#
3981
3982# check for malformed paths in #include statements (uses RAW line)
3983		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3984			my $path = $1;
3985			if ($path =~ m{//}) {
3986				ERROR("MALFORMED_INCLUDE",
3987				      "malformed #include filename\n" . $herecurr);
3988			}
3989			if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3990				ERROR("UAPI_INCLUDE",
3991				      "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3992			}
3993		}
3994
3995# no C99 // comments
3996		if ($line =~ m{//}) {
3997			if (ERROR("C99_COMMENTS",
3998				  "do not use C99 // comments\n" . $herecurr) &&
3999			    $fix) {
4000				my $line = $fixed[$fixlinenr];
4001				if ($line =~ /\/\/(.*)$/) {
4002					my $comment = trim($1);
4003					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
4004				}
4005			}
4006		}
4007		# Remove C99 comments.
4008		$line =~ s@//.*@@;
4009		$opline =~ s@//.*@@;
4010
4011# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4012# the whole statement.
4013#print "APW <$lines[$realline_next - 1]>\n";
4014		if (defined $realline_next &&
4015		    exists $lines[$realline_next - 1] &&
4016		    !defined $suppress_export{$realline_next} &&
4017		    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4018		     $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4019			# Handle definitions which produce identifiers with
4020			# a prefix:
4021			#   XXX(foo);
4022			#   EXPORT_SYMBOL(something_foo);
4023			my $name = $1;
4024			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
4025			    $name =~ /^${Ident}_$2/) {
4026#print "FOO C name<$name>\n";
4027				$suppress_export{$realline_next} = 1;
4028
4029			} elsif ($stat !~ /(?:
4030				\n.}\s*$|
4031				^.DEFINE_$Ident\(\Q$name\E\)|
4032				^.DECLARE_$Ident\(\Q$name\E\)|
4033				^.LIST_HEAD\(\Q$name\E\)|
4034				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4035				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
4036			    )/x) {
4037#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4038				$suppress_export{$realline_next} = 2;
4039			} else {
4040				$suppress_export{$realline_next} = 1;
4041			}
4042		}
4043		if (!defined $suppress_export{$linenr} &&
4044		    $prevline =~ /^.\s*$/ &&
4045		    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4046		     $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4047#print "FOO B <$lines[$linenr - 1]>\n";
4048			$suppress_export{$linenr} = 2;
4049		}
4050		if (defined $suppress_export{$linenr} &&
4051		    $suppress_export{$linenr} == 2) {
4052			WARN("EXPORT_SYMBOL",
4053			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
4054		}
4055
4056# check for global initialisers.
4057		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
4058			if (ERROR("GLOBAL_INITIALISERS",
4059				  "do not initialise globals to $1\n" . $herecurr) &&
4060			    $fix) {
4061				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4062			}
4063		}
4064# check for static initialisers.
4065		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4066			if (ERROR("INITIALISED_STATIC",
4067				  "do not initialise statics to $1\n" .
4068				      $herecurr) &&
4069			    $fix) {
4070				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4071			}
4072		}
4073
4074# check for misordered declarations of char/short/int/long with signed/unsigned
4075		while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4076			my $tmp = trim($1);
4077			WARN("MISORDERED_TYPE",
4078			     "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4079		}
4080
4081# check for unnecessary <signed> int declarations of short/long/long long
4082		while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4083			my $type = trim($1);
4084			next if ($type !~ /\bint\b/);
4085			next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4086			my $new_type = $type;
4087			$new_type =~ s/\b\s*int\s*\b/ /;
4088			$new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4089			$new_type =~ s/^const\s+//;
4090			$new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4091			$new_type = "const $new_type" if ($type =~ /^const\b/);
4092			$new_type =~ s/\s+/ /g;
4093			$new_type = trim($new_type);
4094			if (WARN("UNNECESSARY_INT",
4095				 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4096			    $fix) {
4097				$fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4098			}
4099		}
4100
4101# check for static const char * arrays.
4102		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4103			WARN("STATIC_CONST_CHAR_ARRAY",
4104			     "static const char * array should probably be static const char * const\n" .
4105				$herecurr);
4106		}
4107
4108# check for initialized const char arrays that should be static const
4109		if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4110			if (WARN("STATIC_CONST_CHAR_ARRAY",
4111				 "const array should probably be static const\n" . $herecurr) &&
4112			    $fix) {
4113				$fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4114			}
4115		}
4116
4117# check for static char foo[] = "bar" declarations.
4118		if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4119			WARN("STATIC_CONST_CHAR_ARRAY",
4120			     "static char array declaration should probably be static const char\n" .
4121				$herecurr);
4122		}
4123
4124# check for const <foo> const where <foo> is not a pointer or array type
4125		if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4126			my $found = $1;
4127			if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4128				WARN("CONST_CONST",
4129				     "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4130			} elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4131				WARN("CONST_CONST",
4132				     "'const $found const' should probably be 'const $found'\n" . $herecurr);
4133			}
4134		}
4135
4136# check for non-global char *foo[] = {"bar", ...} declarations.
4137		if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4138			WARN("STATIC_CONST_CHAR_ARRAY",
4139			     "char * array declaration might be better as static const\n" .
4140				$herecurr);
4141               }
4142
4143# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4144		if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4145			my $array = $1;
4146			if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4147				my $array_div = $1;
4148				if (WARN("ARRAY_SIZE",
4149					 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4150				    $fix) {
4151					$fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4152				}
4153			}
4154		}
4155
4156# check for function declarations without arguments like "int foo()"
4157		if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4158			if (ERROR("FUNCTION_WITHOUT_ARGS",
4159				  "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4160			    $fix) {
4161				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4162			}
4163		}
4164
4165# check for new typedefs, only function parameters and sparse annotations
4166# make sense.
4167		if ($line =~ /\btypedef\s/ &&
4168		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4169		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4170		    $line !~ /\b$typeTypedefs\b/ &&
4171		    $line !~ /\b__bitwise\b/) {
4172			WARN("NEW_TYPEDEFS",
4173			     "do not add new typedefs\n" . $herecurr);
4174		}
4175
4176# * goes on variable not on type
4177		# (char*[ const])
4178		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4179			#print "AA<$1>\n";
4180			my ($ident, $from, $to) = ($1, $2, $2);
4181
4182			# Should start with a space.
4183			$to =~ s/^(\S)/ $1/;
4184			# Should not end with a space.
4185			$to =~ s/\s+$//;
4186			# '*'s should not have spaces between.
4187			while ($to =~ s/\*\s+\*/\*\*/) {
4188			}
4189
4190##			print "1: from<$from> to<$to> ident<$ident>\n";
4191			if ($from ne $to) {
4192				if (ERROR("POINTER_LOCATION",
4193					  "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
4194				    $fix) {
4195					my $sub_from = $ident;
4196					my $sub_to = $ident;
4197					$sub_to =~ s/\Q$from\E/$to/;
4198					$fixed[$fixlinenr] =~
4199					    s@\Q$sub_from\E@$sub_to@;
4200				}
4201			}
4202		}
4203		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4204			#print "BB<$1>\n";
4205			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4206
4207			# Should start with a space.
4208			$to =~ s/^(\S)/ $1/;
4209			# Should not end with a space.
4210			$to =~ s/\s+$//;
4211			# '*'s should not have spaces between.
4212			while ($to =~ s/\*\s+\*/\*\*/) {
4213			}
4214			# Modifiers should have spaces.
4215			$to =~ s/(\b$Modifier$)/$1 /;
4216
4217##			print "2: from<$from> to<$to> ident<$ident>\n";
4218			if ($from ne $to && $ident !~ /^$Modifier$/) {
4219				if (ERROR("POINTER_LOCATION",
4220					  "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
4221				    $fix) {
4222
4223					my $sub_from = $match;
4224					my $sub_to = $match;
4225					$sub_to =~ s/\Q$from\E/$to/;
4226					$fixed[$fixlinenr] =~
4227					    s@\Q$sub_from\E@$sub_to@;
4228				}
4229			}
4230		}
4231
4232# avoid BUG() or BUG_ON()
4233		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4234			my $msg_level = \&WARN;
4235			$msg_level = \&CHK if ($file);
4236			&{$msg_level}("AVOID_BUG",
4237				      "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4238		}
4239
4240# avoid LINUX_VERSION_CODE
4241		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4242			WARN("LINUX_VERSION_CODE",
4243			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4244		}
4245
4246# check for uses of printk_ratelimit
4247		if ($line =~ /\bprintk_ratelimit\s*\(/) {
4248			WARN("PRINTK_RATELIMITED",
4249			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4250		}
4251
4252# printk should use KERN_* levels
4253		if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4254			WARN("PRINTK_WITHOUT_KERN_LEVEL",
4255			     "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4256		}
4257
4258		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4259			my $orig = $1;
4260			my $level = lc($orig);
4261			$level = "warn" if ($level eq "warning");
4262			my $level2 = $level;
4263			$level2 = "dbg" if ($level eq "debug");
4264			WARN("PREFER_PR_LEVEL",
4265			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
4266		}
4267
4268		if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4269			my $orig = $1;
4270			my $level = lc($orig);
4271			$level = "warn" if ($level eq "warning");
4272			$level = "dbg" if ($level eq "debug");
4273			WARN("PREFER_DEV_LEVEL",
4274			     "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4275		}
4276
4277# ENOSYS means "bad syscall nr" and nothing else.  This will have a small
4278# number of false positives, but assembly files are not checked, so at
4279# least the arch entry code will not trigger this warning.
4280		if ($line =~ /\bENOSYS\b/) {
4281			WARN("ENOSYS",
4282			     "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4283		}
4284
4285# ENOTSUPP is not a standard error code and should be avoided in new patches.
4286# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4287# Similarly to ENOSYS warning a small number of false positives is expected.
4288		if (!$file && $line =~ /\bENOTSUPP\b/) {
4289			if (WARN("ENOTSUPP",
4290				 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4291			    $fix) {
4292				$fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4293			}
4294		}
4295
4296# function brace can't be on same line, except for #defines of do while,
4297# or if closed on same line
4298		if ($perl_version_ok &&
4299		    $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4300		    $sline !~ /\#\s*define\b.*do\s*\{/ &&
4301		    $sline !~ /}/) {
4302			if (ERROR("OPEN_BRACE",
4303				  "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4304			    $fix) {
4305				fix_delete_line($fixlinenr, $rawline);
4306				my $fixed_line = $rawline;
4307				$fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4308				my $line1 = $1;
4309				my $line2 = $2;
4310				fix_insert_line($fixlinenr, ltrim($line1));
4311				fix_insert_line($fixlinenr, "\+{");
4312				if ($line2 !~ /^\s*$/) {
4313					fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4314				}
4315			}
4316		}
4317
4318# open braces for enum, union and struct go on the same line.
4319		if ($line =~ /^.\s*{/ &&
4320		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4321			if (ERROR("OPEN_BRACE",
4322				  "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4323			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4324				fix_delete_line($fixlinenr - 1, $prevrawline);
4325				fix_delete_line($fixlinenr, $rawline);
4326				my $fixedline = rtrim($prevrawline) . " {";
4327				fix_insert_line($fixlinenr, $fixedline);
4328				$fixedline = $rawline;
4329				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4330				if ($fixedline !~ /^\+\s*$/) {
4331					fix_insert_line($fixlinenr, $fixedline);
4332				}
4333			}
4334		}
4335
4336# missing space after union, struct or enum definition
4337		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4338			if (WARN("SPACING",
4339				 "missing space after $1 definition\n" . $herecurr) &&
4340			    $fix) {
4341				$fixed[$fixlinenr] =~
4342				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4343			}
4344		}
4345
4346# Function pointer declarations
4347# check spacing between type, funcptr, and args
4348# canonical declaration is "type (*funcptr)(args...)"
4349		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4350			my $declare = $1;
4351			my $pre_pointer_space = $2;
4352			my $post_pointer_space = $3;
4353			my $funcname = $4;
4354			my $post_funcname_space = $5;
4355			my $pre_args_space = $6;
4356
4357# the $Declare variable will capture all spaces after the type
4358# so check it for a missing trailing missing space but pointer return types
4359# don't need a space so don't warn for those.
4360			my $post_declare_space = "";
4361			if ($declare =~ /(\s+)$/) {
4362				$post_declare_space = $1;
4363				$declare = rtrim($declare);
4364			}
4365			if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4366				WARN("SPACING",
4367				     "missing space after return type\n" . $herecurr);
4368				$post_declare_space = " ";
4369			}
4370
4371# unnecessary space "type  (*funcptr)(args...)"
4372# This test is not currently implemented because these declarations are
4373# equivalent to
4374#	int  foo(int bar, ...)
4375# and this is form shouldn't/doesn't generate a checkpatch warning.
4376#
4377#			elsif ($declare =~ /\s{2,}$/) {
4378#				WARN("SPACING",
4379#				     "Multiple spaces after return type\n" . $herecurr);
4380#			}
4381
4382# unnecessary space "type ( *funcptr)(args...)"
4383			if (defined $pre_pointer_space &&
4384			    $pre_pointer_space =~ /^\s/) {
4385				WARN("SPACING",
4386				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4387			}
4388
4389# unnecessary space "type (* funcptr)(args...)"
4390			if (defined $post_pointer_space &&
4391			    $post_pointer_space =~ /^\s/) {
4392				WARN("SPACING",
4393				     "Unnecessary space before function pointer name\n" . $herecurr);
4394			}
4395
4396# unnecessary space "type (*funcptr )(args...)"
4397			if (defined $post_funcname_space &&
4398			    $post_funcname_space =~ /^\s/) {
4399				WARN("SPACING",
4400				     "Unnecessary space after function pointer name\n" . $herecurr);
4401			}
4402
4403# unnecessary space "type (*funcptr) (args...)"
4404			if (defined $pre_args_space &&
4405			    $pre_args_space =~ /^\s/) {
4406				WARN("SPACING",
4407				     "Unnecessary space before function pointer arguments\n" . $herecurr);
4408			}
4409
4410			if (show_type("SPACING") && $fix) {
4411				$fixed[$fixlinenr] =~
4412				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4413			}
4414		}
4415
4416# check for spacing round square brackets; allowed:
4417#  1. with a type on the left -- int [] a;
4418#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4419#  3. inside a curly brace -- = { [0...10] = 5 }
4420		while ($line =~ /(.*?\s)\[/g) {
4421			my ($where, $prefix) = ($-[1], $1);
4422			if ($prefix !~ /$Type\s+$/ &&
4423			    ($where != 0 || $prefix !~ /^.\s+$/) &&
4424			    $prefix !~ /[{,:]\s+$/) {
4425				if (ERROR("BRACKET_SPACE",
4426					  "space prohibited before open square bracket '['\n" . $herecurr) &&
4427				    $fix) {
4428				    $fixed[$fixlinenr] =~
4429					s/^(\+.*?)\s+\[/$1\[/;
4430				}
4431			}
4432		}
4433
4434# check for spaces between functions and their parentheses.
4435		while ($line =~ /($Ident)\s+\(/g) {
4436			my $name = $1;
4437			my $ctx_before = substr($line, 0, $-[1]);
4438			my $ctx = "$ctx_before$name";
4439
4440			# Ignore those directives where spaces _are_ permitted.
4441			if ($name =~ /^(?:
4442				if|for|while|switch|return|case|
4443				volatile|__volatile__|
4444				__attribute__|format|__extension__|
4445				asm|__asm__)$/x)
4446			{
4447			# cpp #define statements have non-optional spaces, ie
4448			# if there is a space between the name and the open
4449			# parenthesis it is simply not a parameter group.
4450			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4451
4452			# cpp #elif statement condition may start with a (
4453			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4454
4455			# If this whole things ends with a type its most
4456			# likely a typedef for a function.
4457			} elsif ($ctx =~ /$Type$/) {
4458
4459			} else {
4460				if (WARN("SPACING",
4461					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4462					     $fix) {
4463					$fixed[$fixlinenr] =~
4464					    s/\b$name\s+\(/$name\(/;
4465				}
4466			}
4467		}
4468
4469# Check operator spacing.
4470		if (!($line=~/\#\s*include/)) {
4471			my $fixed_line = "";
4472			my $line_fixed = 0;
4473
4474			my $ops = qr{
4475				<<=|>>=|<=|>=|==|!=|
4476				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4477				=>|->|<<|>>|<|>|=|!|~|
4478				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4479				\?:|\?|:
4480			}x;
4481			my @elements = split(/($ops|;)/, $opline);
4482
4483##			print("element count: <" . $#elements . ">\n");
4484##			foreach my $el (@elements) {
4485##				print("el: <$el>\n");
4486##			}
4487
4488			my @fix_elements = ();
4489			my $off = 0;
4490
4491			foreach my $el (@elements) {
4492				push(@fix_elements, substr($rawline, $off, length($el)));
4493				$off += length($el);
4494			}
4495
4496			$off = 0;
4497
4498			my $blank = copy_spacing($opline);
4499			my $last_after = -1;
4500
4501			for (my $n = 0; $n < $#elements; $n += 2) {
4502
4503				my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4504
4505##				print("n: <$n> good: <$good>\n");
4506
4507				$off += length($elements[$n]);
4508
4509				# Pick up the preceding and succeeding characters.
4510				my $ca = substr($opline, 0, $off);
4511				my $cc = '';
4512				if (length($opline) >= ($off + length($elements[$n + 1]))) {
4513					$cc = substr($opline, $off + length($elements[$n + 1]));
4514				}
4515				my $cb = "$ca$;$cc";
4516
4517				my $a = '';
4518				$a = 'V' if ($elements[$n] ne '');
4519				$a = 'W' if ($elements[$n] =~ /\s$/);
4520				$a = 'C' if ($elements[$n] =~ /$;$/);
4521				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4522				$a = 'O' if ($elements[$n] eq '');
4523				$a = 'E' if ($ca =~ /^\s*$/);
4524
4525				my $op = $elements[$n + 1];
4526
4527				my $c = '';
4528				if (defined $elements[$n + 2]) {
4529					$c = 'V' if ($elements[$n + 2] ne '');
4530					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
4531					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
4532					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4533					$c = 'O' if ($elements[$n + 2] eq '');
4534					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4535				} else {
4536					$c = 'E';
4537				}
4538
4539				my $ctx = "${a}x${c}";
4540
4541				my $at = "(ctx:$ctx)";
4542
4543				my $ptr = substr($blank, 0, $off) . "^";
4544				my $hereptr = "$hereline$ptr\n";
4545
4546				# Pull out the value of this operator.
4547				my $op_type = substr($curr_values, $off + 1, 1);
4548
4549				# Get the full operator variant.
4550				my $opv = $op . substr($curr_vars, $off, 1);
4551
4552				# Ignore operators passed as parameters.
4553				if ($op_type ne 'V' &&
4554				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4555
4556#				# Ignore comments
4557#				} elsif ($op =~ /^$;+$/) {
4558
4559				# ; should have either the end of line or a space or \ after it
4560				} elsif ($op eq ';') {
4561					if ($ctx !~ /.x[WEBC]/ &&
4562					    $cc !~ /^\\/ && $cc !~ /^;/) {
4563						if (ERROR("SPACING",
4564							  "space required after that '$op' $at\n" . $hereptr)) {
4565							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4566							$line_fixed = 1;
4567						}
4568					}
4569
4570				# // is a comment
4571				} elsif ($op eq '//') {
4572
4573				#   :   when part of a bitfield
4574				} elsif ($opv eq ':B') {
4575					# skip the bitfield test for now
4576
4577				# No spaces for:
4578				#   ->
4579				} elsif ($op eq '->') {
4580					if ($ctx =~ /Wx.|.xW/) {
4581						if (ERROR("SPACING",
4582							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4583							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4584							if (defined $fix_elements[$n + 2]) {
4585								$fix_elements[$n + 2] =~ s/^\s+//;
4586							}
4587							$line_fixed = 1;
4588						}
4589					}
4590
4591				# , must not have a space before and must have a space on the right.
4592				} elsif ($op eq ',') {
4593					my $rtrim_before = 0;
4594					my $space_after = 0;
4595					if ($ctx =~ /Wx./) {
4596						if (ERROR("SPACING",
4597							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4598							$line_fixed = 1;
4599							$rtrim_before = 1;
4600						}
4601					}
4602					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4603						if (ERROR("SPACING",
4604							  "space required after that '$op' $at\n" . $hereptr)) {
4605							$line_fixed = 1;
4606							$last_after = $n;
4607							$space_after = 1;
4608						}
4609					}
4610					if ($rtrim_before || $space_after) {
4611						if ($rtrim_before) {
4612							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4613						} else {
4614							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4615						}
4616						if ($space_after) {
4617							$good .= " ";
4618						}
4619					}
4620
4621				# '*' as part of a type definition -- reported already.
4622				} elsif ($opv eq '*_') {
4623					#warn "'*' is part of type\n";
4624
4625				# unary operators should have a space before and
4626				# none after.  May be left adjacent to another
4627				# unary operator, or a cast
4628				} elsif ($op eq '!' || $op eq '~' ||
4629					 $opv eq '*U' || $opv eq '-U' ||
4630					 $opv eq '&U' || $opv eq '&&U') {
4631					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4632						if (ERROR("SPACING",
4633							  "space required before that '$op' $at\n" . $hereptr)) {
4634							if ($n != $last_after + 2) {
4635								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4636								$line_fixed = 1;
4637							}
4638						}
4639					}
4640					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4641						# A unary '*' may be const
4642
4643					} elsif ($ctx =~ /.xW/) {
4644						if (ERROR("SPACING",
4645							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4646							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4647							if (defined $fix_elements[$n + 2]) {
4648								$fix_elements[$n + 2] =~ s/^\s+//;
4649							}
4650							$line_fixed = 1;
4651						}
4652					}
4653
4654				# unary ++ and unary -- are allowed no space on one side.
4655				} elsif ($op eq '++' or $op eq '--') {
4656					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4657						if (ERROR("SPACING",
4658							  "space required one side of that '$op' $at\n" . $hereptr)) {
4659							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4660							$line_fixed = 1;
4661						}
4662					}
4663					if ($ctx =~ /Wx[BE]/ ||
4664					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4665						if (ERROR("SPACING",
4666							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4667							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4668							$line_fixed = 1;
4669						}
4670					}
4671					if ($ctx =~ /ExW/) {
4672						if (ERROR("SPACING",
4673							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4674							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4675							if (defined $fix_elements[$n + 2]) {
4676								$fix_elements[$n + 2] =~ s/^\s+//;
4677							}
4678							$line_fixed = 1;
4679						}
4680					}
4681
4682				# << and >> may either have or not have spaces both sides
4683				} elsif ($op eq '<<' or $op eq '>>' or
4684					 $op eq '&' or $op eq '^' or $op eq '|' or
4685					 $op eq '+' or $op eq '-' or
4686					 $op eq '*' or $op eq '/' or
4687					 $op eq '%')
4688				{
4689					if ($check) {
4690						if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4691							if (CHK("SPACING",
4692								"spaces preferred around that '$op' $at\n" . $hereptr)) {
4693								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4694								$fix_elements[$n + 2] =~ s/^\s+//;
4695								$line_fixed = 1;
4696							}
4697						} elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4698							if (CHK("SPACING",
4699								"space preferred before that '$op' $at\n" . $hereptr)) {
4700								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4701								$line_fixed = 1;
4702							}
4703						}
4704					} elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4705						if (ERROR("SPACING",
4706							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
4707							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4708							if (defined $fix_elements[$n + 2]) {
4709								$fix_elements[$n + 2] =~ s/^\s+//;
4710							}
4711							$line_fixed = 1;
4712						}
4713					}
4714
4715				# A colon needs no spaces before when it is
4716				# terminating a case value or a label.
4717				} elsif ($opv eq ':C' || $opv eq ':L') {
4718					if ($ctx =~ /Wx./) {
4719						if (ERROR("SPACING",
4720							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4721							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4722							$line_fixed = 1;
4723						}
4724					}
4725
4726				# All the others need spaces both sides.
4727				} elsif ($ctx !~ /[EWC]x[CWE]/) {
4728					my $ok = 0;
4729
4730					# Ignore email addresses <foo@bar>
4731					if (($op eq '<' &&
4732					     $cc =~ /^\S+\@\S+>/) ||
4733					    ($op eq '>' &&
4734					     $ca =~ /<\S+\@\S+$/))
4735					{
4736						$ok = 1;
4737					}
4738
4739					# for asm volatile statements
4740					# ignore a colon with another
4741					# colon immediately before or after
4742					if (($op eq ':') &&
4743					    ($ca =~ /:$/ || $cc =~ /^:/)) {
4744						$ok = 1;
4745					}
4746
4747					# messages are ERROR, but ?: are CHK
4748					if ($ok == 0) {
4749						my $msg_level = \&ERROR;
4750						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4751
4752						if (&{$msg_level}("SPACING",
4753								  "spaces required around that '$op' $at\n" . $hereptr)) {
4754							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4755							if (defined $fix_elements[$n + 2]) {
4756								$fix_elements[$n + 2] =~ s/^\s+//;
4757							}
4758							$line_fixed = 1;
4759						}
4760					}
4761				}
4762				$off += length($elements[$n + 1]);
4763
4764##				print("n: <$n> GOOD: <$good>\n");
4765
4766				$fixed_line = $fixed_line . $good;
4767			}
4768
4769			if (($#elements % 2) == 0) {
4770				$fixed_line = $fixed_line . $fix_elements[$#elements];
4771			}
4772
4773			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4774				$fixed[$fixlinenr] = $fixed_line;
4775			}
4776
4777
4778		}
4779
4780# check for whitespace before a non-naked semicolon
4781		if ($line =~ /^\+.*\S\s+;\s*$/) {
4782			if (WARN("SPACING",
4783				 "space prohibited before semicolon\n" . $herecurr) &&
4784			    $fix) {
4785				1 while $fixed[$fixlinenr] =~
4786				    s/^(\+.*\S)\s+;/$1;/;
4787			}
4788		}
4789
4790# check for multiple assignments
4791		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4792			CHK("MULTIPLE_ASSIGNMENTS",
4793			    "multiple assignments should be avoided\n" . $herecurr);
4794		}
4795
4796## # check for multiple declarations, allowing for a function declaration
4797## # continuation.
4798## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4799## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4800##
4801## 			# Remove any bracketed sections to ensure we do not
4802## 			# falsly report the parameters of functions.
4803## 			my $ln = $line;
4804## 			while ($ln =~ s/\([^\(\)]*\)//g) {
4805## 			}
4806## 			if ($ln =~ /,/) {
4807## 				WARN("MULTIPLE_DECLARATION",
4808##				     "declaring multiple variables together should be avoided\n" . $herecurr);
4809## 			}
4810## 		}
4811
4812#need space before brace following if, while, etc
4813		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4814		    $line =~ /\b(?:else|do)\{/) {
4815			if (ERROR("SPACING",
4816				  "space required before the open brace '{'\n" . $herecurr) &&
4817			    $fix) {
4818				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4819			}
4820		}
4821
4822## # check for blank lines before declarations
4823##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4824##		    $prevrawline =~ /^.\s*$/) {
4825##			WARN("SPACING",
4826##			     "No blank lines before declarations\n" . $hereprev);
4827##		}
4828##
4829
4830# closing brace should have a space following it when it has anything
4831# on the line
4832		if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4833			if (ERROR("SPACING",
4834				  "space required after that close brace '}'\n" . $herecurr) &&
4835			    $fix) {
4836				$fixed[$fixlinenr] =~
4837				    s/}((?!(?:,|;|\)))\S)/} $1/;
4838			}
4839		}
4840
4841# check spacing on square brackets
4842		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4843			if (ERROR("SPACING",
4844				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
4845			    $fix) {
4846				$fixed[$fixlinenr] =~
4847				    s/\[\s+/\[/;
4848			}
4849		}
4850		if ($line =~ /\s\]/) {
4851			if (ERROR("SPACING",
4852				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4853			    $fix) {
4854				$fixed[$fixlinenr] =~
4855				    s/\s+\]/\]/;
4856			}
4857		}
4858
4859# check spacing on parentheses
4860		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4861		    $line !~ /for\s*\(\s+;/) {
4862			if (ERROR("SPACING",
4863				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4864			    $fix) {
4865				$fixed[$fixlinenr] =~
4866				    s/\(\s+/\(/;
4867			}
4868		}
4869		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4870		    $line !~ /for\s*\(.*;\s+\)/ &&
4871		    $line !~ /:\s+\)/) {
4872			if (ERROR("SPACING",
4873				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4874			    $fix) {
4875				$fixed[$fixlinenr] =~
4876				    s/\s+\)/\)/;
4877			}
4878		}
4879
4880# check unnecessary parentheses around addressof/dereference single $Lvals
4881# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4882
4883		while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4884			my $var = $1;
4885			if (CHK("UNNECESSARY_PARENTHESES",
4886				"Unnecessary parentheses around $var\n" . $herecurr) &&
4887			    $fix) {
4888				$fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4889			}
4890		}
4891
4892# check for unnecessary parentheses around function pointer uses
4893# ie: (foo->bar)(); should be foo->bar();
4894# but not "if (foo->bar) (" to avoid some false positives
4895		if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4896			my $var = $2;
4897			if (CHK("UNNECESSARY_PARENTHESES",
4898				"Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4899			    $fix) {
4900				my $var2 = deparenthesize($var);
4901				$var2 =~ s/\s//g;
4902				$fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4903			}
4904		}
4905
4906# check for unnecessary parentheses around comparisons in if uses
4907# when !drivers/staging or command-line uses --strict
4908		if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4909		    $perl_version_ok && defined($stat) &&
4910		    $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4911			my $if_stat = $1;
4912			my $test = substr($2, 1, -1);
4913			my $herectx;
4914			while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4915				my $match = $1;
4916				# avoid parentheses around potential macro args
4917				next if ($match =~ /^\s*\w+\s*$/);
4918				if (!defined($herectx)) {
4919					$herectx = $here . "\n";
4920					my $cnt = statement_rawlines($if_stat);
4921					for (my $n = 0; $n < $cnt; $n++) {
4922						my $rl = raw_line($linenr, $n);
4923						$herectx .=  $rl . "\n";
4924						last if $rl =~ /^[ \+].*\{/;
4925					}
4926				}
4927				CHK("UNNECESSARY_PARENTHESES",
4928				    "Unnecessary parentheses around '$match'\n" . $herectx);
4929			}
4930		}
4931
4932#goto labels aren't indented, allow a single space however
4933		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4934		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4935			if (WARN("INDENTED_LABEL",
4936				 "labels should not be indented\n" . $herecurr) &&
4937			    $fix) {
4938				$fixed[$fixlinenr] =~
4939				    s/^(.)\s+/$1/;
4940			}
4941		}
4942
4943# return is not a function
4944		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4945			my $spacing = $1;
4946			if ($perl_version_ok &&
4947			    $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4948				my $value = $1;
4949				$value = deparenthesize($value);
4950				if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4951					ERROR("RETURN_PARENTHESES",
4952					      "return is not a function, parentheses are not required\n" . $herecurr);
4953				}
4954			} elsif ($spacing !~ /\s+/) {
4955				ERROR("SPACING",
4956				      "space required before the open parenthesis '('\n" . $herecurr);
4957			}
4958		}
4959
4960# unnecessary return in a void function
4961# at end-of-function, with the previous line a single leading tab, then return;
4962# and the line before that not a goto label target like "out:"
4963		if ($sline =~ /^[ \+]}\s*$/ &&
4964		    $prevline =~ /^\+\treturn\s*;\s*$/ &&
4965		    $linenr >= 3 &&
4966		    $lines[$linenr - 3] =~ /^[ +]/ &&
4967		    $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4968			WARN("RETURN_VOID",
4969			     "void function return statements are not generally useful\n" . $hereprev);
4970               }
4971
4972# if statements using unnecessary parentheses - ie: if ((foo == bar))
4973		if ($perl_version_ok &&
4974		    $line =~ /\bif\s*((?:\(\s*){2,})/) {
4975			my $openparens = $1;
4976			my $count = $openparens =~ tr@\(@\(@;
4977			my $msg = "";
4978			if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4979				my $comp = $4;	#Not $1 because of $LvalOrFunc
4980				$msg = " - maybe == should be = ?" if ($comp eq "==");
4981				WARN("UNNECESSARY_PARENTHESES",
4982				     "Unnecessary parentheses$msg\n" . $herecurr);
4983			}
4984		}
4985
4986# comparisons with a constant or upper case identifier on the left
4987#	avoid cases like "foo + BAR < baz"
4988#	only fix matches surrounded by parentheses to avoid incorrect
4989#	conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4990		if ($perl_version_ok &&
4991		    $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4992			my $lead = $1;
4993			my $const = $2;
4994			my $comp = $3;
4995			my $to = $4;
4996			my $newcomp = $comp;
4997			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4998			    $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4999			    WARN("CONSTANT_COMPARISON",
5000				 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5001			    $fix) {
5002				if ($comp eq "<") {
5003					$newcomp = ">";
5004				} elsif ($comp eq "<=") {
5005					$newcomp = ">=";
5006				} elsif ($comp eq ">") {
5007					$newcomp = "<";
5008				} elsif ($comp eq ">=") {
5009					$newcomp = "<=";
5010				}
5011				$fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5012			}
5013		}
5014
5015# Return of what appears to be an errno should normally be negative
5016		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
5017			my $name = $1;
5018			if ($name ne 'EOF' && $name ne 'ERROR') {
5019				WARN("USE_NEGATIVE_ERRNO",
5020				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
5021			}
5022		}
5023
5024# Need a space before open parenthesis after if, while etc
5025		if ($line =~ /\b(if|while|for|switch)\(/) {
5026			if (ERROR("SPACING",
5027				  "space required before the open parenthesis '('\n" . $herecurr) &&
5028			    $fix) {
5029				$fixed[$fixlinenr] =~
5030				    s/\b(if|while|for|switch)\(/$1 \(/;
5031			}
5032		}
5033
5034# Check for illegal assignment in if conditional -- and check for trailing
5035# statements after the conditional.
5036		if ($line =~ /do\s*(?!{)/) {
5037			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5038				ctx_statement_block($linenr, $realcnt, 0)
5039					if (!defined $stat);
5040			my ($stat_next) = ctx_statement_block($line_nr_next,
5041						$remain_next, $off_next);
5042			$stat_next =~ s/\n./\n /g;
5043			##print "stat<$stat> stat_next<$stat_next>\n";
5044
5045			if ($stat_next =~ /^\s*while\b/) {
5046				# If the statement carries leading newlines,
5047				# then count those as offsets.
5048				my ($whitespace) =
5049					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5050				my $offset =
5051					statement_rawlines($whitespace) - 1;
5052
5053				$suppress_whiletrailers{$line_nr_next +
5054								$offset} = 1;
5055			}
5056		}
5057		if (!defined $suppress_whiletrailers{$linenr} &&
5058		    defined($stat) && defined($cond) &&
5059		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5060			my ($s, $c) = ($stat, $cond);
5061
5062			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
5063				if (ERROR("ASSIGN_IN_IF",
5064					  "do not use assignment in if condition\n" . $herecurr) &&
5065				    $fix && $perl_version_ok) {
5066					if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5067						my $space = $1;
5068						my $not = $2;
5069						my $statement = $3;
5070						my $assigned = $4;
5071						my $test = $8;
5072						my $against = $9;
5073						my $brace = $15;
5074						fix_delete_line($fixlinenr, $rawline);
5075						fix_insert_line($fixlinenr, "$space$statement;");
5076						my $newline = "${space}if (";
5077						$newline .= '!' if defined($not);
5078						$newline .= '(' if (defined $not && defined($test) && defined($against));
5079						$newline .= "$assigned";
5080						$newline .= " $test $against" if (defined($test) && defined($against));
5081						$newline .= ')' if (defined $not && defined($test) && defined($against));
5082						$newline .= ')';
5083						$newline .= " {" if (defined($brace));
5084						fix_insert_line($fixlinenr + 1, $newline);
5085					}
5086				}
5087			}
5088
5089			# Find out what is on the end of the line after the
5090			# conditional.
5091			substr($s, 0, length($c), '');
5092			$s =~ s/\n.*//g;
5093			$s =~ s/$;//g;	# Remove any comments
5094			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5095			    $c !~ /}\s*while\s*/)
5096			{
5097				# Find out how long the conditional actually is.
5098				my @newlines = ($c =~ /\n/gs);
5099				my $cond_lines = 1 + $#newlines;
5100				my $stat_real = '';
5101
5102				$stat_real = raw_line($linenr, $cond_lines)
5103							. "\n" if ($cond_lines);
5104				if (defined($stat_real) && $cond_lines > 1) {
5105					$stat_real = "[...]\n$stat_real";
5106				}
5107
5108				ERROR("TRAILING_STATEMENTS",
5109				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
5110			}
5111		}
5112
5113# Check for bitwise tests written as boolean
5114		if ($line =~ /
5115			(?:
5116				(?:\[|\(|\&\&|\|\|)
5117				\s*0[xX][0-9]+\s*
5118				(?:\&\&|\|\|)
5119			|
5120				(?:\&\&|\|\|)
5121				\s*0[xX][0-9]+\s*
5122				(?:\&\&|\|\||\)|\])
5123			)/x)
5124		{
5125			WARN("HEXADECIMAL_BOOLEAN_TEST",
5126			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5127		}
5128
5129# if and else should not have general statements after it
5130		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5131			my $s = $1;
5132			$s =~ s/$;//g;	# Remove any comments
5133			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5134				ERROR("TRAILING_STATEMENTS",
5135				      "trailing statements should be on next line\n" . $herecurr);
5136			}
5137		}
5138# if should not continue a brace
5139		if ($line =~ /}\s*if\b/) {
5140			ERROR("TRAILING_STATEMENTS",
5141			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
5142				$herecurr);
5143		}
5144# case and default should not have general statements after them
5145		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5146		    $line !~ /\G(?:
5147			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5148			\s*return\s+
5149		    )/xg)
5150		{
5151			ERROR("TRAILING_STATEMENTS",
5152			      "trailing statements should be on next line\n" . $herecurr);
5153		}
5154
5155		# Check for }<nl>else {, these must be at the same
5156		# indent level to be relevant to each other.
5157		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5158		    $previndent == $indent) {
5159			if (ERROR("ELSE_AFTER_BRACE",
5160				  "else should follow close brace '}'\n" . $hereprev) &&
5161			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5162				fix_delete_line($fixlinenr - 1, $prevrawline);
5163				fix_delete_line($fixlinenr, $rawline);
5164				my $fixedline = $prevrawline;
5165				$fixedline =~ s/}\s*$//;
5166				if ($fixedline !~ /^\+\s*$/) {
5167					fix_insert_line($fixlinenr, $fixedline);
5168				}
5169				$fixedline = $rawline;
5170				$fixedline =~ s/^(.\s*)else/$1} else/;
5171				fix_insert_line($fixlinenr, $fixedline);
5172			}
5173		}
5174
5175		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5176		    $previndent == $indent) {
5177			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5178
5179			# Find out what is on the end of the line after the
5180			# conditional.
5181			substr($s, 0, length($c), '');
5182			$s =~ s/\n.*//g;
5183
5184			if ($s =~ /^\s*;/) {
5185				if (ERROR("WHILE_AFTER_BRACE",
5186					  "while should follow close brace '}'\n" . $hereprev) &&
5187				    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5188					fix_delete_line($fixlinenr - 1, $prevrawline);
5189					fix_delete_line($fixlinenr, $rawline);
5190					my $fixedline = $prevrawline;
5191					my $trailing = $rawline;
5192					$trailing =~ s/^\+//;
5193					$trailing = trim($trailing);
5194					$fixedline =~ s/}\s*$/} $trailing/;
5195					fix_insert_line($fixlinenr, $fixedline);
5196				}
5197			}
5198		}
5199
5200#Specific variable tests
5201		while ($line =~ m{($Constant|$Lval)}g) {
5202			my $var = $1;
5203
5204#CamelCase
5205			if ($var !~ /^$Constant$/ &&
5206			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5207#Ignore Page<foo> variants
5208			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5209#Ignore SI style variants like nS, mV and dB
5210#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5211			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5212#Ignore some three character SI units explicitly, like MiB and KHz
5213			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5214				while ($var =~ m{($Ident)}g) {
5215					my $word = $1;
5216					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5217					if ($check) {
5218						seed_camelcase_includes();
5219						if (!$file && !$camelcase_file_seeded) {
5220							seed_camelcase_file($realfile);
5221							$camelcase_file_seeded = 1;
5222						}
5223					}
5224					if (!defined $camelcase{$word}) {
5225						$camelcase{$word} = 1;
5226						CHK("CAMELCASE",
5227						    "Avoid CamelCase: <$word>\n" . $herecurr);
5228					}
5229				}
5230			}
5231		}
5232
5233#no spaces allowed after \ in define
5234		if ($line =~ /\#\s*define.*\\\s+$/) {
5235			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5236				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5237			    $fix) {
5238				$fixed[$fixlinenr] =~ s/\s+$//;
5239			}
5240		}
5241
5242# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5243# itself <asm/foo.h> (uses RAW line)
5244		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5245			my $file = "$1.h";
5246			my $checkfile = "include/linux/$file";
5247			if (-f "$root/$checkfile" &&
5248			    $realfile ne $checkfile &&
5249			    $1 !~ /$allowed_asm_includes/)
5250			{
5251				my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5252				if ($asminclude > 0) {
5253					if ($realfile =~ m{^arch/}) {
5254						CHK("ARCH_INCLUDE_LINUX",
5255						    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5256					} else {
5257						WARN("INCLUDE_LINUX",
5258						     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5259					}
5260				}
5261			}
5262		}
5263
5264# multi-statement macros should be enclosed in a do while loop, grab the
5265# first statement and ensure its the whole macro if its not enclosed
5266# in a known good container
5267		if ($realfile !~ m@/vmlinux.lds.h$@ &&
5268		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5269			my $ln = $linenr;
5270			my $cnt = $realcnt;
5271			my ($off, $dstat, $dcond, $rest);
5272			my $ctx = '';
5273			my $has_flow_statement = 0;
5274			my $has_arg_concat = 0;
5275			($dstat, $dcond, $ln, $cnt, $off) =
5276				ctx_statement_block($linenr, $realcnt, 0);
5277			$ctx = $dstat;
5278			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5279			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5280
5281			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5282			$has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5283
5284			$dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5285			my $define_args = $1;
5286			my $define_stmt = $dstat;
5287			my @def_args = ();
5288
5289			if (defined $define_args && $define_args ne "") {
5290				$define_args = substr($define_args, 1, length($define_args) - 2);
5291				$define_args =~ s/\s*//g;
5292				$define_args =~ s/\\\+?//g;
5293				@def_args = split(",", $define_args);
5294			}
5295
5296			$dstat =~ s/$;//g;
5297			$dstat =~ s/\\\n.//g;
5298			$dstat =~ s/^\s*//s;
5299			$dstat =~ s/\s*$//s;
5300
5301			# Flatten any parentheses and braces
5302			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5303			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
5304			       $dstat =~ s/.\[[^\[\]]*\]/1/)
5305			{
5306			}
5307
5308			# Flatten any obvious string concatenation.
5309			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5310			       $dstat =~ s/$Ident\s*($String)/$1/)
5311			{
5312			}
5313
5314			# Make asm volatile uses seem like a generic function
5315			$dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5316
5317			my $exceptions = qr{
5318				$Declare|
5319				module_param_named|
5320				MODULE_PARM_DESC|
5321				DECLARE_PER_CPU|
5322				DEFINE_PER_CPU|
5323				__typeof__\(|
5324				union|
5325				struct|
5326				\.$Ident\s*=\s*|
5327				^\"|\"$|
5328				^\[
5329			}x;
5330			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5331
5332			$ctx =~ s/\n*$//;
5333			my $stmt_cnt = statement_rawlines($ctx);
5334			my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5335
5336			if ($dstat ne '' &&
5337			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
5338			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
5339			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5340			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
5341			    $dstat !~ /$exceptions/ &&
5342			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
5343			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
5344			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
5345			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
5346			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
5347			    $dstat !~ /^do\s*{/ &&					# do {...
5348			    $dstat !~ /^\(\{/ &&						# ({...
5349			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5350			{
5351				if ($dstat =~ /^\s*if\b/) {
5352					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5353					      "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5354				} elsif ($dstat =~ /;/) {
5355					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5356					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5357				} else {
5358					ERROR("COMPLEX_MACRO",
5359					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5360				}
5361
5362			}
5363
5364			# Make $define_stmt single line, comment-free, etc
5365			my @stmt_array = split('\n', $define_stmt);
5366			my $first = 1;
5367			$define_stmt = "";
5368			foreach my $l (@stmt_array) {
5369				$l =~ s/\\$//;
5370				if ($first) {
5371					$define_stmt = $l;
5372					$first = 0;
5373				} elsif ($l =~ /^[\+ ]/) {
5374					$define_stmt .= substr($l, 1);
5375				}
5376			}
5377			$define_stmt =~ s/$;//g;
5378			$define_stmt =~ s/\s+/ /g;
5379			$define_stmt = trim($define_stmt);
5380
5381# check if any macro arguments are reused (ignore '...' and 'type')
5382			foreach my $arg (@def_args) {
5383			        next if ($arg =~ /\.\.\./);
5384			        next if ($arg =~ /^type$/i);
5385				my $tmp_stmt = $define_stmt;
5386				$tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5387				$tmp_stmt =~ s/\#+\s*$arg\b//g;
5388				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
5389				my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5390				if ($use_cnt > 1) {
5391					CHK("MACRO_ARG_REUSE",
5392					    "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5393				    }
5394# check if any macro arguments may have other precedence issues
5395				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5396				    ((defined($1) && $1 ne ',') ||
5397				     (defined($2) && $2 ne ','))) {
5398					CHK("MACRO_ARG_PRECEDENCE",
5399					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5400				}
5401			}
5402
5403# check for macros with flow control, but without ## concatenation
5404# ## concatenation is commonly a macro that defines a function so ignore those
5405			if ($has_flow_statement && !$has_arg_concat) {
5406				my $cnt = statement_rawlines($ctx);
5407				my $herectx = get_stat_here($linenr, $cnt, $here);
5408
5409				WARN("MACRO_WITH_FLOW_CONTROL",
5410				     "Macros with flow control statements should be avoided\n" . "$herectx");
5411			}
5412
5413# check for line continuations outside of #defines, preprocessor #, and asm
5414
5415		} else {
5416			if ($prevline !~ /^..*\\$/ &&
5417			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
5418			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
5419			    $line =~ /^\+.*\\$/) {
5420				WARN("LINE_CONTINUATIONS",
5421				     "Avoid unnecessary line continuations\n" . $herecurr);
5422			}
5423		}
5424
5425# do {} while (0) macro tests:
5426# single-statement macros do not need to be enclosed in do while (0) loop,
5427# macro should not end with a semicolon
5428		if ($perl_version_ok &&
5429		    $realfile !~ m@/vmlinux.lds.h$@ &&
5430		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5431			my $ln = $linenr;
5432			my $cnt = $realcnt;
5433			my ($off, $dstat, $dcond, $rest);
5434			my $ctx = '';
5435			($dstat, $dcond, $ln, $cnt, $off) =
5436				ctx_statement_block($linenr, $realcnt, 0);
5437			$ctx = $dstat;
5438
5439			$dstat =~ s/\\\n.//g;
5440			$dstat =~ s/$;/ /g;
5441
5442			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5443				my $stmts = $2;
5444				my $semis = $3;
5445
5446				$ctx =~ s/\n*$//;
5447				my $cnt = statement_rawlines($ctx);
5448				my $herectx = get_stat_here($linenr, $cnt, $here);
5449
5450				if (($stmts =~ tr/;/;/) == 1 &&
5451				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
5452					WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5453					     "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5454				}
5455				if (defined $semis && $semis ne "") {
5456					WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5457					     "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5458				}
5459			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5460				$ctx =~ s/\n*$//;
5461				my $cnt = statement_rawlines($ctx);
5462				my $herectx = get_stat_here($linenr, $cnt, $here);
5463
5464				WARN("TRAILING_SEMICOLON",
5465				     "macros should not use a trailing semicolon\n" . "$herectx");
5466			}
5467		}
5468
5469# check for redundant bracing round if etc
5470		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5471			my ($level, $endln, @chunks) =
5472				ctx_statement_full($linenr, $realcnt, 1);
5473			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5474			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5475			if ($#chunks > 0 && $level == 0) {
5476				my @allowed = ();
5477				my $allow = 0;
5478				my $seen = 0;
5479				my $herectx = $here . "\n";
5480				my $ln = $linenr - 1;
5481				for my $chunk (@chunks) {
5482					my ($cond, $block) = @{$chunk};
5483
5484					# If the condition carries leading newlines, then count those as offsets.
5485					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5486					my $offset = statement_rawlines($whitespace) - 1;
5487
5488					$allowed[$allow] = 0;
5489					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5490
5491					# We have looked at and allowed this specific line.
5492					$suppress_ifbraces{$ln + $offset} = 1;
5493
5494					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5495					$ln += statement_rawlines($block) - 1;
5496
5497					substr($block, 0, length($cond), '');
5498
5499					$seen++ if ($block =~ /^\s*{/);
5500
5501					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5502					if (statement_lines($cond) > 1) {
5503						#print "APW: ALLOWED: cond<$cond>\n";
5504						$allowed[$allow] = 1;
5505					}
5506					if ($block =~/\b(?:if|for|while)\b/) {
5507						#print "APW: ALLOWED: block<$block>\n";
5508						$allowed[$allow] = 1;
5509					}
5510					if (statement_block_size($block) > 1) {
5511						#print "APW: ALLOWED: lines block<$block>\n";
5512						$allowed[$allow] = 1;
5513					}
5514					$allow++;
5515				}
5516				if ($seen) {
5517					my $sum_allowed = 0;
5518					foreach (@allowed) {
5519						$sum_allowed += $_;
5520					}
5521					if ($sum_allowed == 0) {
5522						WARN("BRACES",
5523						     "braces {} are not necessary for any arm of this statement\n" . $herectx);
5524					} elsif ($sum_allowed != $allow &&
5525						 $seen != $allow) {
5526						CHK("BRACES",
5527						    "braces {} should be used on all arms of this statement\n" . $herectx);
5528					}
5529				}
5530			}
5531		}
5532		if (!defined $suppress_ifbraces{$linenr - 1} &&
5533					$line =~ /\b(if|while|for|else)\b/) {
5534			my $allowed = 0;
5535
5536			# Check the pre-context.
5537			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5538				#print "APW: ALLOWED: pre<$1>\n";
5539				$allowed = 1;
5540			}
5541
5542			my ($level, $endln, @chunks) =
5543				ctx_statement_full($linenr, $realcnt, $-[0]);
5544
5545			# Check the condition.
5546			my ($cond, $block) = @{$chunks[0]};
5547			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5548			if (defined $cond) {
5549				substr($block, 0, length($cond), '');
5550			}
5551			if (statement_lines($cond) > 1) {
5552				#print "APW: ALLOWED: cond<$cond>\n";
5553				$allowed = 1;
5554			}
5555			if ($block =~/\b(?:if|for|while)\b/) {
5556				#print "APW: ALLOWED: block<$block>\n";
5557				$allowed = 1;
5558			}
5559			if (statement_block_size($block) > 1) {
5560				#print "APW: ALLOWED: lines block<$block>\n";
5561				$allowed = 1;
5562			}
5563			# Check the post-context.
5564			if (defined $chunks[1]) {
5565				my ($cond, $block) = @{$chunks[1]};
5566				if (defined $cond) {
5567					substr($block, 0, length($cond), '');
5568				}
5569				if ($block =~ /^\s*\{/) {
5570					#print "APW: ALLOWED: chunk-1 block<$block>\n";
5571					$allowed = 1;
5572				}
5573			}
5574			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5575				my $cnt = statement_rawlines($block);
5576				my $herectx = get_stat_here($linenr, $cnt, $here);
5577
5578				WARN("BRACES",
5579				     "braces {} are not necessary for single statement blocks\n" . $herectx);
5580			}
5581		}
5582
5583# check for single line unbalanced braces
5584		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5585		    $sline =~ /^.\s*else\s*\{\s*$/) {
5586			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5587		}
5588
5589# check for unnecessary blank lines around braces
5590		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5591			if (CHK("BRACES",
5592				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5593			    $fix && $prevrawline =~ /^\+/) {
5594				fix_delete_line($fixlinenr - 1, $prevrawline);
5595			}
5596		}
5597		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5598			if (CHK("BRACES",
5599				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5600			    $fix) {
5601				fix_delete_line($fixlinenr, $rawline);
5602			}
5603		}
5604
5605# no volatiles please
5606		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5607		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5608			WARN("VOLATILE",
5609			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5610		}
5611
5612# Check for user-visible strings broken across lines, which breaks the ability
5613# to grep for the string.  Make exceptions when the previous string ends in a
5614# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5615# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5616		if ($line =~ /^\+\s*$String/ &&
5617		    $prevline =~ /"\s*$/ &&
5618		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5619			if (WARN("SPLIT_STRING",
5620				 "quoted string split across lines\n" . $hereprev) &&
5621				     $fix &&
5622				     $prevrawline =~ /^\+.*"\s*$/ &&
5623				     $last_coalesced_string_linenr != $linenr - 1) {
5624				my $extracted_string = get_quoted_string($line, $rawline);
5625				my $comma_close = "";
5626				if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5627					$comma_close = $1;
5628				}
5629
5630				fix_delete_line($fixlinenr - 1, $prevrawline);
5631				fix_delete_line($fixlinenr, $rawline);
5632				my $fixedline = $prevrawline;
5633				$fixedline =~ s/"\s*$//;
5634				$fixedline .= substr($extracted_string, 1) . trim($comma_close);
5635				fix_insert_line($fixlinenr - 1, $fixedline);
5636				$fixedline = $rawline;
5637				$fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5638				if ($fixedline !~ /\+\s*$/) {
5639					fix_insert_line($fixlinenr, $fixedline);
5640				}
5641				$last_coalesced_string_linenr = $linenr;
5642			}
5643		}
5644
5645# check for missing a space in a string concatenation
5646		if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5647			WARN('MISSING_SPACE',
5648			     "break quoted strings at a space character\n" . $hereprev);
5649		}
5650
5651# check for an embedded function name in a string when the function is known
5652# This does not work very well for -f --file checking as it depends on patch
5653# context providing the function name or a single line form for in-file
5654# function declarations
5655		if ($line =~ /^\+.*$String/ &&
5656		    defined($context_function) &&
5657		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5658		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5659			WARN("EMBEDDED_FUNCTION_NAME",
5660			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5661		}
5662
5663# check for spaces before a quoted newline
5664		if ($rawline =~ /^.*\".*\s\\n/) {
5665			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5666				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5667			    $fix) {
5668				$fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5669			}
5670
5671		}
5672
5673# concatenated string without spaces between elements
5674		if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5675			if (CHK("CONCATENATED_STRING",
5676				"Concatenated strings should use spaces between elements\n" . $herecurr) &&
5677			    $fix) {
5678				while ($line =~ /($String)/g) {
5679					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5680					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5681					$fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5682				}
5683			}
5684		}
5685
5686# uncoalesced string fragments
5687		if ($line =~ /$String\s*"/) {
5688			if (WARN("STRING_FRAGMENTS",
5689				 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5690			    $fix) {
5691				while ($line =~ /($String)(?=\s*")/g) {
5692					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5693					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5694				}
5695			}
5696		}
5697
5698# check for non-standard and hex prefixed decimal printf formats
5699		my $show_L = 1;	#don't show the same defect twice
5700		my $show_Z = 1;
5701		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5702			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5703			$string =~ s/%%/__/g;
5704			# check for %L
5705			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5706				WARN("PRINTF_L",
5707				     "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5708				$show_L = 0;
5709			}
5710			# check for %Z
5711			if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5712				WARN("PRINTF_Z",
5713				     "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5714				$show_Z = 0;
5715			}
5716			# check for 0x<decimal>
5717			if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5718				ERROR("PRINTF_0XDECIMAL",
5719				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
5720			}
5721		}
5722
5723# check for line continuations in quoted strings with odd counts of "
5724		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5725			WARN("LINE_CONTINUATIONS",
5726			     "Avoid line continuations in quoted strings\n" . $herecurr);
5727		}
5728
5729# warn about #if 0
5730		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5731			WARN("IF_0",
5732			     "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5733		}
5734
5735# warn about #if 1
5736		if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5737			WARN("IF_1",
5738			     "Consider removing the #if 1 and its #endif\n" . $herecurr);
5739		}
5740
5741# check for needless "if (<foo>) fn(<foo>)" uses
5742		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5743			my $tested = quotemeta($1);
5744			my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5745			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5746				my $func = $1;
5747				if (WARN('NEEDLESS_IF',
5748					 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5749				    $fix) {
5750					my $do_fix = 1;
5751					my $leading_tabs = "";
5752					my $new_leading_tabs = "";
5753					if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5754						$leading_tabs = $1;
5755					} else {
5756						$do_fix = 0;
5757					}
5758					if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5759						$new_leading_tabs = $1;
5760						if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5761							$do_fix = 0;
5762						}
5763					} else {
5764						$do_fix = 0;
5765					}
5766					if ($do_fix) {
5767						fix_delete_line($fixlinenr - 1, $prevrawline);
5768						$fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5769					}
5770				}
5771			}
5772		}
5773
5774# check for unnecessary "Out of Memory" messages
5775		if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5776		    $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5777		    (defined $1 || defined $3) &&
5778		    $linenr > 3) {
5779			my $testval = $2;
5780			my $testline = $lines[$linenr - 3];
5781
5782			my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5783#			print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5784
5785			if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5786			    $s !~ /\b__GFP_NOWARN\b/ ) {
5787				WARN("OOM_MESSAGE",
5788				     "Possible unnecessary 'out of memory' message\n" . $hereprev);
5789			}
5790		}
5791
5792# check for logging functions with KERN_<LEVEL>
5793		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5794		    $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5795			my $level = $1;
5796			if (WARN("UNNECESSARY_KERN_LEVEL",
5797				 "Possible unnecessary $level\n" . $herecurr) &&
5798			    $fix) {
5799				$fixed[$fixlinenr] =~ s/\s*$level\s*//;
5800			}
5801		}
5802
5803# check for logging continuations
5804		if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5805			WARN("LOGGING_CONTINUATION",
5806			     "Avoid logging continuation uses where feasible\n" . $herecurr);
5807		}
5808
5809# check for mask then right shift without a parentheses
5810		if ($perl_version_ok &&
5811		    $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5812		    $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5813			WARN("MASK_THEN_SHIFT",
5814			     "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5815		}
5816
5817# check for pointer comparisons to NULL
5818		if ($perl_version_ok) {
5819			while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5820				my $val = $1;
5821				my $equal = "!";
5822				$equal = "" if ($4 eq "!=");
5823				if (CHK("COMPARISON_TO_NULL",
5824					"Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5825					    $fix) {
5826					$fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5827				}
5828			}
5829		}
5830
5831# check for bad placement of section $InitAttribute (e.g.: __initdata)
5832		if ($line =~ /(\b$InitAttribute\b)/) {
5833			my $attr = $1;
5834			if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5835				my $ptr = $1;
5836				my $var = $2;
5837				if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5838				      ERROR("MISPLACED_INIT",
5839					    "$attr should be placed after $var\n" . $herecurr)) ||
5840				     ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5841				      WARN("MISPLACED_INIT",
5842					   "$attr should be placed after $var\n" . $herecurr))) &&
5843				    $fix) {
5844					$fixed[$fixlinenr] =~ 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;
5845				}
5846			}
5847		}
5848
5849# check for $InitAttributeData (ie: __initdata) with const
5850		if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5851			my $attr = $1;
5852			$attr =~ /($InitAttributePrefix)(.*)/;
5853			my $attr_prefix = $1;
5854			my $attr_type = $2;
5855			if (ERROR("INIT_ATTRIBUTE",
5856				  "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5857			    $fix) {
5858				$fixed[$fixlinenr] =~
5859				    s/$InitAttributeData/${attr_prefix}initconst/;
5860			}
5861		}
5862
5863# check for $InitAttributeConst (ie: __initconst) without const
5864		if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5865			my $attr = $1;
5866			if (ERROR("INIT_ATTRIBUTE",
5867				  "Use of $attr requires a separate use of const\n" . $herecurr) &&
5868			    $fix) {
5869				my $lead = $fixed[$fixlinenr] =~
5870				    /(^\+\s*(?:static\s+))/;
5871				$lead = rtrim($1);
5872				$lead = "$lead " if ($lead !~ /^\+$/);
5873				$lead = "${lead}const ";
5874				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5875			}
5876		}
5877
5878# check for __read_mostly with const non-pointer (should just be const)
5879		if ($line =~ /\b__read_mostly\b/ &&
5880		    $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5881			if (ERROR("CONST_READ_MOSTLY",
5882				  "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5883			    $fix) {
5884				$fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5885			}
5886		}
5887
5888# don't use __constant_<foo> functions outside of include/uapi/
5889		if ($realfile !~ m@^include/uapi/@ &&
5890		    $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5891			my $constant_func = $1;
5892			my $func = $constant_func;
5893			$func =~ s/^__constant_//;
5894			if (WARN("CONSTANT_CONVERSION",
5895				 "$constant_func should be $func\n" . $herecurr) &&
5896			    $fix) {
5897				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5898			}
5899		}
5900
5901# prefer usleep_range over udelay
5902		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5903			my $delay = $1;
5904			# ignore udelay's < 10, however
5905			if (! ($delay < 10) ) {
5906				CHK("USLEEP_RANGE",
5907				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5908			}
5909			if ($delay > 2000) {
5910				WARN("LONG_UDELAY",
5911				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5912			}
5913		}
5914
5915# warn about unexpectedly long msleep's
5916		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5917			if ($1 < 20) {
5918				WARN("MSLEEP",
5919				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5920			}
5921		}
5922
5923# check for comparisons of jiffies
5924		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5925			WARN("JIFFIES_COMPARISON",
5926			     "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5927		}
5928
5929# check for comparisons of get_jiffies_64()
5930		if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5931			WARN("JIFFIES_COMPARISON",
5932			     "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5933		}
5934
5935# warn about #ifdefs in C files
5936#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5937#			print "#ifdef in C files should be avoided\n";
5938#			print "$herecurr";
5939#			$clean = 0;
5940#		}
5941
5942# warn about spacing in #ifdefs
5943		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5944			if (ERROR("SPACING",
5945				  "exactly one space required after that #$1\n" . $herecurr) &&
5946			    $fix) {
5947				$fixed[$fixlinenr] =~
5948				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5949			}
5950
5951		}
5952
5953# check for spinlock_t definitions without a comment.
5954		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5955		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5956			my $which = $1;
5957			if (!ctx_has_comment($first_line, $linenr)) {
5958				CHK("UNCOMMENTED_DEFINITION",
5959				    "$1 definition without comment\n" . $herecurr);
5960			}
5961		}
5962# check for memory barriers without a comment.
5963
5964		my $barriers = qr{
5965			mb|
5966			rmb|
5967			wmb
5968		}x;
5969		my $barrier_stems = qr{
5970			mb__before_atomic|
5971			mb__after_atomic|
5972			store_release|
5973			load_acquire|
5974			store_mb|
5975			(?:$barriers)
5976		}x;
5977		my $all_barriers = qr{
5978			(?:$barriers)|
5979			smp_(?:$barrier_stems)|
5980			virt_(?:$barrier_stems)
5981		}x;
5982
5983		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5984			if (!ctx_has_comment($first_line, $linenr)) {
5985				WARN("MEMORY_BARRIER",
5986				     "memory barrier without comment\n" . $herecurr);
5987			}
5988		}
5989
5990		my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5991
5992		if ($realfile !~ m@^include/asm-generic/@ &&
5993		    $realfile !~ m@/barrier\.h$@ &&
5994		    $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5995		    $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5996			WARN("MEMORY_BARRIER",
5997			     "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5998		}
5999
6000# check for waitqueue_active without a comment.
6001		if ($line =~ /\bwaitqueue_active\s*\(/) {
6002			if (!ctx_has_comment($first_line, $linenr)) {
6003				WARN("WAITQUEUE_ACTIVE",
6004				     "waitqueue_active without comment\n" . $herecurr);
6005			}
6006		}
6007
6008# check for data_race without a comment.
6009		if ($line =~ /\bdata_race\s*\(/) {
6010			if (!ctx_has_comment($first_line, $linenr)) {
6011				WARN("DATA_RACE",
6012				     "data_race without comment\n" . $herecurr);
6013			}
6014		}
6015
6016# check of hardware specific defines
6017		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6018			CHK("ARCH_DEFINES",
6019			    "architecture specific defines should be avoided\n" .  $herecurr);
6020		}
6021
6022# check that the storage class is not after a type
6023		if ($line =~ /\b($Type)\s+($Storage)\b/) {
6024			WARN("STORAGE_CLASS",
6025			     "storage class '$2' should be located before type '$1'\n" . $herecurr);
6026		}
6027# Check that the storage class is at the beginning of a declaration
6028		if ($line =~ /\b$Storage\b/ &&
6029		    $line !~ /^.\s*$Storage/ &&
6030		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
6031		    $1 !~ /[\,\)]\s*$/) {
6032			WARN("STORAGE_CLASS",
6033			     "storage class should be at the beginning of the declaration\n" . $herecurr);
6034		}
6035
6036# check the location of the inline attribute, that it is between
6037# storage class and type.
6038		if ($line =~ /\b$Type\s+$Inline\b/ ||
6039		    $line =~ /\b$Inline\s+$Storage\b/) {
6040			ERROR("INLINE_LOCATION",
6041			      "inline keyword should sit between storage class and type\n" . $herecurr);
6042		}
6043
6044# Check for __inline__ and __inline, prefer inline
6045		if ($realfile !~ m@\binclude/uapi/@ &&
6046		    $line =~ /\b(__inline__|__inline)\b/) {
6047			if (WARN("INLINE",
6048				 "plain inline is preferred over $1\n" . $herecurr) &&
6049			    $fix) {
6050				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6051
6052			}
6053		}
6054
6055# Check for __attribute__ packed, prefer __packed
6056		if ($realfile !~ m@\binclude/uapi/@ &&
6057		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
6058			WARN("PREFER_PACKED",
6059			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
6060		}
6061
6062# Check for __attribute__ aligned, prefer __aligned
6063		if ($realfile !~ m@\binclude/uapi/@ &&
6064		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
6065			WARN("PREFER_ALIGNED",
6066			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
6067		}
6068
6069# Check for __attribute__ section, prefer __section
6070		if ($realfile !~ m@\binclude/uapi/@ &&
6071		    $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6072			my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6073			my $new = substr($old, 1, -1);
6074			if (WARN("PREFER_SECTION",
6075				 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6076			    $fix) {
6077				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6078			}
6079		}
6080
6081# Check for __attribute__ format(printf, prefer __printf
6082		if ($realfile !~ m@\binclude/uapi/@ &&
6083		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
6084			if (WARN("PREFER_PRINTF",
6085				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6086			    $fix) {
6087				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
6088
6089			}
6090		}
6091
6092# Check for __attribute__ format(scanf, prefer __scanf
6093		if ($realfile !~ m@\binclude/uapi/@ &&
6094		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
6095			if (WARN("PREFER_SCANF",
6096				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6097			    $fix) {
6098				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
6099			}
6100		}
6101
6102# Check for __attribute__ weak, or __weak declarations (may have link issues)
6103		if ($perl_version_ok &&
6104		    $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6105		    ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6106		     $line =~ /\b__weak\b/)) {
6107			ERROR("WEAK_DECLARATION",
6108			      "Using weak declarations can have unintended link defects\n" . $herecurr);
6109		}
6110
6111# check for c99 types like uint8_t used outside of uapi/ and tools/
6112		if ($realfile !~ m@\binclude/uapi/@ &&
6113		    $realfile !~ m@\btools/@ &&
6114		    $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6115			my $type = $1;
6116			if ($type =~ /\b($typeC99Typedefs)\b/) {
6117				$type = $1;
6118				my $kernel_type = 'u';
6119				$kernel_type = 's' if ($type =~ /^_*[si]/);
6120				$type =~ /(\d+)/;
6121				$kernel_type .= $1;
6122				if (CHK("PREFER_KERNEL_TYPES",
6123					"Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6124				    $fix) {
6125					$fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6126				}
6127			}
6128		}
6129
6130# check for cast of C90 native int or longer types constants
6131		if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6132			my $cast = $1;
6133			my $const = $2;
6134			if (WARN("TYPECAST_INT_CONSTANT",
6135				 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6136			    $fix) {
6137				my $suffix = "";
6138				my $newconst = $const;
6139				$newconst =~ s/${Int_type}$//;
6140				$suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6141				if ($cast =~ /\blong\s+long\b/) {
6142					$suffix .= 'LL';
6143				} elsif ($cast =~ /\blong\b/) {
6144					$suffix .= 'L';
6145				}
6146				$fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6147			}
6148		}
6149
6150# check for sizeof(&)
6151		if ($line =~ /\bsizeof\s*\(\s*\&/) {
6152			WARN("SIZEOF_ADDRESS",
6153			     "sizeof(& should be avoided\n" . $herecurr);
6154		}
6155
6156# check for sizeof without parenthesis
6157		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6158			if (WARN("SIZEOF_PARENTHESIS",
6159				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6160			    $fix) {
6161				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6162			}
6163		}
6164
6165# check for struct spinlock declarations
6166		if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6167			WARN("USE_SPINLOCK_T",
6168			     "struct spinlock should be spinlock_t\n" . $herecurr);
6169		}
6170
6171# check for seq_printf uses that could be seq_puts
6172		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6173			my $fmt = get_quoted_string($line, $rawline);
6174			$fmt =~ s/%%//g;
6175			if ($fmt !~ /%/) {
6176				if (WARN("PREFER_SEQ_PUTS",
6177					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6178				    $fix) {
6179					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6180				}
6181			}
6182		}
6183
6184# check for vsprintf extension %p<foo> misuses
6185		if ($perl_version_ok &&
6186		    defined $stat &&
6187		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6188		    $1 !~ /^_*volatile_*$/) {
6189			my $stat_real;
6190
6191			my $lc = $stat =~ tr@\n@@;
6192			$lc = $lc + $linenr;
6193		        for (my $count = $linenr; $count <= $lc; $count++) {
6194				my $specifier;
6195				my $extension;
6196				my $qualifier;
6197				my $bad_specifier = "";
6198				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6199				$fmt =~ s/%%//g;
6200
6201				while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6202					$specifier = $1;
6203					$extension = $2;
6204					$qualifier = $3;
6205					if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6206					    ($extension eq "f" &&
6207					     defined $qualifier && $qualifier !~ /^w/)) {
6208						$bad_specifier = $specifier;
6209						last;
6210					}
6211					if ($extension eq "x" && !defined($stat_real)) {
6212						if (!defined($stat_real)) {
6213							$stat_real = get_stat_real($linenr, $lc);
6214						}
6215						WARN("VSPRINTF_SPECIFIER_PX",
6216						     "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
6217					}
6218				}
6219				if ($bad_specifier ne "") {
6220					my $stat_real = get_stat_real($linenr, $lc);
6221					my $ext_type = "Invalid";
6222					my $use = "";
6223					if ($bad_specifier =~ /p[Ff]/) {
6224						$use = " - use %pS instead";
6225						$use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6226					}
6227
6228					WARN("VSPRINTF_POINTER_EXTENSION",
6229					     "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6230				}
6231			}
6232		}
6233
6234# Check for misused memsets
6235		if ($perl_version_ok &&
6236		    defined $stat &&
6237		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6238
6239			my $ms_addr = $2;
6240			my $ms_val = $7;
6241			my $ms_size = $12;
6242
6243			if ($ms_size =~ /^(0x|)0$/i) {
6244				ERROR("MEMSET",
6245				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6246			} elsif ($ms_size =~ /^(0x|)1$/i) {
6247				WARN("MEMSET",
6248				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6249			}
6250		}
6251
6252# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6253#		if ($perl_version_ok &&
6254#		    defined $stat &&
6255#		    $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6256#			if (WARN("PREFER_ETHER_ADDR_COPY",
6257#				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6258#			    $fix) {
6259#				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6260#			}
6261#		}
6262
6263# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6264#		if ($perl_version_ok &&
6265#		    defined $stat &&
6266#		    $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6267#			WARN("PREFER_ETHER_ADDR_EQUAL",
6268#			     "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6269#		}
6270
6271# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6272# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6273#		if ($perl_version_ok &&
6274#		    defined $stat &&
6275#		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6276#
6277#			my $ms_val = $7;
6278#
6279#			if ($ms_val =~ /^(?:0x|)0+$/i) {
6280#				if (WARN("PREFER_ETH_ZERO_ADDR",
6281#					 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6282#				    $fix) {
6283#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6284#				}
6285#			} elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6286#				if (WARN("PREFER_ETH_BROADCAST_ADDR",
6287#					 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6288#				    $fix) {
6289#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6290#				}
6291#			}
6292#		}
6293
6294# typecasts on min/max could be min_t/max_t
6295		if ($perl_version_ok &&
6296		    defined $stat &&
6297		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6298			if (defined $2 || defined $7) {
6299				my $call = $1;
6300				my $cast1 = deparenthesize($2);
6301				my $arg1 = $3;
6302				my $cast2 = deparenthesize($7);
6303				my $arg2 = $8;
6304				my $cast;
6305
6306				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6307					$cast = "$cast1 or $cast2";
6308				} elsif ($cast1 ne "") {
6309					$cast = $cast1;
6310				} else {
6311					$cast = $cast2;
6312				}
6313				WARN("MINMAX",
6314				     "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6315			}
6316		}
6317
6318# check usleep_range arguments
6319		if ($perl_version_ok &&
6320		    defined $stat &&
6321		    $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6322			my $min = $1;
6323			my $max = $7;
6324			if ($min eq $max) {
6325				WARN("USLEEP_RANGE",
6326				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6327			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6328				 $min > $max) {
6329				WARN("USLEEP_RANGE",
6330				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6331			}
6332		}
6333
6334# check for naked sscanf
6335		if ($perl_version_ok &&
6336		    defined $stat &&
6337		    $line =~ /\bsscanf\b/ &&
6338		    ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6339		     $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6340		     $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6341			my $lc = $stat =~ tr@\n@@;
6342			$lc = $lc + $linenr;
6343			my $stat_real = get_stat_real($linenr, $lc);
6344			WARN("NAKED_SSCANF",
6345			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6346		}
6347
6348# check for simple sscanf that should be kstrto<foo>
6349		if ($perl_version_ok &&
6350		    defined $stat &&
6351		    $line =~ /\bsscanf\b/) {
6352			my $lc = $stat =~ tr@\n@@;
6353			$lc = $lc + $linenr;
6354			my $stat_real = get_stat_real($linenr, $lc);
6355			if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6356				my $format = $6;
6357				my $count = $format =~ tr@%@%@;
6358				if ($count == 1 &&
6359				    $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6360					WARN("SSCANF_TO_KSTRTO",
6361					     "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6362				}
6363			}
6364		}
6365
6366# check for new externs in .h files.
6367		if ($realfile =~ /\.h$/ &&
6368		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6369			if (CHK("AVOID_EXTERNS",
6370				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
6371			    $fix) {
6372				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6373			}
6374		}
6375
6376# check for new externs in .c files.
6377		if ($realfile =~ /\.c$/ && defined $stat &&
6378		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6379		{
6380			my $function_name = $1;
6381			my $paren_space = $2;
6382
6383			my $s = $stat;
6384			if (defined $cond) {
6385				substr($s, 0, length($cond), '');
6386			}
6387			if ($s =~ /^\s*;/)
6388			{
6389				WARN("AVOID_EXTERNS",
6390				     "externs should be avoided in .c files\n" .  $herecurr);
6391			}
6392
6393			if ($paren_space =~ /\n/) {
6394				WARN("FUNCTION_ARGUMENTS",
6395				     "arguments for function declarations should follow identifier\n" . $herecurr);
6396			}
6397
6398		} elsif ($realfile =~ /\.c$/ && defined $stat &&
6399		    $stat =~ /^.\s*extern\s+/)
6400		{
6401			WARN("AVOID_EXTERNS",
6402			     "externs should be avoided in .c files\n" .  $herecurr);
6403		}
6404
6405# check for function declarations that have arguments without identifier names
6406		if (defined $stat &&
6407		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6408		    $1 ne "void") {
6409			my $args = trim($1);
6410			while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6411				my $arg = trim($1);
6412				if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6413					WARN("FUNCTION_ARGUMENTS",
6414					     "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6415				}
6416			}
6417		}
6418
6419# check for function definitions
6420		if ($perl_version_ok &&
6421		    defined $stat &&
6422		    $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6423			$context_function = $1;
6424
6425# check for multiline function definition with misplaced open brace
6426			my $ok = 0;
6427			my $cnt = statement_rawlines($stat);
6428			my $herectx = $here . "\n";
6429			for (my $n = 0; $n < $cnt; $n++) {
6430				my $rl = raw_line($linenr, $n);
6431				$herectx .=  $rl . "\n";
6432				$ok = 1 if ($rl =~ /^[ \+]\{/);
6433				$ok = 1 if ($rl =~ /\{/ && $n == 0);
6434				last if $rl =~ /^[ \+].*\{/;
6435			}
6436			if (!$ok) {
6437				ERROR("OPEN_BRACE",
6438				      "open brace '{' following function definitions go on the next line\n" . $herectx);
6439			}
6440		}
6441
6442# checks for new __setup's
6443		if ($rawline =~ /\b__setup\("([^"]*)"/) {
6444			my $name = $1;
6445
6446			if (!grep(/$name/, @setup_docs)) {
6447				CHK("UNDOCUMENTED_SETUP",
6448				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6449			}
6450		}
6451
6452# check for pointless casting of alloc functions
6453		if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6454			WARN("UNNECESSARY_CASTS",
6455			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6456		}
6457
6458# alloc style
6459# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6460		if ($perl_version_ok &&
6461		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6462			CHK("ALLOC_SIZEOF_STRUCT",
6463			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6464		}
6465
6466# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6467		if ($perl_version_ok &&
6468		    defined $stat &&
6469		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6470			my $oldfunc = $3;
6471			my $a1 = $4;
6472			my $a2 = $10;
6473			my $newfunc = "kmalloc_array";
6474			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6475			my $r1 = $a1;
6476			my $r2 = $a2;
6477			if ($a1 =~ /^sizeof\s*\S/) {
6478				$r1 = $a2;
6479				$r2 = $a1;
6480			}
6481			if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6482			    !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6483				my $cnt = statement_rawlines($stat);
6484				my $herectx = get_stat_here($linenr, $cnt, $here);
6485
6486				if (WARN("ALLOC_WITH_MULTIPLY",
6487					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6488				    $cnt == 1 &&
6489				    $fix) {
6490					$fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
6491				}
6492			}
6493		}
6494
6495# check for krealloc arg reuse
6496		if ($perl_version_ok &&
6497		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6498		    $1 eq $3) {
6499			WARN("KREALLOC_ARG_REUSE",
6500			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6501		}
6502
6503# check for alloc argument mismatch
6504		if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6505			WARN("ALLOC_ARRAY_ARGS",
6506			     "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6507		}
6508
6509# check for multiple semicolons
6510		if ($line =~ /;\s*;\s*$/) {
6511			if (WARN("ONE_SEMICOLON",
6512				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6513			    $fix) {
6514				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6515			}
6516		}
6517
6518# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6519		if ($realfile !~ m@^include/uapi/@ &&
6520		    $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6521			my $ull = "";
6522			$ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6523			if (CHK("BIT_MACRO",
6524				"Prefer using the BIT$ull macro\n" . $herecurr) &&
6525			    $fix) {
6526				$fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6527			}
6528		}
6529
6530# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
6531		if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^CONFIG_/) {
6532			WARN("IS_ENABLED_CONFIG",
6533			     "IS_ENABLED($1) is normally used as IS_ENABLED(CONFIG_$1)\n" . $herecurr);
6534		}
6535
6536# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6537		if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6538			my $config = $1;
6539			if (WARN("PREFER_IS_ENABLED",
6540				 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6541			    $fix) {
6542				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6543			}
6544		}
6545
6546# check for /* fallthrough */ like comment, prefer fallthrough;
6547		my @fallthroughs = (
6548			'fallthrough',
6549			'@fallthrough@',
6550			'lint -fallthrough[ \t]*',
6551			'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6552			'(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6553			'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6554			'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6555		    );
6556		if ($raw_comment ne '') {
6557			foreach my $ft (@fallthroughs) {
6558				if ($raw_comment =~ /$ft/) {
6559					my $msg_level = \&WARN;
6560					$msg_level = \&CHK if ($file);
6561					&{$msg_level}("PREFER_FALLTHROUGH",
6562						      "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6563					last;
6564				}
6565			}
6566		}
6567
6568# check for switch/default statements without a break;
6569		if ($perl_version_ok &&
6570		    defined $stat &&
6571		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6572			my $cnt = statement_rawlines($stat);
6573			my $herectx = get_stat_here($linenr, $cnt, $here);
6574
6575			WARN("DEFAULT_NO_BREAK",
6576			     "switch default: should use break\n" . $herectx);
6577		}
6578
6579# check for gcc specific __FUNCTION__
6580		if ($line =~ /\b__FUNCTION__\b/) {
6581			if (WARN("USE_FUNC",
6582				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
6583			    $fix) {
6584				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6585			}
6586		}
6587
6588# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6589		while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6590			ERROR("DATE_TIME",
6591			      "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6592		}
6593
6594# check for use of yield()
6595		if ($line =~ /\byield\s*\(\s*\)/) {
6596			WARN("YIELD",
6597			     "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
6598		}
6599
6600# check for comparisons against true and false
6601		if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6602			my $lead = $1;
6603			my $arg = $2;
6604			my $test = $3;
6605			my $otype = $4;
6606			my $trail = $5;
6607			my $op = "!";
6608
6609			($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6610
6611			my $type = lc($otype);
6612			if ($type =~ /^(?:true|false)$/) {
6613				if (("$test" eq "==" && "$type" eq "true") ||
6614				    ("$test" eq "!=" && "$type" eq "false")) {
6615					$op = "";
6616				}
6617
6618				CHK("BOOL_COMPARISON",
6619				    "Using comparison to $otype is error prone\n" . $herecurr);
6620
6621## maybe suggesting a correct construct would better
6622##				    "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6623
6624			}
6625		}
6626
6627# check for semaphores initialized locked
6628		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6629			WARN("CONSIDER_COMPLETION",
6630			     "consider using a completion\n" . $herecurr);
6631		}
6632
6633# recommend kstrto* over simple_strto* and strict_strto*
6634		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6635			WARN("CONSIDER_KSTRTO",
6636			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
6637		}
6638
6639# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6640		if ($line =~ /^.\s*__initcall\s*\(/) {
6641			WARN("USE_DEVICE_INITCALL",
6642			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6643		}
6644
6645# check for spin_is_locked(), suggest lockdep instead
6646		if ($line =~ /\bspin_is_locked\(/) {
6647			WARN("USE_LOCKDEP",
6648			     "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6649		}
6650
6651# check for deprecated apis
6652		if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6653			my $deprecated_api = $1;
6654			my $new_api = $deprecated_apis{$deprecated_api};
6655			WARN("DEPRECATED_API",
6656			     "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6657		}
6658
6659# check for various structs that are normally const (ops, kgdb, device_tree)
6660# and avoid what seem like struct definitions 'struct foo {'
6661		if (defined($const_structs) &&
6662		    $line !~ /\bconst\b/ &&
6663		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6664			WARN("CONST_STRUCT",
6665			     "struct $1 should normally be const\n" . $herecurr);
6666		}
6667
6668# use of NR_CPUS is usually wrong
6669# ignore definitions of NR_CPUS and usage to define arrays as likely right
6670		if ($line =~ /\bNR_CPUS\b/ &&
6671		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6672		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6673		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6674		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6675		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6676		{
6677			WARN("NR_CPUS",
6678			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6679		}
6680
6681# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6682		if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6683			ERROR("DEFINE_ARCH_HAS",
6684			      "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6685		}
6686
6687# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6688		if ($perl_version_ok &&
6689		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6690			WARN("LIKELY_MISUSE",
6691			     "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6692		}
6693
6694# nested likely/unlikely calls
6695		if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6696			WARN("LIKELY_MISUSE",
6697			     "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6698		}
6699
6700# whine mightly about in_atomic
6701		if ($line =~ /\bin_atomic\s*\(/) {
6702			if ($realfile =~ m@^drivers/@) {
6703				ERROR("IN_ATOMIC",
6704				      "do not use in_atomic in drivers\n" . $herecurr);
6705			} elsif ($realfile !~ m@^kernel/@) {
6706				WARN("IN_ATOMIC",
6707				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6708			}
6709		}
6710
6711# check for mutex_trylock_recursive usage
6712		if ($line =~ /mutex_trylock_recursive/) {
6713			ERROR("LOCKING",
6714			      "recursive locking is bad, do not use this ever.\n" . $herecurr);
6715		}
6716
6717# check for lockdep_set_novalidate_class
6718		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6719		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
6720			if ($realfile !~ m@^kernel/lockdep@ &&
6721			    $realfile !~ m@^include/linux/lockdep@ &&
6722			    $realfile !~ m@^drivers/base/core@) {
6723				ERROR("LOCKDEP",
6724				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6725			}
6726		}
6727
6728		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6729		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6730			WARN("EXPORTED_WORLD_WRITABLE",
6731			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6732		}
6733
6734# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6735# and whether or not function naming is typical and if
6736# DEVICE_ATTR permissions uses are unusual too
6737		if ($perl_version_ok &&
6738		    defined $stat &&
6739		    $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6740			my $var = $1;
6741			my $perms = $2;
6742			my $show = $3;
6743			my $store = $4;
6744			my $octal_perms = perms_to_octal($perms);
6745			if ($show =~ /^${var}_show$/ &&
6746			    $store =~ /^${var}_store$/ &&
6747			    $octal_perms eq "0644") {
6748				if (WARN("DEVICE_ATTR_RW",
6749					 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6750				    $fix) {
6751					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6752				}
6753			} elsif ($show =~ /^${var}_show$/ &&
6754				 $store =~ /^NULL$/ &&
6755				 $octal_perms eq "0444") {
6756				if (WARN("DEVICE_ATTR_RO",
6757					 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6758				    $fix) {
6759					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6760				}
6761			} elsif ($show =~ /^NULL$/ &&
6762				 $store =~ /^${var}_store$/ &&
6763				 $octal_perms eq "0200") {
6764				if (WARN("DEVICE_ATTR_WO",
6765					 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6766				    $fix) {
6767					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6768				}
6769			} elsif ($octal_perms eq "0644" ||
6770				 $octal_perms eq "0444" ||
6771				 $octal_perms eq "0200") {
6772				my $newshow = "$show";
6773				$newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6774				my $newstore = $store;
6775				$newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6776				my $rename = "";
6777				if ($show ne $newshow) {
6778					$rename .= " '$show' to '$newshow'";
6779				}
6780				if ($store ne $newstore) {
6781					$rename .= " '$store' to '$newstore'";
6782				}
6783				WARN("DEVICE_ATTR_FUNCTIONS",
6784				     "Consider renaming function(s)$rename\n" . $herecurr);
6785			} else {
6786				WARN("DEVICE_ATTR_PERMS",
6787				     "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6788			}
6789		}
6790
6791# Mode permission misuses where it seems decimal should be octal
6792# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6793# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6794#   specific definition of not visible in sysfs.
6795# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6796#   use the default permissions
6797		if ($perl_version_ok &&
6798		    defined $stat &&
6799		    $line =~ /$mode_perms_search/) {
6800			foreach my $entry (@mode_permission_funcs) {
6801				my $func = $entry->[0];
6802				my $arg_pos = $entry->[1];
6803
6804				my $lc = $stat =~ tr@\n@@;
6805				$lc = $lc + $linenr;
6806				my $stat_real = get_stat_real($linenr, $lc);
6807
6808				my $skip_args = "";
6809				if ($arg_pos > 1) {
6810					$arg_pos--;
6811					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6812				}
6813				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6814				if ($stat =~ /$test/) {
6815					my $val = $1;
6816					$val = $6 if ($skip_args ne "");
6817					if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6818					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6819					     ($val =~ /^$Octal$/ && length($val) ne 4))) {
6820						ERROR("NON_OCTAL_PERMISSIONS",
6821						      "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6822					}
6823					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6824						ERROR("EXPORTED_WORLD_WRITABLE",
6825						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6826					}
6827				}
6828			}
6829		}
6830
6831# check for uses of S_<PERMS> that could be octal for readability
6832		while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6833			my $oval = $1;
6834			my $octal = perms_to_octal($oval);
6835			if (WARN("SYMBOLIC_PERMS",
6836				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6837			    $fix) {
6838				$fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6839			}
6840		}
6841
6842# validate content of MODULE_LICENSE against list from include/linux/module.h
6843		if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6844			my $extracted_string = get_quoted_string($line, $rawline);
6845			my $valid_licenses = qr{
6846						GPL|
6847						GPL\ v2|
6848						GPL\ and\ additional\ rights|
6849						Dual\ BSD/GPL|
6850						Dual\ MIT/GPL|
6851						Dual\ MPL/GPL|
6852						Proprietary
6853					}x;
6854			if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6855				WARN("MODULE_LICENSE",
6856				     "unknown module license " . $extracted_string . "\n" . $herecurr);
6857			}
6858		}
6859
6860# check for sysctl duplicate constants
6861		if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6862			WARN("DUPLICATED_SYSCTL_CONST",
6863				"duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6864		}
6865	}
6866
6867	# If we have no input at all, then there is nothing to report on
6868	# so just keep quiet.
6869	if ($#rawlines == -1) {
6870		exit(0);
6871	}
6872
6873	# In mailback mode only produce a report in the negative, for
6874	# things that appear to be patches.
6875	if ($mailback && ($clean == 1 || !$is_patch)) {
6876		exit(0);
6877	}
6878
6879	# This is not a patch, and we are are in 'no-patch' mode so
6880	# just keep quiet.
6881	if (!$chk_patch && !$is_patch) {
6882		exit(0);
6883	}
6884
6885	if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6886		ERROR("NOT_UNIFIED_DIFF",
6887		      "Does not appear to be a unified-diff format patch\n");
6888	}
6889	if ($is_patch && $has_commit_log && $chk_signoff) {
6890		if ($signoff == 0) {
6891			ERROR("MISSING_SIGN_OFF",
6892			      "Missing Signed-off-by: line(s)\n");
6893		} elsif (!$authorsignoff) {
6894			WARN("NO_AUTHOR_SIGN_OFF",
6895			     "Missing Signed-off-by: line by nominal patch author '$author'\n");
6896		}
6897	}
6898
6899	print report_dump();
6900	if ($summary && !($clean == 1 && $quiet == 1)) {
6901		print "$filename " if ($summary_file);
6902		print "total: $cnt_error errors, $cnt_warn warnings, " .
6903			(($check)? "$cnt_chk checks, " : "") .
6904			"$cnt_lines lines checked\n";
6905	}
6906
6907	if ($quiet == 0) {
6908		# If there were any defects found and not already fixing them
6909		if (!$clean and !$fix) {
6910			print << "EOM"
6911
6912NOTE: For some of the reported defects, checkpatch may be able to
6913      mechanically convert to the typical style using --fix or --fix-inplace.
6914EOM
6915		}
6916		# If there were whitespace errors which cleanpatch can fix
6917		# then suggest that.
6918		if ($rpt_cleaners) {
6919			$rpt_cleaners = 0;
6920			print << "EOM"
6921
6922NOTE: Whitespace errors detected.
6923      You may wish to use scripts/cleanpatch or scripts/cleanfile
6924EOM
6925		}
6926	}
6927
6928	if ($clean == 0 && $fix &&
6929	    ("@rawlines" ne "@fixed" ||
6930	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6931		my $newfile = $filename;
6932		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6933		my $linecount = 0;
6934		my $f;
6935
6936		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6937
6938		open($f, '>', $newfile)
6939		    or die "$P: Can't open $newfile for write\n";
6940		foreach my $fixed_line (@fixed) {
6941			$linecount++;
6942			if ($file) {
6943				if ($linecount > 3) {
6944					$fixed_line =~ s/^\+//;
6945					print $f $fixed_line . "\n";
6946				}
6947			} else {
6948				print $f $fixed_line . "\n";
6949			}
6950		}
6951		close($f);
6952
6953		if (!$quiet) {
6954			print << "EOM";
6955
6956Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6957
6958Do _NOT_ trust the results written to this file.
6959Do _NOT_ submit these changes without inspecting them for correctness.
6960
6961This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6962No warranties, expressed or implied...
6963EOM
6964		}
6965	}
6966
6967	if ($quiet == 0) {
6968		print "\n";
6969		if ($clean == 1) {
6970			print "$vname has no obvious style problems and is ready for submission.\n";
6971		} else {
6972			print "$vname has style problems, please review.\n";
6973		}
6974	}
6975	return $clean;
6976}
6977