Blame view

scripts/checkpatch.pl 191 KB
6305db960   Heinrich Schuchardt   checkpatch: updat...
1
  #!/usr/bin/env perl
05622191e   Joe Hershberger   tools: checkpatch...
2
3
4
5
6
7
8
  # (c) 2001, Dave Jones. (the file handling bit)
  # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
  # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
  # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
  # Licensed under the terms of the GNU GPL License version 2
  
  use strict;
6305db960   Heinrich Schuchardt   checkpatch: updat...
9
  use warnings;
6b9709d91   Tom Rini   scripts: update c...
10
  use POSIX;
c10e0f5b3   Dan Murphy   checkpatch: Port ...
11
12
  use File::Basename;
  use Cwd 'abs_path';
6305db960   Heinrich Schuchardt   checkpatch: updat...
13
  use Term::ANSIColor qw(:constants);
05622191e   Joe Hershberger   tools: checkpatch...
14
15
  
  my $P = $0;
c10e0f5b3   Dan Murphy   checkpatch: Port ...
16
  my $D = dirname(abs_path($P));
05622191e   Joe Hershberger   tools: checkpatch...
17
18
19
20
21
22
23
24
25
26
27
28
  
  my $V = '0.32';
  
  use Getopt::Long qw(:config no_auto_abbrev);
  
  my $quiet = 0;
  my $tree = 1;
  my $chk_signoff = 1;
  my $chk_patch = 1;
  my $tst_only;
  my $emacs = 0;
  my $terse = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
29
  my $showfile = 0;
05622191e   Joe Hershberger   tools: checkpatch...
30
  my $file = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
31
32
  my $git = 0;
  my %git_commits = ();
05622191e   Joe Hershberger   tools: checkpatch...
33
  my $check = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
34
  my $check_orig = 0;
05622191e   Joe Hershberger   tools: checkpatch...
35
36
37
38
  my $summary = 1;
  my $mailback = 0;
  my $summary_file = 0;
  my $show_types = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
39
  my $list_types = 0;
6b9709d91   Tom Rini   scripts: update c...
40
41
  my $fix = 0;
  my $fix_inplace = 0;
05622191e   Joe Hershberger   tools: checkpatch...
42
43
  my $root;
  my %debug;
6b9709d91   Tom Rini   scripts: update c...
44
45
46
  my %camelcase = ();
  my %use_type = ();
  my @use = ();
05622191e   Joe Hershberger   tools: checkpatch...
47
48
49
50
  my %ignore_type = ();
  my @ignore = ();
  my $help = 0;
  my $configuration_file = ".checkpatch.conf";
d45a6ae24   Kim Phillips   tools: update che...
51
  my $max_line_length = 80;
6b9709d91   Tom Rini   scripts: update c...
52
53
  my $ignore_perl_version = 0;
  my $minimum_perl_version = 5.10.0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
54
  my $min_conf_desc_length = 4;
c10e0f5b3   Dan Murphy   checkpatch: Port ...
55
56
57
  my $spelling_file = "$D/spelling.txt";
  my $codespell = 0;
  my $codespellfile = "/usr/share/codespell/dictionary.txt";
6305db960   Heinrich Schuchardt   checkpatch: updat...
58
59
60
61
  my $conststructsfile = "$D/const_structs.checkpatch";
  my $typedefsfile = "";
  my $color = "auto";
  my $allow_c99_comments = 1;
05622191e   Joe Hershberger   tools: checkpatch...
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
  
  sub help {
  	my ($exitcode) = @_;
  
  	print << "EOM";
  Usage: $P [OPTION]... [FILE]...
  Version: $V
  
  Options:
    -q, --quiet                quiet
    --no-tree                  run without a kernel tree
    --no-signoff               do not check for 'Signed-off-by' line
    --patch                    treat FILE as patchfile (default)
    --emacs                    emacs compile window format
    --terse                    one line per report
6305db960   Heinrich Schuchardt   checkpatch: updat...
77
78
79
80
81
82
83
84
85
86
87
    --showfile                 emit diffed file position, not input file position
    -g, --git                  treat FILE as a single commit or git revision range
                               single git commit with:
                                 <rev>
                                 <rev>^
                                 <rev>~n
                               multiple git commits with:
                                 <rev1>..<rev2>
                                 <rev1>...<rev2>
                                 <rev>-<count>
                               git merges are ignored
05622191e   Joe Hershberger   tools: checkpatch...
88
89
    -f, --file                 treat FILE as regular source file
    --subjective, --strict     enable more subjective tests
6305db960   Heinrich Schuchardt   checkpatch: updat...
90
    --list-types               list the possible message types
6b9709d91   Tom Rini   scripts: update c...
91
    --types TYPE(,TYPE2...)    show only these comma separated message types
05622191e   Joe Hershberger   tools: checkpatch...
92
    --ignore TYPE(,TYPE2...)   ignore various comma separated message types
6305db960   Heinrich Schuchardt   checkpatch: updat...
93
    --show-types               show the specific message type in the output
d45a6ae24   Kim Phillips   tools: update che...
94
    --max-line-length=n        set the maximum line length, if exceeded, warn
6305db960   Heinrich Schuchardt   checkpatch: updat...
95
    --min-conf-desc-length=n   set the min description length, if shorter, warn
05622191e   Joe Hershberger   tools: checkpatch...
96
97
98
99
100
101
102
103
104
    --root=PATH                PATH to the kernel tree root
    --no-summary               suppress the per-file summary
    --mailback                 only produce a report in case of warnings/errors
    --summary-file             include the filename in summary
    --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
                               'values', 'possible', 'type', and 'attr' (default
                               is all off)
    --test-only=WORD           report only warnings/errors containing WORD
                               literally
6b9709d91   Tom Rini   scripts: update c...
105
106
107
108
109
110
111
112
113
114
    --fix                      EXPERIMENTAL - may create horrible results
                               If correctable single-line errors exist, create
                               "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
                               with potential errors corrected to the preferred
                               checkpatch style
    --fix-inplace              EXPERIMENTAL - may create horrible results
                               Is the same as --fix, but overwrites the input
                               file.  It's your fault if there's no backup or git
    --ignore-perl-version      override checking of perl version.  expect
                               runtime errors.
c10e0f5b3   Dan Murphy   checkpatch: Port ...
115
    --codespell                Use the codespell dictionary for spelling/typos
6305db960   Heinrich Schuchardt   checkpatch: updat...
116
                               (default:/usr/share/codespell/dictionary.txt)
c10e0f5b3   Dan Murphy   checkpatch: Port ...
117
    --codespellfile            Use this codespell dictionary
6305db960   Heinrich Schuchardt   checkpatch: updat...
118
119
120
    --typedefsfile             Read additional types from this file
    --color[=WHEN]             Use colors 'always', 'never', or only when output
                               is a terminal ('auto'). Default is 'auto'.
05622191e   Joe Hershberger   tools: checkpatch...
121
122
123
124
125
126
127
    -h, --help, --version      display this help and exit
  
  When FILE is - read standard input.
  EOM
  
  	exit($exitcode);
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
  sub uniq {
  	my %seen;
  	return grep { !$seen{$_}++ } @_;
  }
  
  sub list_types {
  	my ($exitcode) = @_;
  
  	my $count = 0;
  
  	local $/ = undef;
  
  	open(my $script, '<', abs_path($P)) or
  	    die "$P: Can't read '$P' $!
  ";
  
  	my $text = <$script>;
  	close($script);
  
  	my @types = ();
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
148
149
  	# Also catch when type or level is passed through a variable
  	for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
150
151
152
153
154
155
156
157
158
159
160
161
162
  		push (@types, $_);
  	}
  	@types = sort(uniq(@types));
  	print("#\tMessage type
  
  ");
  	foreach my $type (@types) {
  		print(++$count . "\t" . $type . "
  ");
  	}
  
  	exit($exitcode);
  }
05622191e   Joe Hershberger   tools: checkpatch...
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
  my $conf = which_conf($configuration_file);
  if (-f $conf) {
  	my @conf_args;
  	open(my $conffile, '<', "$conf")
  	    or warn "$P: Can't find a readable $configuration_file file $!
  ";
  
  	while (<$conffile>) {
  		my $line = $_;
  
  		$line =~ s/\s*
  ?$//g;
  		$line =~ s/^\s*//g;
  		$line =~ s/\s+/ /g;
  
  		next if ($line =~ m/^\s*#/);
  		next if ($line =~ m/^\s*$/);
  
  		my @words = split(" ", $line);
  		foreach my $word (@words) {
  			last if ($word =~ m/^#/);
  			push (@conf_args, $word);
  		}
  	}
  	close($conffile);
  	unshift(@ARGV, @conf_args) if @conf_args;
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
190
191
192
193
194
195
196
  # Perl's Getopt::Long allows options to take optional arguments after a space.
  # Prevent --color by itself from consuming other arguments
  foreach (@ARGV) {
  	if ($_ eq "--color" || $_ eq "-color") {
  		$_ = "--color=$color";
  	}
  }
05622191e   Joe Hershberger   tools: checkpatch...
197
198
199
200
201
202
203
  GetOptions(
  	'q|quiet+'	=> \$quiet,
  	'tree!'		=> \$tree,
  	'signoff!'	=> \$chk_signoff,
  	'patch!'	=> \$chk_patch,
  	'emacs!'	=> \$emacs,
  	'terse!'	=> \$terse,
6305db960   Heinrich Schuchardt   checkpatch: updat...
204
  	'showfile!'	=> \$showfile,
05622191e   Joe Hershberger   tools: checkpatch...
205
  	'f|file!'	=> \$file,
6305db960   Heinrich Schuchardt   checkpatch: updat...
206
  	'g|git!'	=> \$git,
05622191e   Joe Hershberger   tools: checkpatch...
207
208
209
  	'subjective!'	=> \$check,
  	'strict!'	=> \$check,
  	'ignore=s'	=> \@ignore,
6b9709d91   Tom Rini   scripts: update c...
210
  	'types=s'	=> \@use,
05622191e   Joe Hershberger   tools: checkpatch...
211
  	'show-types!'	=> \$show_types,
6305db960   Heinrich Schuchardt   checkpatch: updat...
212
  	'list-types!'	=> \$list_types,
d45a6ae24   Kim Phillips   tools: update che...
213
  	'max-line-length=i' => \$max_line_length,
6305db960   Heinrich Schuchardt   checkpatch: updat...
214
  	'min-conf-desc-length=i' => \$min_conf_desc_length,
05622191e   Joe Hershberger   tools: checkpatch...
215
216
217
218
  	'root=s'	=> \$root,
  	'summary!'	=> \$summary,
  	'mailback!'	=> \$mailback,
  	'summary-file!'	=> \$summary_file,
6b9709d91   Tom Rini   scripts: update c...
219
220
221
  	'fix!'		=> \$fix,
  	'fix-inplace!'	=> \$fix_inplace,
  	'ignore-perl-version!' => \$ignore_perl_version,
05622191e   Joe Hershberger   tools: checkpatch...
222
223
  	'debug=s'	=> \%debug,
  	'test-only=s'	=> \$tst_only,
6305db960   Heinrich Schuchardt   checkpatch: updat...
224
225
226
227
228
229
  	'codespell!'	=> \$codespell,
  	'codespellfile=s'	=> \$codespellfile,
  	'typedefsfile=s'	=> \$typedefsfile,
  	'color=s'	=> \$color,
  	'no-color'	=> \$color,	#keep old behaviors of -nocolor
  	'nocolor'	=> \$color,	#keep old behaviors of -nocolor
05622191e   Joe Hershberger   tools: checkpatch...
230
231
232
233
234
  	'h|help'	=> \$help,
  	'version'	=> \$help
  ) or help(1);
  
  help(0) if ($help);
6305db960   Heinrich Schuchardt   checkpatch: updat...
235
  list_types(0) if ($list_types);
6b9709d91   Tom Rini   scripts: update c...
236
  $fix = 1 if ($fix_inplace);
6305db960   Heinrich Schuchardt   checkpatch: updat...
237
  $check_orig = $check;
6b9709d91   Tom Rini   scripts: update c...
238

05622191e   Joe Hershberger   tools: checkpatch...
239
  my $exit = 0;
6b9709d91   Tom Rini   scripts: update c...
240
241
242
243
244
245
246
  if ($^V && $^V lt $minimum_perl_version) {
  	printf "$P: requires at least perl version %vd
  ", $minimum_perl_version;
  	if (!$ignore_perl_version) {
  		exit(1);
  	}
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
247
  #if no filenames are given, push '-' to read patch from stdin
05622191e   Joe Hershberger   tools: checkpatch...
248
  if ($#ARGV < 0) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
249
250
251
252
253
254
255
256
257
258
259
260
261
262
  	push(@ARGV, '-');
  }
  
  if ($color =~ /^[01]$/) {
  	$color = !$color;
  } elsif ($color =~ /^always$/i) {
  	$color = 1;
  } elsif ($color =~ /^never$/i) {
  	$color = 0;
  } elsif ($color =~ /^auto$/i) {
  	$color = (-t STDOUT);
  } else {
  	die "Invalid color mode: $color
  ";
05622191e   Joe Hershberger   tools: checkpatch...
263
  }
6b9709d91   Tom Rini   scripts: update c...
264
265
  sub hash_save_array_words {
  	my ($hashRef, $arrayRef) = @_;
05622191e   Joe Hershberger   tools: checkpatch...
266

6b9709d91   Tom Rini   scripts: update c...
267
268
269
270
271
272
273
  	my @array = split(/,/, join(',', @$arrayRef));
  	foreach my $word (@array) {
  		$word =~ s/\s*
  ?$//g;
  		$word =~ s/^\s*//g;
  		$word =~ s/\s+/ /g;
  		$word =~ tr/[a-z]/[A-Z]/;
05622191e   Joe Hershberger   tools: checkpatch...
274

6b9709d91   Tom Rini   scripts: update c...
275
276
277
278
279
  		next if ($word =~ m/^\s*#/);
  		next if ($word =~ m/^\s*$/);
  
  		$hashRef->{$word}++;
  	}
05622191e   Joe Hershberger   tools: checkpatch...
280
  }
6b9709d91   Tom Rini   scripts: update c...
281
282
  sub hash_show_words {
  	my ($hashRef, $prefix) = @_;
6305db960   Heinrich Schuchardt   checkpatch: updat...
283
284
285
  	if (keys %$hashRef) {
  		print "
  NOTE: $prefix message types:";
6b9709d91   Tom Rini   scripts: update c...
286
287
288
  		foreach my $word (sort keys %$hashRef) {
  			print " $word";
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
289
290
  		print "
  ";
6b9709d91   Tom Rini   scripts: update c...
291
292
293
294
295
  	}
  }
  
  hash_save_array_words(\%ignore_type, \@ignore);
  hash_save_array_words(\%use_type, \@use);
05622191e   Joe Hershberger   tools: checkpatch...
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
  my $dbg_values = 0;
  my $dbg_possible = 0;
  my $dbg_type = 0;
  my $dbg_attr = 0;
  for my $key (keys %debug) {
  	## no critic
  	eval "\${dbg_$key} = '$debug{$key}';";
  	die "$@" if ($@);
  }
  
  my $rpt_cleaners = 0;
  
  if ($terse) {
  	$emacs = 1;
  	$quiet++;
  }
  
  if ($tree) {
  	if (defined $root) {
  		if (!top_of_kernel_tree($root)) {
  			die "$P: $root: --root does not point at a valid tree
  ";
  		}
  	} else {
  		if (top_of_kernel_tree('.')) {
  			$root = '.';
  		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
  						top_of_kernel_tree($1)) {
  			$root = $1;
  		}
  	}
  
  	if (!defined $root) {
  		print "Must be run from the top-level dir. of a kernel tree
  ";
  		exit(2);
  	}
  }
  
  my $emitted_corrupt = 0;
  
  our $Ident	= qr{
  			[A-Za-z_][A-Za-z\d_]*
  			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
  		}x;
  our $Storage	= qr{extern|static|asmlinkage};
  our $Sparse	= qr{
  			__user|
  			__kernel|
  			__force|
  			__iomem|
  			__must_check|
  			__init_refok|
  			__kprobes|
  			__ref|
6305db960   Heinrich Schuchardt   checkpatch: updat...
351
352
  			__rcu|
  			__private
05622191e   Joe Hershberger   tools: checkpatch...
353
  		}x;
6b9709d91   Tom Rini   scripts: update c...
354
355
356
357
358
  our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
  our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
  our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
  our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
  our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
05622191e   Joe Hershberger   tools: checkpatch...
359
360
361
362
363
364
365
366
  
  # Notes to $Attribute:
  # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
  our $Attribute	= qr{
  			const|
  			__percpu|
  			__nocast|
  			__safe|
6305db960   Heinrich Schuchardt   checkpatch: updat...
367
  			__bitwise|
05622191e   Joe Hershberger   tools: checkpatch...
368
369
370
371
372
373
374
375
  			__packed__|
  			__packed2__|
  			__naked|
  			__maybe_unused|
  			__always_unused|
  			__noreturn|
  			__used|
  			__cold|
6305db960   Heinrich Schuchardt   checkpatch: updat...
376
  			__pure|
05622191e   Joe Hershberger   tools: checkpatch...
377
378
379
380
  			__noclone|
  			__deprecated|
  			__read_mostly|
  			__kprobes|
6b9709d91   Tom Rini   scripts: update c...
381
  			$InitAttribute|
05622191e   Joe Hershberger   tools: checkpatch...
382
383
384
385
386
387
  			____cacheline_aligned|
  			____cacheline_aligned_in_smp|
  			____cacheline_internodealigned_in_smp|
  			__weak
  		  }x;
  our $Modifier;
6305db960   Heinrich Schuchardt   checkpatch: updat...
388
  our $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
05622191e   Joe Hershberger   tools: checkpatch...
389
390
  our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
  our $Lval	= qr{$Ident(?:$Member)*};
6b9709d91   Tom Rini   scripts: update c...
391
392
393
394
  our $Int_type	= qr{(?i)llu|ull|ll|lu|ul|l|u};
  our $Binary	= qr{(?i)0b[01]+$Int_type?};
  our $Hex	= qr{(?i)0x[0-9a-f]+$Int_type?};
  our $Int	= qr{[0-9]+$Int_type?};
6305db960   Heinrich Schuchardt   checkpatch: updat...
395
  our $Octal	= qr{0[0-7]+$Int_type?};
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
396
  our $String	= qr{"[X\t]*"};
d45a6ae24   Kim Phillips   tools: update che...
397
398
399
400
  our $Float_hex	= qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
  our $Float_dec	= qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
  our $Float_int	= qr{(?i)[0-9]+e-?[0-9]+[fl]?};
  our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
6305db960   Heinrich Schuchardt   checkpatch: updat...
401
  our $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
d45a6ae24   Kim Phillips   tools: update che...
402
  our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
6305db960   Heinrich Schuchardt   checkpatch: updat...
403
  our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
6b9709d91   Tom Rini   scripts: update c...
404
  our $Arithmetic = qr{\+|-|\*|\/|%};
05622191e   Joe Hershberger   tools: checkpatch...
405
406
407
  our $Operators	= qr{
  			<=|>=|==|!=|
  			=>|->|<<|>>|<|>|!|~|
6b9709d91   Tom Rini   scripts: update c...
408
  			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
05622191e   Joe Hershberger   tools: checkpatch...
409
  		  }x;
6305db960   Heinrich Schuchardt   checkpatch: updat...
410
411
412
  our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
  
  our $BasicType;
05622191e   Joe Hershberger   tools: checkpatch...
413
  our $NonptrType;
6305db960   Heinrich Schuchardt   checkpatch: updat...
414
  our $NonptrTypeMisordered;
6b9709d91   Tom Rini   scripts: update c...
415
  our $NonptrTypeWithAttr;
05622191e   Joe Hershberger   tools: checkpatch...
416
  our $Type;
6305db960   Heinrich Schuchardt   checkpatch: updat...
417
  our $TypeMisordered;
05622191e   Joe Hershberger   tools: checkpatch...
418
  our $Declare;
6305db960   Heinrich Schuchardt   checkpatch: updat...
419
  our $DeclareMisordered;
05622191e   Joe Hershberger   tools: checkpatch...
420

d45a6ae24   Kim Phillips   tools: update che...
421
422
  our $NON_ASCII_UTF8	= qr{
  	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
05622191e   Joe Hershberger   tools: checkpatch...
423
424
425
426
427
428
429
  	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
  	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
  	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
  	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
  	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
  	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
  }x;
d45a6ae24   Kim Phillips   tools: update che...
430
431
432
433
  our $UTF8	= qr{
  	[\x09\x0A\x0D\x20-\x7E]              # ASCII
  	| $NON_ASCII_UTF8
  }x;
6305db960   Heinrich Schuchardt   checkpatch: updat...
434
435
436
437
438
439
  our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
  our $typeOtherOSTypedefs = qr{(?x:
  	u_(?:char|short|int|long) |          # bsd
  	u(?:nchar|short|int|long)            # sysv
  )};
  our $typeKernelTypedefs = qr{(?x:
05622191e   Joe Hershberger   tools: checkpatch...
440
441
442
  	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
  	atomic_t
  )};
6305db960   Heinrich Schuchardt   checkpatch: updat...
443
444
445
446
447
448
449
  our $typeTypedefs = qr{(?x:
  	$typeC99Typedefs\b|
  	$typeOtherOSTypedefs\b|
  	$typeKernelTypedefs\b
  )};
  
  our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
05622191e   Joe Hershberger   tools: checkpatch...
450
451
  
  our $logFunctions = qr{(?x:
6305db960   Heinrich Schuchardt   checkpatch: updat...
452
  	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
6b9709d91   Tom Rini   scripts: update c...
453
  	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
454
  	TP_printk|
05622191e   Joe Hershberger   tools: checkpatch...
455
456
  	WARN(?:_RATELIMIT|_ONCE|)|
  	panic|
6b9709d91   Tom Rini   scripts: update c...
457
458
  	MODULE_[A-Z_]+|
  	seq_vprintf|seq_printf|seq_puts
05622191e   Joe Hershberger   tools: checkpatch...
459
460
461
462
463
464
465
466
  )};
  
  our $signature_tags = qr{(?xi:
  	Signed-off-by:|
  	Acked-by:|
  	Tested-by:|
  	Reviewed-by:|
  	Reported-by:|
6b9709d91   Tom Rini   scripts: update c...
467
  	Suggested-by:|
05622191e   Joe Hershberger   tools: checkpatch...
468
469
470
  	To:|
  	Cc:
  )};
6305db960   Heinrich Schuchardt   checkpatch: updat...
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
  our @typeListMisordered = (
  	qr{char\s+(?:un)?signed},
  	qr{int\s+(?:(?:un)?signed\s+)?short\s},
  	qr{int\s+short(?:\s+(?:un)?signed)},
  	qr{short\s+int(?:\s+(?:un)?signed)},
  	qr{(?:un)?signed\s+int\s+short},
  	qr{short\s+(?:un)?signed},
  	qr{long\s+int\s+(?:un)?signed},
  	qr{int\s+long\s+(?:un)?signed},
  	qr{long\s+(?:un)?signed\s+int},
  	qr{int\s+(?:un)?signed\s+long},
  	qr{int\s+(?:un)?signed},
  	qr{int\s+long\s+long\s+(?:un)?signed},
  	qr{long\s+long\s+int\s+(?:un)?signed},
  	qr{long\s+long\s+(?:un)?signed\s+int},
  	qr{long\s+long\s+(?:un)?signed},
  	qr{long\s+(?:un)?signed},
  );
05622191e   Joe Hershberger   tools: checkpatch...
489
490
  our @typeList = (
  	qr{void},
6305db960   Heinrich Schuchardt   checkpatch: updat...
491
492
493
494
495
496
497
498
499
  	qr{(?:(?:un)?signed\s+)?char},
  	qr{(?:(?:un)?signed\s+)?short\s+int},
  	qr{(?:(?:un)?signed\s+)?short},
  	qr{(?:(?:un)?signed\s+)?int},
  	qr{(?:(?:un)?signed\s+)?long\s+int},
  	qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
  	qr{(?:(?:un)?signed\s+)?long\s+long},
  	qr{(?:(?:un)?signed\s+)?long},
  	qr{(?:un)?signed},
05622191e   Joe Hershberger   tools: checkpatch...
500
501
502
503
504
505
506
507
508
  	qr{float},
  	qr{double},
  	qr{bool},
  	qr{struct\s+$Ident},
  	qr{union\s+$Ident},
  	qr{enum\s+$Ident},
  	qr{${Ident}_t},
  	qr{${Ident}_handler},
  	qr{${Ident}_handler_fn},
6305db960   Heinrich Schuchardt   checkpatch: updat...
509
  	@typeListMisordered,
05622191e   Joe Hershberger   tools: checkpatch...
510
  );
6305db960   Heinrich Schuchardt   checkpatch: updat...
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
  
  our $C90_int_types = qr{(?x:
  	long\s+long\s+int\s+(?:un)?signed|
  	long\s+long\s+(?:un)?signed\s+int|
  	long\s+long\s+(?:un)?signed|
  	(?:(?:un)?signed\s+)?long\s+long\s+int|
  	(?:(?:un)?signed\s+)?long\s+long|
  	int\s+long\s+long\s+(?:un)?signed|
  	int\s+(?:(?:un)?signed\s+)?long\s+long|
  
  	long\s+int\s+(?:un)?signed|
  	long\s+(?:un)?signed\s+int|
  	long\s+(?:un)?signed|
  	(?:(?:un)?signed\s+)?long\s+int|
  	(?:(?:un)?signed\s+)?long|
  	int\s+long\s+(?:un)?signed|
  	int\s+(?:(?:un)?signed\s+)?long|
  
  	int\s+(?:un)?signed|
  	(?:(?:un)?signed\s+)?int
  )};
  
  our @typeListFile = ();
6b9709d91   Tom Rini   scripts: update c...
534
535
536
537
538
  our @typeListWithAttr = (
  	@typeList,
  	qr{struct\s+$InitAttribute\s+$Ident},
  	qr{union\s+$InitAttribute\s+$Ident},
  );
05622191e   Joe Hershberger   tools: checkpatch...
539
540
541
  our @modifierList = (
  	qr{fastcall},
  );
6305db960   Heinrich Schuchardt   checkpatch: updat...
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
  our @modifierListFile = ();
  
  our @mode_permission_funcs = (
  	["module_param", 3],
  	["module_param_(?:array|named|string)", 4],
  	["module_param_array_named", 5],
  	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
  	["proc_create(?:_data|)", 2],
  	["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
  	["IIO_DEV_ATTR_[A-Z_]+", 1],
  	["SENSOR_(?:DEVICE_|)ATTR_2", 2],
  	["SENSOR_TEMPLATE(?:_2|)", 3],
  	["__ATTR", 2],
  );
  
  #Create a search pattern for all these functions to speed up a loop below
  our $mode_perms_search = "";
  foreach my $entry (@mode_permission_funcs) {
  	$mode_perms_search .= '|' if ($mode_perms_search ne "");
  	$mode_perms_search .= $entry->[0];
  }
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
563
  $mode_perms_search = "(?:${mode_perms_search})";
6305db960   Heinrich Schuchardt   checkpatch: updat...
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
  
  our $mode_perms_world_writable = qr{
  	S_IWUGO		|
  	S_IWOTH		|
  	S_IRWXUGO	|
  	S_IALLUGO	|
  	0[0-7][0-7][2367]
  }x;
  
  our %mode_permission_string_types = (
  	"S_IRWXU" => 0700,
  	"S_IRUSR" => 0400,
  	"S_IWUSR" => 0200,
  	"S_IXUSR" => 0100,
  	"S_IRWXG" => 0070,
  	"S_IRGRP" => 0040,
  	"S_IWGRP" => 0020,
  	"S_IXGRP" => 0010,
  	"S_IRWXO" => 0007,
  	"S_IROTH" => 0004,
  	"S_IWOTH" => 0002,
  	"S_IXOTH" => 0001,
  	"S_IRWXUGO" => 0777,
  	"S_IRUGO" => 0444,
  	"S_IWUGO" => 0222,
  	"S_IXUGO" => 0111,
  );
  
  #Create a search pattern for all these strings to speed up a loop below
  our $mode_perms_string_search = "";
  foreach my $entry (keys %mode_permission_string_types) {
  	$mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
  	$mode_perms_string_search .= $entry;
  }
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
  our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
  our $multi_mode_perms_string_search = qr{
  	${single_mode_perms_string_search}
  	(?:\s*\|\s*${single_mode_perms_string_search})*
  }x;
  
  sub perms_to_octal {
  	my ($string) = @_;
  
  	return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
  
  	my $val = "";
  	my $oval = "";
  	my $to = 0;
  	my $curpos = 0;
  	my $lastpos = 0;
  	while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
  		$curpos = pos($string);
  		my $match = $2;
  		my $omatch = $1;
  		last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
  		$lastpos = $curpos;
  		$to |= $mode_permission_string_types{$match};
  		$val .= '\s*\|\s*' if ($val ne "");
  		$val .= $match;
  		$oval .= $omatch;
  	}
  	$oval =~ s/^\s*\|\s*//;
  	$oval =~ s/\s*\|\s*$//;
  	return sprintf("%04o", $to);
  }
05622191e   Joe Hershberger   tools: checkpatch...
629
630
631
  
  our $allowed_asm_includes = qr{(?x:
  	irq|
6305db960   Heinrich Schuchardt   checkpatch: updat...
632
633
634
  	memory|
  	time|
  	reboot
05622191e   Joe Hershberger   tools: checkpatch...
635
636
  )};
  # memory.h: ARM has a custom one
c10e0f5b3   Dan Murphy   checkpatch: Port ...
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
  # Load common spelling mistakes and build regular expression list.
  my $misspellings;
  my %spelling_fix;
  
  if (open(my $spelling, '<', $spelling_file)) {
  	while (<$spelling>) {
  		my $line = $_;
  
  		$line =~ s/\s*
  ?$//g;
  		$line =~ s/^\s*//g;
  
  		next if ($line =~ m/^\s*#/);
  		next if ($line =~ m/^\s*$/);
  
  		my ($suspect, $fix) = split(/\|\|/, $line);
  
  		$spelling_fix{$suspect} = $fix;
  	}
  	close($spelling);
  } else {
  	warn "No typos will be found - file '$spelling_file': $!
  ";
  }
  
  if ($codespell) {
  	if (open(my $spelling, '<', $codespellfile)) {
  		while (<$spelling>) {
  			my $line = $_;
  
  			$line =~ s/\s*
  ?$//g;
  			$line =~ s/^\s*//g;
  
  			next if ($line =~ m/^\s*#/);
  			next if ($line =~ m/^\s*$/);
  			next if ($line =~ m/, disabled/i);
  
  			$line =~ s/,.*$//;
  
  			my ($suspect, $fix) = split(/->/, $line);
  
  			$spelling_fix{$suspect} = $fix;
  		}
  		close($spelling);
  	} else {
  		warn "No codespell typos will be found - file '$codespellfile': $!
  ";
  	}
  }
  
  $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
6305db960   Heinrich Schuchardt   checkpatch: updat...
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
  sub read_words {
  	my ($wordsRef, $file) = @_;
  
  	if (open(my $words, '<', $file)) {
  		while (<$words>) {
  			my $line = $_;
  
  			$line =~ s/\s*
  ?$//g;
  			$line =~ s/^\s*//g;
  
  			next if ($line =~ m/^\s*#/);
  			next if ($line =~ m/^\s*$/);
  			if ($line =~ /\s/) {
  				print("$file: '$line' invalid - ignored
  ");
  				next;
  			}
  
  			$$wordsRef .= '|' if ($$wordsRef ne "");
  			$$wordsRef .= $line;
  		}
  		close($file);
  		return 1;
  	}
  
  	return 0;
  }
  
  my $const_structs = "";
  read_words(\$const_structs, $conststructsfile)
      or warn "No structs that should be const will be found - file '$conststructsfile': $!
  ";
  
  my $typeOtherTypedefs = "";
  if (length($typedefsfile)) {
  	read_words(\$typeOtherTypedefs, $typedefsfile)
  	    or warn "No additional types will be considered - file '$typedefsfile': $!
  ";
  }
  $typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
c10e0f5b3   Dan Murphy   checkpatch: Port ...
730

05622191e   Joe Hershberger   tools: checkpatch...
731
  sub build_types {
6305db960   Heinrich Schuchardt   checkpatch: updat...
732
733
734
735
736
737
738
739
740
741
742
743
  	my $mods = "(?x:  
  " . join("|
    ", (@modifierList, @modifierListFile)) . "
  )";
  	my $all = "(?x:  
  " . join("|
    ", (@typeList, @typeListFile)) . "
  )";
  	my $Misordered = "(?x:  
  " . join("|
    ", @typeListMisordered) . "
  )";
6b9709d91   Tom Rini   scripts: update c...
744
745
746
747
  	my $allWithAttr = "(?x:  
  " . join("|
    ", @typeListWithAttr) . "
  )";
05622191e   Joe Hershberger   tools: checkpatch...
748
  	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
6305db960   Heinrich Schuchardt   checkpatch: updat...
749
750
751
752
  	$BasicType	= qr{
  				(?:$typeTypedefs\b)|
  				(?:${all}\b)
  		}x;
05622191e   Joe Hershberger   tools: checkpatch...
753
754
755
  	$NonptrType	= qr{
  			(?:$Modifier\s+|const\s+)*
  			(?:
d45a6ae24   Kim Phillips   tools: update che...
756
  				(?:typeof|__typeof__)\s*\([^\)]*\)|
05622191e   Joe Hershberger   tools: checkpatch...
757
758
759
760
761
  				(?:$typeTypedefs\b)|
  				(?:${all}\b)
  			)
  			(?:\s+$Modifier|\s+const)*
  		  }x;
6305db960   Heinrich Schuchardt   checkpatch: updat...
762
763
764
765
766
767
768
  	$NonptrTypeMisordered	= qr{
  			(?:$Modifier\s+|const\s+)*
  			(?:
  				(?:${Misordered}\b)
  			)
  			(?:\s+$Modifier|\s+const)*
  		  }x;
6b9709d91   Tom Rini   scripts: update c...
769
770
771
772
773
774
775
776
777
  	$NonptrTypeWithAttr	= qr{
  			(?:$Modifier\s+|const\s+)*
  			(?:
  				(?:typeof|__typeof__)\s*\([^\)]*\)|
  				(?:$typeTypedefs\b)|
  				(?:${allWithAttr}\b)
  			)
  			(?:\s+$Modifier|\s+const)*
  		  }x;
05622191e   Joe Hershberger   tools: checkpatch...
778
779
  	$Type	= qr{
  			$NonptrType
6305db960   Heinrich Schuchardt   checkpatch: updat...
780
781
782
783
784
785
  			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
  			(?:\s+$Inline|\s+$Modifier)*
  		  }x;
  	$TypeMisordered	= qr{
  			$NonptrTypeMisordered
  			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
05622191e   Joe Hershberger   tools: checkpatch...
786
787
  			(?:\s+$Inline|\s+$Modifier)*
  		  }x;
6305db960   Heinrich Schuchardt   checkpatch: updat...
788
789
  	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
  	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
05622191e   Joe Hershberger   tools: checkpatch...
790
791
  }
  build_types();
05622191e   Joe Hershberger   tools: checkpatch...
792
  our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
d45a6ae24   Kim Phillips   tools: update che...
793
794
795
796
797
798
  
  # Using $balanced_parens, $LvalOrFunc, or $FuncArg
  # requires at least perl version v5.10.0
  # Any use must be runtime checked with $^V
  
  our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
6305db960   Heinrich Schuchardt   checkpatch: updat...
799
800
801
802
803
804
  our $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
  our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
  
  our $declaration_macros = qr{(?x:
  	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
  	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
805
806
  	(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
  	(?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
6305db960   Heinrich Schuchardt   checkpatch: updat...
807
  )};
05622191e   Joe Hershberger   tools: checkpatch...
808
809
810
811
  
  sub deparenthesize {
  	my ($string) = @_;
  	return "" if (!defined($string));
6305db960   Heinrich Schuchardt   checkpatch: updat...
812
813
814
815
816
  
  	while ($string =~ /^\s*\(.*\)\s*$/) {
  		$string =~ s@^\s*\(\s*@@;
  		$string =~ s@\s*\)\s*$@@;
  	}
05622191e   Joe Hershberger   tools: checkpatch...
817
  	$string =~ s@\s+@ @g;
6305db960   Heinrich Schuchardt   checkpatch: updat...
818

05622191e   Joe Hershberger   tools: checkpatch...
819
820
  	return $string;
  }
6b9709d91   Tom Rini   scripts: update c...
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
  sub seed_camelcase_file {
  	my ($file) = @_;
  
  	return if (!(-f $file));
  
  	local $/;
  
  	open(my $include_file, '<', "$file")
  	    or warn "$P: Can't read '$file' $!
  ";
  	my $text = <$include_file>;
  	close($include_file);
  
  	my @lines = split('
  ', $text);
  
  	foreach my $line (@lines) {
  		next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
  		if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
  			$camelcase{$1} = 1;
  		} elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
  			$camelcase{$1} = 1;
  		} elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
  			$camelcase{$1} = 1;
  		}
  	}
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
848
849
850
851
852
853
854
855
856
  sub is_maintained_obsolete {
  	my ($filename) = @_;
  
  	return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
  
  	my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
  
  	return $status =~ /obsolete/i;
  }
6b9709d91   Tom Rini   scripts: update c...
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
  my $camelcase_seeded = 0;
  sub seed_camelcase_includes {
  	return if ($camelcase_seeded);
  
  	my $files;
  	my $camelcase_cache = "";
  	my @include_files = ();
  
  	$camelcase_seeded = 1;
  
  	if (-e ".git") {
  		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
  		chomp $git_last_include_commit;
  		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
  	} else {
  		my $last_mod_date = 0;
  		$files = `find $root/include -name "*.h"`;
  		@include_files = split('
  ', $files);
  		foreach my $file (@include_files) {
  			my $date = POSIX::strftime("%Y%m%d%H%M",
  						   localtime((stat $file)[9]));
  			$last_mod_date = $date if ($last_mod_date < $date);
  		}
  		$camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
  	}
  
  	if ($camelcase_cache ne "" && -f $camelcase_cache) {
  		open(my $camelcase_file, '<', "$camelcase_cache")
  		    or warn "$P: Can't read '$camelcase_cache' $!
  ";
  		while (<$camelcase_file>) {
  			chomp;
  			$camelcase{$_} = 1;
  		}
  		close($camelcase_file);
  
  		return;
  	}
  
  	if (-e ".git") {
  		$files = `git ls-files "include/*.h"`;
  		@include_files = split('
  ', $files);
  	}
  
  	foreach my $file (@include_files) {
  		seed_camelcase_file($file);
  	}
  
  	if ($camelcase_cache ne "") {
  		unlink glob ".checkpatch-camelcase.*";
  		open(my $camelcase_file, '>', "$camelcase_cache")
  		    or warn "$P: Can't write '$camelcase_cache' $!
  ";
  		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
  			print $camelcase_file ("$_
  ");
  		}
  		close($camelcase_file);
  	}
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
  sub git_commit_info {
  	my ($commit, $id, $desc) = @_;
  
  	return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
  
  	my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
  	$output =~ s/^\s*//gm;
  	my @lines = split("
  ", $output);
  
  	return ($id, $desc) if ($#lines < 0);
  
  	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
  # Maybe one day convert this block of bash into something that returns
  # all matching commit ids, but it's very slow...
  #
  #		echo "checking commits $1..."
  #		git rev-list --remotes | grep -i "^$1" |
  #		while read line ; do
  #		    git log --format='%H %s' -1 $line |
  #		    echo "commit $(cut -c 1-12,41-)"
  #		done
  	} elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
  		$id = undef;
  	} else {
  		$id = substr($lines[0], 0, 12);
  		$desc = substr($lines[0], 41);
  	}
  
  	return ($id, $desc);
  }
05622191e   Joe Hershberger   tools: checkpatch...
950
  $chk_signoff = 0 if ($file);
05622191e   Joe Hershberger   tools: checkpatch...
951
952
  my @rawlines = ();
  my @lines = ();
6b9709d91   Tom Rini   scripts: update c...
953
  my @fixed = ();
6305db960   Heinrich Schuchardt   checkpatch: updat...
954
955
  my @fixed_inserted = ();
  my @fixed_deleted = ();
c10e0f5b3   Dan Murphy   checkpatch: Port ...
956
  my $fixlinenr = -1;
6305db960   Heinrich Schuchardt   checkpatch: updat...
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
  # If input is git commits, extract all commits from the commit expressions.
  # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
  die "$P: No git repository found
  " if ($git && !-e ".git");
  
  if ($git) {
  	my @commits = ();
  	foreach my $commit_expr (@ARGV) {
  		my $git_range;
  		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
  			$git_range = "-$2 $1";
  		} elsif ($commit_expr =~ m/\.\./) {
  			$git_range = "$commit_expr";
  		} else {
  			$git_range = "-1 $commit_expr";
  		}
  		my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
  		foreach my $line (split(/
  /, $lines)) {
  			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
  			next if (!defined($1) || !defined($2));
  			my $sha1 = $1;
  			my $subject = $2;
  			unshift(@commits, $sha1);
  			$git_commits{$sha1} = $subject;
  		}
  	}
  	die "$P: no git commits after extraction!
  " if (@commits == 0);
  	@ARGV = @commits;
  }
  
  my $vname;
05622191e   Joe Hershberger   tools: checkpatch...
990
991
  for my $filename (@ARGV) {
  	my $FILE;
6305db960   Heinrich Schuchardt   checkpatch: updat...
992
993
994
995
996
  	if ($git) {
  		open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
  			die "$P: $filename: git format-patch failed - $!
  ";
  	} elsif ($file) {
05622191e   Joe Hershberger   tools: checkpatch...
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
  		open($FILE, '-|', "diff -u /dev/null $filename") ||
  			die "$P: $filename: diff failed - $!
  ";
  	} elsif ($filename eq '-') {
  		open($FILE, '<&STDIN');
  	} else {
  		open($FILE, '<', "$filename") ||
  			die "$P: $filename: open failed - $!
  ";
  	}
  	if ($filename eq '-') {
  		$vname = 'Your patch';
6305db960   Heinrich Schuchardt   checkpatch: updat...
1009
1010
  	} elsif ($git) {
  		$vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
05622191e   Joe Hershberger   tools: checkpatch...
1011
1012
1013
1014
1015
1016
1017
1018
  	} else {
  		$vname = $filename;
  	}
  	while (<$FILE>) {
  		chomp;
  		push(@rawlines, $_);
  	}
  	close($FILE);
6305db960   Heinrich Schuchardt   checkpatch: updat...
1019
1020
1021
1022
1023
1024
1025
1026
1027
  
  	if ($#ARGV > 0 && $quiet == 0) {
  		print '-' x length($vname) . "
  ";
  		print "$vname
  ";
  		print '-' x length($vname) . "
  ";
  	}
05622191e   Joe Hershberger   tools: checkpatch...
1028
1029
1030
1031
1032
  	if (!process($filename)) {
  		$exit = 1;
  	}
  	@rawlines = ();
  	@lines = ();
6b9709d91   Tom Rini   scripts: update c...
1033
  	@fixed = ();
6305db960   Heinrich Schuchardt   checkpatch: updat...
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
  	@fixed_inserted = ();
  	@fixed_deleted = ();
  	$fixlinenr = -1;
  	@modifierListFile = ();
  	@typeListFile = ();
  	build_types();
  }
  
  if (!$quiet) {
  	hash_show_words(\%use_type, "Used");
  	hash_show_words(\%ignore_type, "Ignored");
  
  	if ($^V lt 5.10.0) {
  		print << "EOM"
  
  NOTE: perl $^V is not modern enough to detect all possible issues.
        An upgrade to at least perl v5.10.0 is suggested.
  EOM
  	}
  	if ($exit) {
  		print << "EOM"
  
  NOTE: If any of the errors are false positives, please report
        them to the maintainer, see CHECKPATCH in MAINTAINERS.
  EOM
  	}
05622191e   Joe Hershberger   tools: checkpatch...
1060
1061
1062
1063
1064
1065
1066
1067
  }
  
  exit($exit);
  
  sub top_of_kernel_tree {
  	my ($root) = @_;
  
  	my @tree_check = (
6b9709d91   Tom Rini   scripts: update c...
1068
  		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
05622191e   Joe Hershberger   tools: checkpatch...
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
  		"README", "Documentation", "arch", "include", "drivers",
  		"fs", "init", "ipc", "kernel", "lib", "scripts",
  	);
  
  	foreach my $check (@tree_check) {
  		if (! -e $root . '/' . $check) {
  			return 0;
  		}
  	}
  	return 1;
d45a6ae24   Kim Phillips   tools: update che...
1079
  }
05622191e   Joe Hershberger   tools: checkpatch...
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
  
  sub parse_email {
  	my ($formatted_email) = @_;
  
  	my $name = "";
  	my $address = "";
  	my $comment = "";
  
  	if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
  		$name = $1;
  		$address = $2;
  		$comment = $3 if defined $3;
  	} elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
  		$address = $1;
  		$comment = $2 if defined $2;
  	} elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
  		$address = $1;
  		$comment = $2 if defined $2;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
1098
  		$formatted_email =~ s/\Q$address\E.*$//;
05622191e   Joe Hershberger   tools: checkpatch...
1099
  		$name = $formatted_email;
6b9709d91   Tom Rini   scripts: update c...
1100
  		$name = trim($name);
05622191e   Joe Hershberger   tools: checkpatch...
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
  		$name =~ s/^\"|\"$//g;
  		# If there's a name left after stripping spaces and
  		# leading quotes, and the address doesn't have both
  		# leading and trailing angle brackets, the address
  		# is invalid. ie:
  		#   "joe smith joe@smith.com" bad
  		#   "joe smith <joe@smith.com" bad
  		if ($name ne "" && $address !~ /^<[^>]+>$/) {
  			$name = "";
  			$address = "";
  			$comment = "";
  		}
  	}
6b9709d91   Tom Rini   scripts: update c...
1114
  	$name = trim($name);
05622191e   Joe Hershberger   tools: checkpatch...
1115
  	$name =~ s/^\"|\"$//g;
6b9709d91   Tom Rini   scripts: update c...
1116
  	$address = trim($address);
05622191e   Joe Hershberger   tools: checkpatch...
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
  	$address =~ s/^\<|\>$//g;
  
  	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
  		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
  		$name = "\"$name\"";
  	}
  
  	return ($name, $address, $comment);
  }
  
  sub format_email {
  	my ($name, $address) = @_;
  
  	my $formatted_email;
6b9709d91   Tom Rini   scripts: update c...
1131
  	$name = trim($name);
05622191e   Joe Hershberger   tools: checkpatch...
1132
  	$name =~ s/^\"|\"$//g;
6b9709d91   Tom Rini   scripts: update c...
1133
  	$address = trim($address);
05622191e   Joe Hershberger   tools: checkpatch...
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
  
  	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
  		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
  		$name = "\"$name\"";
  	}
  
  	if ("$name" eq "") {
  		$formatted_email = "$address";
  	} else {
  		$formatted_email = "$name <$address>";
  	}
  
  	return $formatted_email;
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
  sub which {
  	my ($bin) = @_;
  
  	foreach my $path (split(/:/, $ENV{PATH})) {
  		if (-e "$path/$bin") {
  			return "$path/$bin";
  		}
  	}
  
  	return "";
  }
05622191e   Joe Hershberger   tools: checkpatch...
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
  sub which_conf {
  	my ($conf) = @_;
  
  	foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
  		if (-e "$path/$conf") {
  			return "$path/$conf";
  		}
  	}
  
  	return "";
  }
  
  sub expand_tabs {
  	my ($str) = @_;
  
  	my $res = '';
  	my $n = 0;
  	for my $c (split(//, $str)) {
  		if ($c eq "\t") {
  			$res .= ' ';
  			$n++;
  			for (; ($n % 8) != 0; $n++) {
  				$res .= ' ';
  			}
  			next;
  		}
  		$res .= $c;
  		$n++;
  	}
  
  	return $res;
  }
  sub copy_spacing {
  	(my $res = shift) =~ tr/\t/ /c;
  	return $res;
  }
  
  sub line_stats {
  	my ($line) = @_;
  
  	# Drop the diff line leader and expand tabs
  	$line =~ s/^.//;
  	$line = expand_tabs($line);
  
  	# Pick the indent from the front of the line.
  	my ($white) = ($line =~ /^(\s*)/);
  
  	return (length($line), length($white));
  }
  
  my $sanitise_quote = '';
  
  sub sanitise_line_reset {
  	my ($in_comment) = @_;
  
  	if ($in_comment) {
  		$sanitise_quote = '*/';
  	} else {
  		$sanitise_quote = '';
  	}
  }
  sub sanitise_line {
  	my ($line) = @_;
  
  	my $res = '';
  	my $l = '';
  
  	my $qlen = 0;
  	my $off = 0;
  	my $c;
  
  	# Always copy over the diff marker.
  	$res = substr($line, 0, 1);
  
  	for ($off = 1; $off < length($line); $off++) {
  		$c = substr($line, $off, 1);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
1235
  		# Comments we are whacking completely including the begin
05622191e   Joe Hershberger   tools: checkpatch...
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
  		# and end, all to $;.
  		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
  			$sanitise_quote = '*/';
  
  			substr($res, $off, 2, "$;$;");
  			$off++;
  			next;
  		}
  		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
  			$sanitise_quote = '';
  			substr($res, $off, 2, "$;$;");
  			$off++;
  			next;
  		}
  		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
  			$sanitise_quote = '//';
  
  			substr($res, $off, 2, $sanitise_quote);
  			$off++;
  			next;
  		}
  
  		# A \ in a string means ignore the next character.
  		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
  		    $c eq "\\") {
  			substr($res, $off, 2, 'XX');
  			$off++;
  			next;
  		}
  		# Regular quotes.
  		if ($c eq "'" || $c eq '"') {
  			if ($sanitise_quote eq '') {
  				$sanitise_quote = $c;
  
  				substr($res, $off, 1, $c);
  				next;
  			} elsif ($sanitise_quote eq $c) {
  				$sanitise_quote = '';
  			}
  		}
  
  		#print "c<$c> SQ<$sanitise_quote>
  ";
  		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
  			substr($res, $off, 1, $;);
  		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
  			substr($res, $off, 1, $;);
  		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
  			substr($res, $off, 1, 'X');
  		} else {
  			substr($res, $off, 1, $c);
  		}
  	}
  
  	if ($sanitise_quote eq '//') {
  		$sanitise_quote = '';
  	}
  
  	# The pathname on a #include may be surrounded by '<' and '>'.
  	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
  		my $clean = 'X' x length($1);
  		$res =~ s@\<.*\>@<$clean>@;
  
  	# The whole of a #error is a string.
  	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
  		my $clean = 'X' x length($1);
  		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
  	}
6305db960   Heinrich Schuchardt   checkpatch: updat...
1304
1305
1306
1307
  	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
  		my $match = $1;
  		$res =~ s/\Q$match\E/"$;" x length($match)/e;
  	}
05622191e   Joe Hershberger   tools: checkpatch...
1308
1309
  	return $res;
  }
6b9709d91   Tom Rini   scripts: update c...
1310
1311
  sub get_quoted_string {
  	my ($line, $rawline) = @_;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
1312
  	return "" if (!defined($line) || !defined($rawline));
6305db960   Heinrich Schuchardt   checkpatch: updat...
1313
  	return "" if ($line !~ m/($String)/g);
6b9709d91   Tom Rini   scripts: update c...
1314
1315
  	return substr($rawline, $-[0], $+[0] - $-[0]);
  }
05622191e   Joe Hershberger   tools: checkpatch...
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
  sub ctx_statement_block {
  	my ($linenr, $remain, $off) = @_;
  	my $line = $linenr - 1;
  	my $blk = '';
  	my $soff = $off;
  	my $coff = $off - 1;
  	my $coff_set = 0;
  
  	my $loff = 0;
  
  	my $type = '';
  	my $level = 0;
  	my @stack = ();
  	my $p;
  	my $c;
  	my $len = 0;
  
  	my $remainder;
  	while (1) {
  		@stack = (['', 0]) if ($#stack == -1);
  
  		#warn "CSB: blk<$blk> remain<$remain>
  ";
  		# If we are about to drop off the end, pull in more
  		# context.
  		if ($off >= $len) {
  			for (; $remain > 0; $line++) {
  				last if (!defined $lines[$line]);
  				next if ($lines[$line] =~ /^-/);
  				$remain--;
  				$loff = $len;
  				$blk .= $lines[$line] . "
  ";
  				$len = length($blk);
  				$line++;
  				last;
  			}
  			# Bail if there is no further context.
  			#warn "CSB: blk<$blk> off<$off> len<$len>
  ";
  			if ($off >= $len) {
  				last;
  			}
d45a6ae24   Kim Phillips   tools: update che...
1359
1360
1361
1362
  			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
  				$level++;
  				$type = '#';
  			}
05622191e   Joe Hershberger   tools: checkpatch...
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
  		}
  		$p = $c;
  		$c = substr($blk, $off, 1);
  		$remainder = substr($blk, $off);
  
  		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>
  ";
  
  		# Handle nested #if/#else.
  		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
  			push(@stack, [ $type, $level ]);
  		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
  			($type, $level) = @{$stack[$#stack - 1]};
  		} elsif ($remainder =~ /^#\s*endif\b/) {
  			($type, $level) = @{pop(@stack)};
  		}
  
  		# Statement ends at the ';' or a close '}' at the
  		# outermost level.
  		if ($level == 0 && $c eq ';') {
  			last;
  		}
  
  		# An else is really a conditional as long as its not else if
  		if ($level == 0 && $coff_set == 0 &&
  				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
  				$remainder =~ /^(else)(?:\s|{)/ &&
  				$remainder !~ /^else\s+if\b/) {
  			$coff = $off + length($1) - 1;
  			$coff_set = 1;
  			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>
  ";
  			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]
  ";
  		}
  
  		if (($type eq '' || $type eq '(') && $c eq '(') {
  			$level++;
  			$type = '(';
  		}
  		if ($type eq '(' && $c eq ')') {
  			$level--;
  			$type = ($level != 0)? '(' : '';
  
  			if ($level == 0 && $coff < $soff) {
  				$coff = $off;
  				$coff_set = 1;
  				#warn "CSB: mark coff<$coff>
  ";
  			}
  		}
  		if (($type eq '' || $type eq '{') && $c eq '{') {
  			$level++;
  			$type = '{';
  		}
  		if ($type eq '{' && $c eq '}') {
  			$level--;
  			$type = ($level != 0)? '{' : '';
  
  			if ($level == 0) {
  				if (substr($blk, $off + 1, 1) eq ';') {
  					$off++;
  				}
  				last;
  			}
  		}
d45a6ae24   Kim Phillips   tools: update che...
1429
1430
1431
1432
1433
1434
1435
1436
  		# Preprocessor commands end at the newline unless escaped.
  		if ($type eq '#' && $c eq "
  " && $p ne "\\") {
  			$level--;
  			$type = '';
  			$off++;
  			last;
  		}
05622191e   Joe Hershberger   tools: checkpatch...
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
  		$off++;
  	}
  	# We are truly at the end, so shuffle to the next line.
  	if ($off == $len) {
  		$loff = $len + 1;
  		$line++;
  		$remain--;
  	}
  
  	my $statement = substr($blk, $soff, $off - $soff + 1);
  	my $condition = substr($blk, $soff, $coff - $soff + 1);
  
  	#warn "STATEMENT<$statement>
  ";
  	#warn "CONDITION<$condition>
  ";
  
  	#print "coff<$coff> soff<$off> loff<$loff>
  ";
  
  	return ($statement, $condition,
  			$line, $remain + 1, $off - $loff + 1, $level);
  }
  
  sub statement_lines {
  	my ($stmt) = @_;
  
  	# Strip the diff line prefixes and rip blank lines at start and end.
  	$stmt =~ s/(^|
  )./$1/g;
  	$stmt =~ s/^\s*//;
  	$stmt =~ s/\s*$//;
  
  	my @stmt_lines = ($stmt =~ /
  /g);
  
  	return $#stmt_lines + 2;
  }
  
  sub statement_rawlines {
  	my ($stmt) = @_;
  
  	my @stmt_lines = ($stmt =~ /
  /g);
  
  	return $#stmt_lines + 2;
  }
  
  sub statement_block_size {
  	my ($stmt) = @_;
  
  	$stmt =~ s/(^|
  )./$1/g;
  	$stmt =~ s/^\s*{//;
  	$stmt =~ s/}\s*$//;
  	$stmt =~ s/^\s*//;
  	$stmt =~ s/\s*$//;
  
  	my @stmt_lines = ($stmt =~ /
  /g);
  	my @stmt_statements = ($stmt =~ /;/g);
  
  	my $stmt_lines = $#stmt_lines + 2;
  	my $stmt_statements = $#stmt_statements + 1;
  
  	if ($stmt_lines > $stmt_statements) {
  		return $stmt_lines;
  	} else {
  		return $stmt_statements;
  	}
  }
  
  sub ctx_statement_full {
  	my ($linenr, $remain, $off) = @_;
  	my ($statement, $condition, $level);
  
  	my (@chunks);
  
  	# Grab the first conditional/block pair.
  	($statement, $condition, $linenr, $remain, $off, $level) =
  				ctx_statement_block($linenr, $remain, $off);
  	#print "F: c<$condition> s<$statement> remain<$remain>
  ";
  	push(@chunks, [ $condition, $statement ]);
  	if (!($remain > 0 && $condition =~ /^\s*(?:
  [+-])?\s*(?:if|else|do)\b/s)) {
  		return ($level, $linenr, @chunks);
  	}
  
  	# Pull in the following conditional/block pairs and see if they
  	# could continue the statement.
  	for (;;) {
  		($statement, $condition, $linenr, $remain, $off, $level) =
  				ctx_statement_block($linenr, $remain, $off);
  		#print "C: c<$condition> s<$statement> remain<$remain>
  ";
  		last if (!($remain > 0 && $condition =~ /^(?:\s*
  [+-])*\s*(?:else|do)\b/s));
  		#print "C: push
  ";
  		push(@chunks, [ $condition, $statement ]);
  	}
  
  	return ($level, $linenr, @chunks);
  }
  
  sub ctx_block_get {
  	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
  	my $line;
  	my $start = $linenr - 1;
  	my $blk = '';
  	my @o;
  	my @c;
  	my @res = ();
  
  	my $level = 0;
  	my @stack = ($level);
  	for ($line = $start; $remain > 0; $line++) {
  		next if ($rawlines[$line] =~ /^-/);
  		$remain--;
  
  		$blk .= $rawlines[$line];
  
  		# Handle nested #if/#else.
  		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
  			push(@stack, $level);
  		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
  			$level = $stack[$#stack - 1];
  		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
  			$level = pop(@stack);
  		}
  
  		foreach my $c (split(//, $lines[$line])) {
  			##print "C<$c>L<$level><$open$close>O<$off>
  ";
  			if ($off > 0) {
  				$off--;
  				next;
  			}
  
  			if ($c eq $close && $level > 0) {
  				$level--;
  				last if ($level == 0);
  			} elsif ($c eq $open) {
  				$level++;
  			}
  		}
  
  		if (!$outer || $level <= 1) {
  			push(@res, $rawlines[$line]);
  		}
  
  		last if ($level == 0);
  	}
  
  	return ($level, @res);
  }
  sub ctx_block_outer {
  	my ($linenr, $remain) = @_;
  
  	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
  	return @r;
  }
  sub ctx_block {
  	my ($linenr, $remain) = @_;
  
  	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
  	return @r;
  }
  sub ctx_statement {
  	my ($linenr, $remain, $off) = @_;
  
  	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
  	return @r;
  }
  sub ctx_block_level {
  	my ($linenr, $remain) = @_;
  
  	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
  }
  sub ctx_statement_level {
  	my ($linenr, $remain, $off) = @_;
  
  	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
  }
  
  sub ctx_locate_comment {
  	my ($first_line, $end_line) = @_;
  
  	# Catch a comment on the end of the line itself.
  	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
  	return $current_comment if (defined $current_comment);
  
  	# Look through the context and try and figure out if there is a
  	# comment.
  	my $in_comment = 0;
  	$current_comment = '';
  	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
  		my $line = $rawlines[$linenr - 1];
  		#warn "           $line
  ";
  		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
  			$in_comment = 1;
  		}
  		if ($line =~ m@/\*@) {
  			$in_comment = 1;
  		}
  		if (!$in_comment && $current_comment ne '') {
  			$current_comment = '';
  		}
  		$current_comment .= $line . "
  " if ($in_comment);
  		if ($line =~ m@\*/@) {
  			$in_comment = 0;
  		}
  	}
  
  	chomp($current_comment);
  	return($current_comment);
  }
  sub ctx_has_comment {
  	my ($first_line, $end_line) = @_;
  	my $cmt = ctx_locate_comment($first_line, $end_line);
  
  	##print "LINE: $rawlines[$end_line - 1 ]
  ";
  	##print "CMMT: $cmt
  ";
  
  	return ($cmt ne '');
  }
  
  sub raw_line {
  	my ($linenr, $cnt) = @_;
  
  	my $offset = $linenr - 1;
  	$cnt++;
  
  	my $line;
  	while ($cnt) {
  		$line = $rawlines[$offset++];
  		next if (defined($line) && $line =~ /^-/);
  		$cnt--;
  	}
  
  	return $line;
  }
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
  sub get_stat_real {
  	my ($linenr, $lc) = @_;
  
  	my $stat_real = raw_line($linenr, 0);
  	for (my $count = $linenr + 1; $count <= $lc; $count++) {
  		$stat_real = $stat_real . "
  " . raw_line($count, 0);
  	}
  
  	return $stat_real;
  }
  
  sub get_stat_here {
  	my ($linenr, $cnt, $here) = @_;
  
  	my $herectx = $here . "
  ";
  	for (my $n = 0; $n < $cnt; $n++) {
  		$herectx .= raw_line($linenr, $n) . "
  ";
  	}
  
  	return $herectx;
  }
05622191e   Joe Hershberger   tools: checkpatch...
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
  sub cat_vet {
  	my ($vet) = @_;
  	my ($res, $coded);
  
  	$res = '';
  	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
  		$res .= $1;
  		if ($2 ne '') {
  			$coded = sprintf("^%c", unpack('C', $2) + 64);
  			$res .= $coded;
  		}
  	}
  	$res =~ s/$/\$/;
  
  	return $res;
  }
  
  my $av_preprocessor = 0;
  my $av_pending;
  my @av_paren_type;
  my $av_pend_colon;
  
  sub annotate_reset {
  	$av_preprocessor = 0;
  	$av_pending = '_';
  	@av_paren_type = ('E');
  	$av_pend_colon = 'O';
  }
  
  sub annotate_values {
  	my ($stream, $type) = @_;
  
  	my $res;
  	my $var = '_' x length($stream);
  	my $cur = $stream;
  
  	print "$stream
  " if ($dbg_values > 1);
  
  	while (length($cur)) {
  		@av_paren_type = ('E') if ($#av_paren_type < 0);
  		print " <" . join('', @av_paren_type) .
  				"> <$type> <$av_pending>" if ($dbg_values > 1);
  		if ($cur =~ /^(\s+)/o) {
  			print "WS($1)
  " if ($dbg_values > 1);
  			if ($1 =~ /
  / && $av_preprocessor) {
  				$type = pop(@av_paren_type);
  				$av_preprocessor = 0;
  			}
  
  		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
  			print "CAST($1)
  " if ($dbg_values > 1);
  			push(@av_paren_type, $type);
d45a6ae24   Kim Phillips   tools: update che...
1764
  			$type = 'c';
05622191e   Joe Hershberger   tools: checkpatch...
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
  
  		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
  			print "DECLARE($1)
  " if ($dbg_values > 1);
  			$type = 'T';
  
  		} elsif ($cur =~ /^($Modifier)\s*/) {
  			print "MODIFIER($1)
  " if ($dbg_values > 1);
  			$type = 'T';
  
  		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
  			print "DEFINE($1,$2)
  " if ($dbg_values > 1);
  			$av_preprocessor = 1;
  			push(@av_paren_type, $type);
  			if ($2 ne '') {
  				$av_pending = 'N';
  			}
  			$type = 'E';
  
  		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
  			print "UNDEF($1)
  " if ($dbg_values > 1);
  			$av_preprocessor = 1;
  			push(@av_paren_type, $type);
  
  		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
  			print "PRE_START($1)
  " if ($dbg_values > 1);
  			$av_preprocessor = 1;
  
  			push(@av_paren_type, $type);
  			push(@av_paren_type, $type);
  			$type = 'E';
  
  		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
  			print "PRE_RESTART($1)
  " if ($dbg_values > 1);
  			$av_preprocessor = 1;
  
  			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
  
  			$type = 'E';
  
  		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
  			print "PRE_END($1)
  " if ($dbg_values > 1);
  
  			$av_preprocessor = 1;
  
  			# Assume all arms of the conditional end as this
  			# one does, and continue as if the #endif was not here.
  			pop(@av_paren_type);
  			push(@av_paren_type, $type);
  			$type = 'E';
  
  		} elsif ($cur =~ /^(\\
  )/o) {
  			print "PRECONT($1)
  " if ($dbg_values > 1);
  
  		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
  			print "ATTR($1)
  " if ($dbg_values > 1);
  			$av_pending = $type;
  			$type = 'N';
  
  		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
  			print "SIZEOF($1)
  " if ($dbg_values > 1);
  			if (defined $2) {
  				$av_pending = 'V';
  			}
  			$type = 'N';
  
  		} elsif ($cur =~ /^(if|while|for)\b/o) {
  			print "COND($1)
  " if ($dbg_values > 1);
  			$av_pending = 'E';
  			$type = 'N';
  
  		} elsif ($cur =~/^(case)/o) {
  			print "CASE($1)
  " if ($dbg_values > 1);
  			$av_pend_colon = 'C';
  			$type = 'N';
  
  		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
  			print "KEYWORD($1)
  " if ($dbg_values > 1);
  			$type = 'N';
  
  		} elsif ($cur =~ /^(\()/o) {
  			print "PAREN('$1')
  " if ($dbg_values > 1);
  			push(@av_paren_type, $av_pending);
  			$av_pending = '_';
  			$type = 'N';
  
  		} elsif ($cur =~ /^(\))/o) {
  			my $new_type = pop(@av_paren_type);
  			if ($new_type ne '_') {
  				$type = $new_type;
  				print "PAREN('$1') -> $type
  "
  							if ($dbg_values > 1);
  			} else {
  				print "PAREN('$1')
  " if ($dbg_values > 1);
  			}
  
  		} elsif ($cur =~ /^($Ident)\s*\(/o) {
  			print "FUNC($1)
  " if ($dbg_values > 1);
  			$type = 'V';
  			$av_pending = 'V';
  
  		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
  			if (defined $2 && $type eq 'C' || $type eq 'T') {
  				$av_pend_colon = 'B';
  			} elsif ($type eq 'E') {
  				$av_pend_colon = 'L';
  			}
  			print "IDENT_COLON($1,$type>$av_pend_colon)
  " if ($dbg_values > 1);
  			$type = 'V';
  
  		} elsif ($cur =~ /^($Ident|$Constant)/o) {
  			print "IDENT($1)
  " if ($dbg_values > 1);
  			$type = 'V';
  
  		} elsif ($cur =~ /^($Assignment)/o) {
  			print "ASSIGN($1)
  " if ($dbg_values > 1);
  			$type = 'N';
  
  		} elsif ($cur =~/^(;|{|})/) {
  			print "END($1)
  " if ($dbg_values > 1);
  			$type = 'E';
  			$av_pend_colon = 'O';
  
  		} elsif ($cur =~/^(,)/) {
  			print "COMMA($1)
  " if ($dbg_values > 1);
  			$type = 'C';
  
  		} elsif ($cur =~ /^(\?)/o) {
  			print "QUESTION($1)
  " if ($dbg_values > 1);
  			$type = 'N';
  
  		} elsif ($cur =~ /^(:)/o) {
  			print "COLON($1,$av_pend_colon)
  " if ($dbg_values > 1);
  
  			substr($var, length($res), 1, $av_pend_colon);
  			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
  				$type = 'E';
  			} else {
  				$type = 'N';
  			}
  			$av_pend_colon = 'O';
  
  		} elsif ($cur =~ /^(\[)/o) {
  			print "CLOSE($1)
  " if ($dbg_values > 1);
  			$type = 'N';
  
  		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
  			my $variant;
  
  			print "OPV($1)
  " if ($dbg_values > 1);
  			if ($type eq 'V') {
  				$variant = 'B';
  			} else {
  				$variant = 'U';
  			}
  
  			substr($var, length($res), 1, $variant);
  			$type = 'N';
  
  		} elsif ($cur =~ /^($Operators)/o) {
  			print "OP($1)
  " if ($dbg_values > 1);
  			if ($1 ne '++' && $1 ne '--') {
  				$type = 'N';
  			}
  
  		} elsif ($cur =~ /(^.)/o) {
  			print "C($1)
  " if ($dbg_values > 1);
  		}
  		if (defined $1) {
  			$cur = substr($cur, length($1));
  			$res .= $type x length($1);
  		}
  	}
  
  	return ($res, $var);
  }
  
  sub possible {
  	my ($possible, $line) = @_;
  	my $notPermitted = qr{(?:
  		^(?:
  			$Modifier|
  			$Storage|
  			$Type|
  			DEFINE_\S+
  		)$|
  		^(?:
  			goto|
  			return|
  			case|
  			else|
  			asm|__asm__|
d45a6ae24   Kim Phillips   tools: update che...
1985
1986
1987
  			do|
  			\#|
  			\#\#|
05622191e   Joe Hershberger   tools: checkpatch...
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
  		)(?:\s|$)|
  		^(?:typedef|struct|enum)\b
  	    )}x;
  	warn "CHECK<$possible> ($line)
  " if ($dbg_possible > 2);
  	if ($possible !~ $notPermitted) {
  		# Check for modifiers.
  		$possible =~ s/\s*$Storage\s*//g;
  		$possible =~ s/\s*$Sparse\s*//g;
  		if ($possible =~ /^\s*$/) {
  
  		} elsif ($possible =~ /\s/) {
  			$possible =~ s/\s*$Type\s*//g;
  			for my $modifier (split(' ', $possible)) {
  				if ($modifier !~ $notPermitted) {
  					warn "MODIFIER: $modifier ($possible) ($line)
  " if ($dbg_possible);
6305db960   Heinrich Schuchardt   checkpatch: updat...
2005
  					push(@modifierListFile, $modifier);
05622191e   Joe Hershberger   tools: checkpatch...
2006
2007
2008
2009
2010
2011
  				}
  			}
  
  		} else {
  			warn "POSSIBLE: $possible ($line)
  " if ($dbg_possible);
6305db960   Heinrich Schuchardt   checkpatch: updat...
2012
  			push(@typeListFile, $possible);
05622191e   Joe Hershberger   tools: checkpatch...
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
  		}
  		build_types();
  	} else {
  		warn "NOTPOSS: $possible ($line)
  " if ($dbg_possible > 1);
  	}
  }
  
  my $prefix = '';
  
  sub show_type {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2024
2025
2026
  	my ($type) = @_;
  
  	$type =~ tr/[a-z]/[A-Z]/;
6b9709d91   Tom Rini   scripts: update c...
2027

6305db960   Heinrich Schuchardt   checkpatch: updat...
2028
2029
2030
  	return defined $use_type{$type} if (scalar keys %use_type > 0);
  
  	return !defined $ignore_type{$type};
05622191e   Joe Hershberger   tools: checkpatch...
2031
2032
2033
  }
  
  sub report {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2034
2035
2036
2037
  	my ($level, $type, $msg) = @_;
  
  	if (!show_type($type) ||
  	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
05622191e   Joe Hershberger   tools: checkpatch...
2038
2039
  		return 0;
  	}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
  	my $output = '';
  	if ($color) {
  		if ($level eq 'ERROR') {
  			$output .= RED;
  		} elsif ($level eq 'WARNING') {
  			$output .= YELLOW;
  		} else {
  			$output .= GREEN;
  		}
  	}
  	$output .= $prefix . $level . ':';
05622191e   Joe Hershberger   tools: checkpatch...
2051
  	if ($show_types) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
  		$output .= BLUE if ($color);
  		$output .= "$type:";
  	}
  	$output .= RESET if ($color);
  	$output .= ' ' . $msg . "
  ";
  
  	if ($showfile) {
  		my @lines = split("
  ", $output, -1);
  		splice(@lines, 1, 1);
  		$output = join("
  ", @lines);
05622191e   Joe Hershberger   tools: checkpatch...
2065
  	}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2066
2067
2068
  	$output = (split('
  ', $output))[0] . "
  " if ($terse);
05622191e   Joe Hershberger   tools: checkpatch...
2069

6305db960   Heinrich Schuchardt   checkpatch: updat...
2070
  	push(our @report, $output);
05622191e   Joe Hershberger   tools: checkpatch...
2071
2072
2073
  
  	return 1;
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
2074

05622191e   Joe Hershberger   tools: checkpatch...
2075
2076
2077
  sub report_dump {
  	our @report;
  }
6305db960   Heinrich Schuchardt   checkpatch: updat...
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
  sub fixup_current_range {
  	my ($lineRef, $offset, $length) = @_;
  
  	if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
  		my $o = $1;
  		my $l = $2;
  		my $no = $o + $offset;
  		my $nl = $l + $length;
  		$$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
  	}
  }
  
  sub fix_inserted_deleted_lines {
  	my ($linesRef, $insertedRef, $deletedRef) = @_;
  
  	my $range_last_linenr = 0;
  	my $delta_offset = 0;
  
  	my $old_linenr = 0;
  	my $new_linenr = 0;
  
  	my $next_insert = 0;
  	my $next_delete = 0;
  
  	my @lines = ();
  
  	my $inserted = @{$insertedRef}[$next_insert++];
  	my $deleted = @{$deletedRef}[$next_delete++];
  
  	foreach my $old_line (@{$linesRef}) {
  		my $save_line = 1;
  		my $line = $old_line;	#don't modify the array
  		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
  			$delta_offset = 0;
  		} elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {	#new hunk
  			$range_last_linenr = $new_linenr;
  			fixup_current_range(\$line, $delta_offset, 0);
  		}
  
  		while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
  			$deleted = @{$deletedRef}[$next_delete++];
  			$save_line = 0;
  			fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
  		}
  
  		while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
  			push(@lines, ${$inserted}{'LINE'});
  			$inserted = @{$insertedRef}[$next_insert++];
  			$new_linenr++;
  			fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
  		}
  
  		if ($save_line) {
  			push(@lines, $line);
  			$new_linenr++;
  		}
  
  		$old_linenr++;
  	}
  
  	return @lines;
  }
  
  sub fix_insert_line {
  	my ($linenr, $line) = @_;
  
  	my $inserted = {
  		LINENR => $linenr,
  		LINE => $line,
  	};
  	push(@fixed_inserted, $inserted);
  }
  
  sub fix_delete_line {
  	my ($linenr, $line) = @_;
  
  	my $deleted = {
  		LINENR => $linenr,
  		LINE => $line,
  	};
  
  	push(@fixed_deleted, $deleted);
  }
05622191e   Joe Hershberger   tools: checkpatch...
2161
  sub ERROR {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2162
2163
2164
  	my ($type, $msg) = @_;
  
  	if (report("ERROR", $type, $msg)) {
05622191e   Joe Hershberger   tools: checkpatch...
2165
2166
  		our $clean = 0;
  		our $cnt_error++;
6b9709d91   Tom Rini   scripts: update c...
2167
  		return 1;
05622191e   Joe Hershberger   tools: checkpatch...
2168
  	}
6b9709d91   Tom Rini   scripts: update c...
2169
  	return 0;
05622191e   Joe Hershberger   tools: checkpatch...
2170
2171
  }
  sub WARN {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2172
2173
2174
  	my ($type, $msg) = @_;
  
  	if (report("WARNING", $type, $msg)) {
05622191e   Joe Hershberger   tools: checkpatch...
2175
2176
  		our $clean = 0;
  		our $cnt_warn++;
6b9709d91   Tom Rini   scripts: update c...
2177
  		return 1;
05622191e   Joe Hershberger   tools: checkpatch...
2178
  	}
6b9709d91   Tom Rini   scripts: update c...
2179
  	return 0;
05622191e   Joe Hershberger   tools: checkpatch...
2180
2181
  }
  sub CHK {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2182
2183
2184
  	my ($type, $msg) = @_;
  
  	if ($check && report("CHECK", $type, $msg)) {
05622191e   Joe Hershberger   tools: checkpatch...
2185
2186
  		our $clean = 0;
  		our $cnt_chk++;
6b9709d91   Tom Rini   scripts: update c...
2187
  		return 1;
05622191e   Joe Hershberger   tools: checkpatch...
2188
  	}
6b9709d91   Tom Rini   scripts: update c...
2189
  	return 0;
05622191e   Joe Hershberger   tools: checkpatch...
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
  }
  
  sub check_absolute_file {
  	my ($absolute, $herecurr) = @_;
  	my $file = $absolute;
  
  	##print "absolute<$absolute>
  ";
  
  	# See if any suffix of this path is a path within the tree.
  	while ($file =~ s@^[^/]*/@@) {
  		if (-f "$root/$file") {
  			##print "file<$file>
  ";
  			last;
  		}
  	}
  	if (! -f _)  {
  		return 0;
  	}
  
  	# It is, so see if the prefix is acceptable.
  	my $prefix = $absolute;
  	substr($prefix, -length($file)) = '';
  
  	##print "prefix<$prefix>
  ";
  	if ($prefix ne ".../") {
  		WARN("USE_RELATIVE_PATH",
  		     "use relative pathname instead of absolute in changelog text
  " . $herecurr);
  	}
  }
6b9709d91   Tom Rini   scripts: update c...
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
  sub trim {
  	my ($string) = @_;
  
  	$string =~ s/^\s+|\s+$//g;
  
  	return $string;
  }
  
  sub ltrim {
  	my ($string) = @_;
  
  	$string =~ s/^\s+//;
  
  	return $string;
  }
  
  sub rtrim {
  	my ($string) = @_;
  
  	$string =~ s/\s+$//;
  
  	return $string;
  }
  
  sub string_find_replace {
  	my ($string, $find, $replace) = @_;
  
  	$string =~ s/$find/$replace/g;
  
  	return $string;
  }
  
  sub tabify {
  	my ($leading) = @_;
  
  	my $source_indent = 8;
  	my $max_spaces_before_tab = $source_indent - 1;
  	my $spaces_to_tab = " " x $source_indent;
  
  	#convert leading spaces to tabs
  	1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
  	#Remove spaces before a tab
  	1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
  
  	return "$leading";
  }
d45a6ae24   Kim Phillips   tools: update che...
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
  sub pos_last_openparen {
  	my ($line) = @_;
  
  	my $pos = 0;
  
  	my $opens = $line =~ tr/\(/\(/;
  	my $closes = $line =~ tr/\)/\)/;
  
  	my $last_openparen = 0;
  
  	if (($opens == 0) || ($closes >= $opens)) {
  		return -1;
  	}
  
  	my $len = length($line);
  
  	for ($pos = 0; $pos < $len; $pos++) {
  		my $string = substr($line, $pos);
  		if ($string =~ /^($FuncArg|$balanced_parens)/) {
  			$pos += length($1) - 1;
  		} elsif (substr($line, $pos, 1) eq '(') {
  			$last_openparen = $pos;
  		} elsif (index($string, '(') == -1) {
  			last;
  		}
  	}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2295
  	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
d45a6ae24   Kim Phillips   tools: update che...
2296
  }
05622191e   Joe Hershberger   tools: checkpatch...
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
  sub process {
  	my $filename = shift;
  
  	my $linenr=0;
  	my $prevline="";
  	my $prevrawline="";
  	my $stashline="";
  	my $stashrawline="";
  
  	my $length;
  	my $indent;
  	my $previndent=0;
  	my $stashindent=0;
  
  	our $clean = 1;
  	my $signoff = 0;
  	my $is_patch = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2314
  	my $in_header_lines = $file ? 0 : 1;
d45a6ae24   Kim Phillips   tools: update che...
2315
  	my $in_commit_log = 0;		#Scanning lines before patch
6305db960   Heinrich Schuchardt   checkpatch: updat...
2316
2317
2318
2319
2320
  	my $has_commit_log = 0;		#Encountered lines before patch
  	my $commit_log_possible_stack_dump = 0;
  	my $commit_log_long_line = 0;
  	my $commit_log_has_diff = 0;
  	my $reported_maintainer_file = 0;
d45a6ae24   Kim Phillips   tools: update che...
2321
  	my $non_utf8_charset = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2322
2323
  	my $last_blank_line = 0;
  	my $last_coalesced_string_linenr = -1;
05622191e   Joe Hershberger   tools: checkpatch...
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
  	our @report = ();
  	our $cnt_lines = 0;
  	our $cnt_error = 0;
  	our $cnt_warn = 0;
  	our $cnt_chk = 0;
  
  	# Trace the real file/line as we go.
  	my $realfile = '';
  	my $realline = 0;
  	my $realcnt = 0;
  	my $here = '';
6305db960   Heinrich Schuchardt   checkpatch: updat...
2335
  	my $context_function;		#undef'd unless there's a known function
05622191e   Joe Hershberger   tools: checkpatch...
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
  	my $in_comment = 0;
  	my $comment_edge = 0;
  	my $first_line = 0;
  	my $p1_prefix = '';
  
  	my $prev_values = 'E';
  
  	# suppression flags
  	my %suppress_ifbraces;
  	my %suppress_whiletrailers;
  	my %suppress_export;
d45a6ae24   Kim Phillips   tools: update che...
2347
  	my $suppress_statement = 0;
6b9709d91   Tom Rini   scripts: update c...
2348
  	my %signatures = ();
05622191e   Joe Hershberger   tools: checkpatch...
2349
2350
2351
2352
2353
2354
  
  	# Pre-scan the patch sanitizing the lines.
  	# Pre-scan the patch looking for any __setup documentation.
  	#
  	my @setup_docs = ();
  	my $setup_docs = 0;
6b9709d91   Tom Rini   scripts: update c...
2355
  	my $camelcase_file_seeded = 0;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2356
  	my $checklicenseline = 1;
05622191e   Joe Hershberger   tools: checkpatch...
2357
2358
2359
2360
2361
  	sanitise_line_reset();
  	my $line;
  	foreach my $rawline (@rawlines) {
  		$linenr++;
  		$line = $rawline;
6b9709d91   Tom Rini   scripts: update c...
2362
  		push(@fixed, $rawline) if ($fix);
05622191e   Joe Hershberger   tools: checkpatch...
2363
2364
  		if ($rawline=~/^\+\+\+\s+(\S+)/) {
  			$setup_docs = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2365
  			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
05622191e   Joe Hershberger   tools: checkpatch...
2366
2367
2368
2369
  				$setup_docs = 1;
  			}
  			#next;
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2370
  		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
05622191e   Joe Hershberger   tools: checkpatch...
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
  			$realline=$1-1;
  			if (defined $2) {
  				$realcnt=$3+1;
  			} else {
  				$realcnt=1+1;
  			}
  			$in_comment = 0;
  
  			# Guestimate if this is a continuing comment.  Run
  			# the context looking for a comment "edge".  If this
  			# edge is a close comment then we must be in a comment
  			# at context start.
  			my $edge;
  			my $cnt = $realcnt;
  			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
  				next if (defined $rawlines[$ln - 1] &&
  					 $rawlines[$ln - 1] =~ /^-/);
  				$cnt--;
  				#print "RAW<$rawlines[$ln - 1]>
  ";
  				last if (!defined $rawlines[$ln - 1]);
  				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
  				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
  					($edge) = $1;
  					last;
  				}
  			}
  			if (defined $edge && $edge eq '*/') {
  				$in_comment = 1;
  			}
  
  			# Guestimate if this is a continuing comment.  If this
  			# is the start of a diff block and this line starts
  			# ' *' then it is very likely a comment.
  			if (!defined $edge &&
  			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
  			{
  				$in_comment = 1;
  			}
  
  			##print "COMMENT:$in_comment edge<$edge> $rawline
  ";
  			sanitise_line_reset($in_comment);
  
  		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
  			# Standardise the strings and chars within the input to
  			# simplify matching -- only bother with positive lines.
  			$line = sanitise_line($rawline);
  		}
  		push(@lines, $line);
  
  		if ($realcnt > 1) {
  			$realcnt-- if ($line =~ /^(?:\+| |$)/);
  		} else {
  			$realcnt = 0;
  		}
  
  		#print "==>$rawline
  ";
  		#print "-->$line
  ";
  
  		if ($setup_docs && $line =~ /^\+/) {
  			push(@setup_docs, $line);
  		}
  	}
  
  	$prefix = '';
  
  	$realcnt = 0;
  	$linenr = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2442
  	$fixlinenr = -1;
05622191e   Joe Hershberger   tools: checkpatch...
2443
2444
  	foreach my $line (@lines) {
  		$linenr++;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2445
  		$fixlinenr++;
6b9709d91   Tom Rini   scripts: update c...
2446
2447
  		my $sline = $line;	#copy of $line
  		$sline =~ s/$;/ /g;	#with comments as spaces
05622191e   Joe Hershberger   tools: checkpatch...
2448
2449
2450
2451
  
  		my $rawline = $rawlines[$linenr - 1];
  
  #extract the line range in the file after the patch is applied
6305db960   Heinrich Schuchardt   checkpatch: updat...
2452
2453
2454
  		if (!$in_commit_log &&
  		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
  			my $context = $4;
05622191e   Joe Hershberger   tools: checkpatch...
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
  			$is_patch = 1;
  			$first_line = $linenr + 1;
  			$realline=$1-1;
  			if (defined $2) {
  				$realcnt=$3+1;
  			} else {
  				$realcnt=1+1;
  			}
  			annotate_reset();
  			$prev_values = 'E';
  
  			%suppress_ifbraces = ();
  			%suppress_whiletrailers = ();
  			%suppress_export = ();
d45a6ae24   Kim Phillips   tools: update che...
2469
  			$suppress_statement = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2470
2471
2472
2473
2474
  			if ($context =~ /\b(\w+)\s*\(/) {
  				$context_function = $1;
  			} else {
  				undef $context_function;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
  			next;
  
  # track the line number as we move through the hunk, note that
  # new versions of GNU diff omit the leading space on completely
  # blank context lines so we need to count that too.
  		} elsif ($line =~ /^( |\+|$)/) {
  			$realline++;
  			$realcnt-- if ($realcnt != 0);
  
  			# Measure the line length and indent.
  			($length, $indent) = line_stats($rawline);
  
  			# Track the previous line.
  			($prevline, $stashline) = ($stashline, $line);
  			($previndent, $stashindent) = ($stashindent, $indent);
  			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
  
  			#warn "line<$line>
  ";
  
  		} elsif ($realcnt == 1) {
  			$realcnt--;
  		}
  
  		my $hunk_line = ($realcnt != 0);
05622191e   Joe Hershberger   tools: checkpatch...
2500
2501
  		$here = "#$linenr: " if (!$file);
  		$here = "#$realline: " if ($file);
6305db960   Heinrich Schuchardt   checkpatch: updat...
2502
  		my $found_file = 0;
05622191e   Joe Hershberger   tools: checkpatch...
2503
2504
2505
  		# extract the filename as it passes
  		if ($line =~ /^diff --git.*?(\S+)$/) {
  			$realfile = $1;
6b9709d91   Tom Rini   scripts: update c...
2506
  			$realfile =~ s@^([^/]*)/@@ if (!$file);
d45a6ae24   Kim Phillips   tools: update che...
2507
  			$in_commit_log = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2508
  			$found_file = 1;
05622191e   Joe Hershberger   tools: checkpatch...
2509
2510
  		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
  			$realfile = $1;
6b9709d91   Tom Rini   scripts: update c...
2511
  			$realfile =~ s@^([^/]*)/@@ if (!$file);
d45a6ae24   Kim Phillips   tools: update che...
2512
  			$in_commit_log = 0;
05622191e   Joe Hershberger   tools: checkpatch...
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
  
  			$p1_prefix = $1;
  			if (!$file && $tree && $p1_prefix ne '' &&
  			    -e "$root/$p1_prefix") {
  				WARN("PATCH_PREFIX",
  				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch
  ");
  			}
  
  			if ($realfile =~ m@^include/asm/@) {
  				ERROR("MODIFIED_INCLUDE_ASM",
  				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>
  " . "$here$rawline
  ");
  			}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
  			$found_file = 1;
  		}
  
  #make up the handle for any error we report on this line
  		if ($showfile) {
  			$prefix = "$realfile:$realline: "
  		} elsif ($emacs) {
  			if ($file) {
  				$prefix = "$filename:$realline: ";
  			} else {
  				$prefix = "$filename:$linenr: ";
  			}
  		}
  
  		if ($found_file) {
  			if (is_maintained_obsolete($realfile)) {
  				WARN("OBSOLETE",
  				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.
  ");
  			}
  			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
  				$check = 1;
  			} else {
  				$check = $check_orig;
  			}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2553
  			$checklicenseline = 1;
05622191e   Joe Hershberger   tools: checkpatch...
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
  			next;
  		}
  
  		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
  
  		my $hereline = "$here
  $rawline
  ";
  		my $herecurr = "$here
  $rawline
  ";
  		my $hereprev = "$here
  $prevrawline
  $rawline
  ";
  
  		$cnt_lines++ if ($realcnt != 0);
6305db960   Heinrich Schuchardt   checkpatch: updat...
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
  # Check if the commit log has what seems like a diff which can confuse patch
  		if ($in_commit_log && !$commit_log_has_diff &&
  		    (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
  		      $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
  		     $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
  		     $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
  			ERROR("DIFF_IN_COMMIT_MSG",
  			      "Avoid using diff content in the commit message - patch(1) might not work
  " . $herecurr);
  			$commit_log_has_diff = 1;
  		}
05622191e   Joe Hershberger   tools: checkpatch...
2582
2583
2584
2585
  # Check for incorrect file permissions
  		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
  			my $permhere = $here . "FILE: $realfile
  ";
6b9709d91   Tom Rini   scripts: update c...
2586
2587
  			if ($realfile !~ m@scripts/@ &&
  			    $realfile !~ /\.(py|pl|awk|sh)$/) {
05622191e   Joe Hershberger   tools: checkpatch...
2588
2589
2590
2591
2592
2593
2594
2595
2596
  				ERROR("EXECUTE_PERMISSIONS",
  				      "do not set execute permissions for source files
  " . $permhere);
  			}
  		}
  
  # Check the patch for a signoff:
  		if ($line =~ /^\s*signed-off-by:/i) {
  			$signoff++;
d45a6ae24   Kim Phillips   tools: update che...
2597
  			$in_commit_log = 0;
05622191e   Joe Hershberger   tools: checkpatch...
2598
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2599
2600
2601
2602
2603
  # Check if MAINTAINERS is being updated.  If so, there's probably no need to
  # emit the "does MAINTAINERS need updating?" message on file add/move/delete
  		if ($line =~ /^\s*MAINTAINERS\s*\|/) {
  			$reported_maintainer_file = 1;
  		}
05622191e   Joe Hershberger   tools: checkpatch...
2604
  # Check signature styles
d45a6ae24   Kim Phillips   tools: update che...
2605
2606
  		if (!$in_header_lines &&
  		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
05622191e   Joe Hershberger   tools: checkpatch...
2607
2608
2609
2610
2611
  			my $space_before = $1;
  			my $sign_off = $2;
  			my $space_after = $3;
  			my $email = $4;
  			my $ucfirst_sign_off = ucfirst(lc($sign_off));
d45a6ae24   Kim Phillips   tools: update che...
2612
2613
2614
2615
2616
  			if ($sign_off !~ /$signature_tags/) {
  				WARN("BAD_SIGN_OFF",
  				     "Non-standard signature: $sign_off
  " . $herecurr);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
2617
  			if (defined $space_before && $space_before ne "") {
6b9709d91   Tom Rini   scripts: update c...
2618
2619
2620
2621
  				if (WARN("BAD_SIGN_OFF",
  					 "Do not use whitespace before $ucfirst_sign_off
  " . $herecurr) &&
  				    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2622
  					$fixed[$fixlinenr] =
6b9709d91   Tom Rini   scripts: update c...
2623
2624
  					    "$ucfirst_sign_off $email";
  				}
05622191e   Joe Hershberger   tools: checkpatch...
2625
2626
  			}
  			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
6b9709d91   Tom Rini   scripts: update c...
2627
2628
2629
2630
  				if (WARN("BAD_SIGN_OFF",
  					 "'$ucfirst_sign_off' is the preferred signature form
  " . $herecurr) &&
  				    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2631
  					$fixed[$fixlinenr] =
6b9709d91   Tom Rini   scripts: update c...
2632
2633
  					    "$ucfirst_sign_off $email";
  				}
05622191e   Joe Hershberger   tools: checkpatch...
2634
2635
  			}
  			if (!defined $space_after || $space_after ne " ") {
6b9709d91   Tom Rini   scripts: update c...
2636
2637
2638
2639
  				if (WARN("BAD_SIGN_OFF",
  					 "Use a single space after $ucfirst_sign_off
  " . $herecurr) &&
  				    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2640
  					$fixed[$fixlinenr] =
6b9709d91   Tom Rini   scripts: update c...
2641
2642
  					    "$ucfirst_sign_off $email";
  				}
05622191e   Joe Hershberger   tools: checkpatch...
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
  			}
  
  			my ($email_name, $email_address, $comment) = parse_email($email);
  			my $suggested_email = format_email(($email_name, $email_address));
  			if ($suggested_email eq "") {
  				ERROR("BAD_SIGN_OFF",
  				      "Unrecognized email address: '$email'
  " . $herecurr);
  			} else {
  				my $dequoted = $suggested_email;
  				$dequoted =~ s/^"//;
  				$dequoted =~ s/" </ </;
  				# Don't force email to have quotes
  				# Allow just an angle bracketed address
  				if ("$dequoted$comment" ne $email &&
  				    "<$email_address>$comment" ne $email &&
  				    "$suggested_email$comment" ne $email) {
  					WARN("BAD_SIGN_OFF",
  					     "email address '$email' might be better as '$suggested_email$comment'
  " . $herecurr);
  				}
  			}
6b9709d91   Tom Rini   scripts: update c...
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
  
  # Check for duplicate signatures
  			my $sig_nospace = $line;
  			$sig_nospace =~ s/\s//g;
  			$sig_nospace = lc($sig_nospace);
  			if (defined $signatures{$sig_nospace}) {
  				WARN("BAD_SIGN_OFF",
  				     "Duplicate signature
  " . $herecurr);
  			} else {
  				$signatures{$sig_nospace} = 1;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
2677
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
  # Check email subject for common tools that don't need to be mentioned
  		if ($in_header_lines &&
  		    $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
  			WARN("EMAIL_SUBJECT",
  			     "A patch subject line should describe the change not the tool that found it
  " . $herecurr);
  		}
  
  # Check for old stable address
  		if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
  			ERROR("STABLE_ADDRESS",
  			      "The 'stable' address should be 'stable\@vger.kernel.org'
  " . $herecurr);
  		}
  
  # Check for unwanted Gerrit info
  		if ($in_commit_log && $line =~ /^\s*change-id:/i) {
  			ERROR("GERRIT_CHANGE_ID",
  			      "Remove Gerrit Change-Id's before submitting upstream.
  " . $herecurr);
  		}
  
  # Check if the commit log is in a possible stack dump
  		if ($in_commit_log && !$commit_log_possible_stack_dump &&
  		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
  		     $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
  					# timestamp
  		     $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
  					# stack dump address
  			$commit_log_possible_stack_dump = 1;
  		}
  
  # Check for line lengths > 75 in commit log, warn once
  		if ($in_commit_log && !$commit_log_long_line &&
  		    length($line) > 75 &&
  		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
  					# file delta changes
  		      $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
  					# filename then :
  		      $line =~ /^\s*(?:Fixes:|Link:)/i ||
  					# A Fixes: or Link: line
  		      $commit_log_possible_stack_dump)) {
  			WARN("COMMIT_LOG_LONG_LINE",
  			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)
  " . $herecurr);
  			$commit_log_long_line = 1;
  		}
  
  # Reset possible stack dump if a blank line is found
  		if ($in_commit_log && $commit_log_possible_stack_dump &&
  		    $line =~ /^\s*$/) {
  			$commit_log_possible_stack_dump = 0;
  		}
  
  # Check for git id commit length and improperly formed commit descriptions
  		if ($in_commit_log && !$commit_log_possible_stack_dump &&
  		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
  		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
  		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
  		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
  		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
  		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
  			my $init_char = "c";
  			my $orig_commit = "";
  			my $short = 1;
  			my $long = 0;
  			my $case = 1;
  			my $space = 1;
  			my $hasdesc = 0;
  			my $hasparens = 0;
  			my $id = '0123456789ab';
  			my $orig_desc = "commit description";
  			my $description = "";
  
  			if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
  				$init_char = $1;
  				$orig_commit = lc($2);
  			} elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
  				$orig_commit = lc($1);
  			}
  
  			$short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
  			$long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
  			$space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
  			$case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
  			if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
  				$orig_desc = $1;
  				$hasparens = 1;
  			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
  				 defined $rawlines[$linenr] &&
  				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
  				$orig_desc = $1;
  				$hasparens = 1;
  			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
  				 defined $rawlines[$linenr] &&
  				 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
  				$line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
  				$orig_desc = $1;
  				$rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
  				$orig_desc .= " " . $1;
  				$hasparens = 1;
  			}
  
  			($id, $description) = git_commit_info($orig_commit,
  							      $id, $orig_desc);
  
  			if (defined($id) &&
  			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
  				ERROR("GIT_COMMIT_ID",
  				      "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'
  " . $herecurr);
  			}
  		}
  
  # Check for added, moved or deleted files
  		if (!$reported_maintainer_file && !$in_commit_log &&
  		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
  		     $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
  		     ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
  		      (defined($1) || defined($2))))) {
  			$is_patch = 1;
  			$reported_maintainer_file = 1;
  			WARN("FILE_PATH_CHANGES",
  			     "added, moved or deleted file(s), does MAINTAINERS need updating?
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
2804
2805
2806
2807
2808
2809
2810
  # Check for wrappage within a valid hunk of the file
  		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
  			ERROR("CORRUPTED_PATCH",
  			      "patch seems to be corrupt (line wrapped?)
  " .
  				$herecurr) if (!$emitted_corrupt++);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
  # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
  		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
  		    $rawline !~ m/^$UTF8*$/) {
  			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
  
  			my $blank = copy_spacing($rawline);
  			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
  			my $hereptr = "$hereline$ptr
  ";
  
  			CHK("INVALID_UTF8",
  			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8
  " . $hereptr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
2825
2826
2827
  # Check if it's the start of a commit log
  # (not a header line and we haven't seen the patch filename)
  		if ($in_header_lines && $realfile =~ /^$/ &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
2828
2829
  		    !($rawline =~ /^\s+(?:\S|$)/ ||
  		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
d45a6ae24   Kim Phillips   tools: update che...
2830
2831
  			$in_header_lines = 0;
  			$in_commit_log = 1;
6305db960   Heinrich Schuchardt   checkpatch: updat...
2832
  			$has_commit_log = 1;
d45a6ae24   Kim Phillips   tools: update che...
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
  		}
  
  # Check if there is UTF-8 in a commit log when a mail header has explicitly
  # declined it, i.e defined some charset where it is missing.
  		if ($in_header_lines &&
  		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
  		    $1 !~ /utf-8/i) {
  			$non_utf8_charset = 1;
  		}
  
  		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
  		    $rawline =~ /$NON_ASCII_UTF8/) {
  			WARN("UTF8_BEFORE_PATCH",
  			    "8-bit UTF-8 used in possible commit log
  " . $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
  # Check for absolute kernel paths in commit message
  		if ($tree && $in_commit_log) {
  			while ($line =~ m{(?:^|\s)(/\S*)}g) {
  				my $file = $1;
  
  				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
  				    check_absolute_file($1, $herecurr)) {
  					#
  				} else {
  					check_absolute_file($file, $herecurr);
  				}
  			}
  		}
c10e0f5b3   Dan Murphy   checkpatch: Port ...
2862
2863
2864
2865
2866
2867
2868
2869
  # Check for various typo / spelling mistakes
  		if (defined($misspellings) &&
  		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
  			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
  				my $typo = $1;
  				my $typo_fix = $spelling_fix{lc($typo)};
  				$typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
  				$typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2870
2871
2872
2873
2874
  				my $msg_level = \&WARN;
  				$msg_level = \&CHK if ($file);
  				if (&{$msg_level}("TYPO_SPELLING",
  						  "'$typo' may be misspelled - perhaps '$typo_fix'?
  " . $herecurr) &&
c10e0f5b3   Dan Murphy   checkpatch: Port ...
2875
2876
2877
2878
2879
  				    $fix) {
  					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
  				}
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
2880
2881
2882
2883
2884
2885
2886
2887
  # ignore non-hunk lines and lines being removed
  		next if (!$hunk_line || $line =~ /^-/);
  
  #trailing whitespace
  		if ($line =~ /^\+.*\015/) {
  			my $herevet = "$here
  " . cat_vet($rawline) . "
  ";
6b9709d91   Tom Rini   scripts: update c...
2888
2889
2890
2891
  			if (ERROR("DOS_LINE_ENDINGS",
  				  "DOS line endings
  " . $herevet) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2892
  				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
6b9709d91   Tom Rini   scripts: update c...
2893
  			}
05622191e   Joe Hershberger   tools: checkpatch...
2894
2895
2896
2897
  		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
  			my $herevet = "$here
  " . cat_vet($rawline) . "
  ";
6b9709d91   Tom Rini   scripts: update c...
2898
2899
2900
2901
  			if (ERROR("TRAILING_WHITESPACE",
  				  "trailing whitespace
  " . $herevet) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
2902
  				$fixed[$fixlinenr] =~ s/\s+$//;
6b9709d91   Tom Rini   scripts: update c...
2903
  			}
05622191e   Joe Hershberger   tools: checkpatch...
2904
2905
  			$rpt_cleaners = 1;
  		}
6b9709d91   Tom Rini   scripts: update c...
2906
2907
  # Check for FSF mailing addresses.
  		if ($rawline =~ /\bwrite to the Free/i ||
6305db960   Heinrich Schuchardt   checkpatch: updat...
2908
  		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
6b9709d91   Tom Rini   scripts: update c...
2909
2910
2911
2912
2913
  		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
  		    $rawline =~ /\b51\s+Franklin\s+St/i) {
  			my $herevet = "$here
  " . cat_vet($rawline) . "
  ";
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2914
2915
2916
2917
2918
  			my $msg_level = \&ERROR;
  			$msg_level = \&CHK if ($file);
  			&{$msg_level}("FSF_MAILING_ADDRESS",
  				      "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.
  " . $herevet)
6b9709d91   Tom Rini   scripts: update c...
2919
  		}
05622191e   Joe Hershberger   tools: checkpatch...
2920
2921
2922
2923
  # check for Kconfig help text having a real description
  # Only applies when adding the entry originally, after that we do not have
  # sufficient context to determine whether it is indeed long enough.
  		if ($realfile =~ /Kconfig/ &&
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2924
2925
2926
2927
  		    # 'choice' is usually the last thing on the line (though
  		    # Kconfig supports named choices), so use a word boundary
  		    # (\b) rather than a whitespace character (\s)
  		    $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
05622191e   Joe Hershberger   tools: checkpatch...
2928
2929
2930
2931
  			my $length = 0;
  			my $cnt = $realcnt;
  			my $ln = $linenr + 1;
  			my $f;
d45a6ae24   Kim Phillips   tools: update che...
2932
  			my $is_start = 0;
05622191e   Joe Hershberger   tools: checkpatch...
2933
  			my $is_end = 0;
d45a6ae24   Kim Phillips   tools: update che...
2934
  			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
05622191e   Joe Hershberger   tools: checkpatch...
2935
2936
2937
  				$f = $lines[$ln - 1];
  				$cnt-- if ($lines[$ln - 1] !~ /^-/);
  				$is_end = $lines[$ln - 1] =~ /^\+/;
05622191e   Joe Hershberger   tools: checkpatch...
2938
2939
  
  				next if ($f =~ /^-/);
6305db960   Heinrich Schuchardt   checkpatch: updat...
2940
  				last if (!$file && $f =~ /^\@\@/);
d45a6ae24   Kim Phillips   tools: update che...
2941

c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2942
  				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
d45a6ae24   Kim Phillips   tools: update che...
2943
  					$is_start = 1;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2944
2945
2946
2947
2948
2949
  				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
  					if ($lines[$ln - 1] =~ "---help---") {
  						WARN("CONFIG_DESCRIPTION",
  						     "prefer 'help' over '---help---' for new help texts
  " . $herecurr);
  					}
d45a6ae24   Kim Phillips   tools: update che...
2950
2951
  					$length = -1;
  				}
05622191e   Joe Hershberger   tools: checkpatch...
2952
2953
2954
2955
  				$f =~ s/^.//;
  				$f =~ s/#.*//;
  				$f =~ s/^\s+//;
  				next if ($f =~ /^$/);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
2956
2957
2958
2959
2960
2961
2962
  
  				# This only checks context lines in the patch
  				# and so hopefully shouldn't trigger false
  				# positives, even though some of these are
  				# common words in help texts
  				if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
  						  if|endif|menu|endmenu|source)\b/x) {
05622191e   Joe Hershberger   tools: checkpatch...
2963
2964
2965
2966
2967
  					$is_end = 1;
  					last;
  				}
  				$length++;
  			}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2968
2969
2970
2971
2972
  			if ($is_start && $is_end && $length < $min_conf_desc_length) {
  				WARN("CONFIG_DESCRIPTION",
  				     "please write a paragraph that describes the config symbol fully
  " . $herecurr);
  			}
d45a6ae24   Kim Phillips   tools: update che...
2973
2974
2975
  			#print "is_start<$is_start> is_end<$is_end> length<$length>
  ";
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
  # check for MAINTAINERS entries that don't have the right form
  		if ($realfile =~ /^MAINTAINERS$/ &&
  		    $rawline =~ /^\+[A-Z]:/ &&
  		    $rawline !~ /^\+[A-Z]:\t\S/) {
  			if (WARN("MAINTAINERS_STYLE",
  				 "MAINTAINERS entries use one tab after TYPE:
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
  			}
  		}
  
  # discourage the use of boolean for type definition attributes of Kconfig options
d45a6ae24   Kim Phillips   tools: update che...
2989
  		if ($realfile =~ /Kconfig/ &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
2990
2991
2992
2993
  		    $line =~ /^\+\s*\bboolean\b/) {
  			WARN("CONFIG_TYPE_BOOLEAN",
  			     "Use of boolean is deprecated, please use bool instead.
  " . $herecurr);
d45a6ae24   Kim Phillips   tools: update che...
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
  		}
  
  		if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
  		    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
  			my $flag = $1;
  			my $replacement = {
  				'EXTRA_AFLAGS' =>   'asflags-y',
  				'EXTRA_CFLAGS' =>   'ccflags-y',
  				'EXTRA_CPPFLAGS' => 'cppflags-y',
  				'EXTRA_LDFLAGS' =>  'ldflags-y',
  			};
  
  			WARN("DEPRECATED_VARIABLE",
  			     "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.
  " . $herecurr) if ($replacement->{$flag});
05622191e   Joe Hershberger   tools: checkpatch...
3009
  		}
6b9709d91   Tom Rini   scripts: update c...
3010
  # check for DT compatible documentation
6305db960   Heinrich Schuchardt   checkpatch: updat...
3011
3012
3013
  		if (defined $root &&
  			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
  			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
6b9709d91   Tom Rini   scripts: update c...
3014
  			my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
6305db960   Heinrich Schuchardt   checkpatch: updat...
3015
3016
  			my $dt_path = $root . "/Documentation/devicetree/bindings/";
  			my $vp_file = $dt_path . "vendor-prefixes.txt";
6b9709d91   Tom Rini   scripts: update c...
3017
3018
  			foreach my $compat (@compats) {
  				my $compat2 = $compat;
6305db960   Heinrich Schuchardt   checkpatch: updat...
3019
3020
3021
3022
  				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
  				my $compat3 = $compat;
  				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
  				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
6b9709d91   Tom Rini   scripts: update c...
3023
3024
3025
3026
3027
  				if ( $? >> 8 ) {
  					WARN("UNDOCUMENTED_DT_STRING",
  					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path
  " . $herecurr);
  				}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3028
3029
3030
  				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
  				my $vendor = $1;
  				`grep -Eq "^$vendor\\b" $vp_file`;
6b9709d91   Tom Rini   scripts: update c...
3031
3032
  				if ( $? >> 8 ) {
  					WARN("UNDOCUMENTED_DT_STRING",
6305db960   Heinrich Schuchardt   checkpatch: updat...
3033
3034
  					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file
  " . $herecurr);
6b9709d91   Tom Rini   scripts: update c...
3035
3036
3037
  				}
  			}
  		}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
  # check for using SPDX license tag at beginning of files
  		if ($realline == $checklicenseline) {
  			if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
  				$checklicenseline = 2;
  			} elsif ($rawline =~ /^\+/) {
  				my $comment = "";
  				if ($realfile =~ /\.(h|s|S)$/) {
  					$comment = '/*';
  				} elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
  					$comment = '//';
  				} elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
  					$comment = '#';
  				} elsif ($realfile =~ /\.rst$/) {
  					$comment = '..';
  				}
  
  				if ($comment !~ /^$/ &&
  				    $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
  					WARN("SPDX_LICENSE_TAG",
  					     "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline
  " . $herecurr);
  				}
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
3062
  # check we are in a valid source file if not then ignore this hunk
6305db960   Heinrich Schuchardt   checkpatch: updat...
3063
  		next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
d45a6ae24   Kim Phillips   tools: update che...
3064

6305db960   Heinrich Schuchardt   checkpatch: updat...
3065
3066
3067
3068
3069
3070
  # line length limit (with some exclusions)
  #
  # There are a few types of lines that may extend beyond $max_line_length:
  #	logging functions like pr_info that end in a string
  #	lines with a single string
  #	#defines that are a single string
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
3071
  #	lines with an RFC3986 like URL
6305db960   Heinrich Schuchardt   checkpatch: updat...
3072
3073
  #
  # There are 3 different line length message types:
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
3074
  # LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
6305db960   Heinrich Schuchardt   checkpatch: updat...
3075
3076
3077
3078
3079
  # LONG_LINE_STRING	a string starts before but extends beyond $max_line_length
  # LONG_LINE		all other lines longer than $max_line_length
  #
  # if LONG_LINE is ignored, the other 2 types are also ignored
  #
05622191e   Joe Hershberger   tools: checkpatch...
3080

6305db960   Heinrich Schuchardt   checkpatch: updat...
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
  		if ($line =~ /^\+/ && $length > $max_line_length) {
  			my $msg_type = "LONG_LINE";
  
  			# Check the allowed long line types first
  
  			# logging functions that end in a string that starts
  			# before $max_line_length
  			if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
  			    length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
  				$msg_type = "";
  
  			# lines with only strings (w/ possible termination)
  			# #defines with only strings
  			} elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
  				 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
  				$msg_type = "";
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
3097
3098
3099
3100
3101
3102
3103
  			# More special cases
  			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
  				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
  				$msg_type = "";
  
  			# URL ($rawline is used in case the URL is in a comment)
  			} elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
  				$msg_type = "";
  
  			# Otherwise set the alternate message types
  
  			# a comment starts before $max_line_length
  			} elsif ($line =~ /($;[\s$;]*)$/ &&
  				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
  				$msg_type = "LONG_LINE_COMMENT"
  
  			# a quoted string starts before $max_line_length
  			} elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
  				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
  				$msg_type = "LONG_LINE_STRING"
6b9709d91   Tom Rini   scripts: update c...
3117
  			}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3118
3119
3120
3121
3122
3123
  			if ($msg_type ne "" &&
  			    (show_type("LONG_LINE") || show_type($msg_type))) {
  				WARN($msg_type,
  				     "line over $max_line_length characters
  " . $herecurr);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3124
3125
3126
3127
3128
3129
3130
3131
  		}
  
  # check for adding lines without a newline.
  		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
  			WARN("MISSING_EOF_NEWLINE",
  			     "adding a line without newline at end of file
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
3132
  # check we are in a valid source file C or perl if not then ignore this hunk
6305db960   Heinrich Schuchardt   checkpatch: updat...
3133
  		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
05622191e   Joe Hershberger   tools: checkpatch...
3134
3135
3136
3137
3138
3139
3140
3141
  
  # at the beginning of a line any tabs must come first and anything
  # more than 8 must use tabs.
  		if ($rawline =~ /^\+\s* \t\s*\S/ ||
  		    $rawline =~ /^\+\s*        \s*/) {
  			my $herevet = "$here
  " . cat_vet($rawline) . "
  ";
05622191e   Joe Hershberger   tools: checkpatch...
3142
  			$rpt_cleaners = 1;
6b9709d91   Tom Rini   scripts: update c...
3143
3144
3145
3146
  			if (ERROR("CODE_INDENT",
  				  "code indent should use tabs where possible
  " . $herevet) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3147
  				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
6b9709d91   Tom Rini   scripts: update c...
3148
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3149
3150
3151
3152
3153
3154
3155
  		}
  
  # check for space before tabs.
  		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
  			my $herevet = "$here
  " . cat_vet($rawline) . "
  ";
6b9709d91   Tom Rini   scripts: update c...
3156
3157
3158
3159
  			if (WARN("SPACE_BEFORE_TAB",
  				"please, no space before tabs
  " . $herevet) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3160
  				while ($fixed[$fixlinenr] =~
e3a4facdf   Joe Perches   checkpatch: remov...
3161
  					   s/(^\+.*) {8,8}\t/$1\t\t/) {}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3162
  				while ($fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
3163
3164
  					   s/(^\+.*) +\t/$1\t/) {}
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3165
  		}
d45a6ae24   Kim Phillips   tools: update che...
3166
3167
3168
3169
3170
3171
  # check for && or || at the start of a line
  		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
  			CHK("LOGICAL_CONTINUATIONS",
  			    "Logical continuations should be on the previous line
  " . $hereprev);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3172
3173
  # check indentation starts on a tab stop
  		if ($^V && $^V ge 5.10.0 &&
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
3174
  		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
  			my $indent = length($1);
  			if ($indent % 8) {
  				if (WARN("TABSTOP",
  					 "Statements should start on a tabstop
  " . $herecurr) &&
  				    $fix) {
  					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
  				}
  			}
  		}
d45a6ae24   Kim Phillips   tools: update che...
3185
3186
  # check multi-line statement indentation matches previous line
  		if ($^V && $^V ge 5.10.0 &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
3187
  		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
d45a6ae24   Kim Phillips   tools: update che...
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
  			$prevline =~ /^\+(\t*)(.*)$/;
  			my $oldindent = $1;
  			my $rest = $2;
  
  			my $pos = pos_last_openparen($rest);
  			if ($pos >= 0) {
  				$line =~ /^(\+| )([ \t]*)/;
  				my $newindent = $2;
  
  				my $goodtabindent = $oldindent .
  					"\t" x ($pos / 8) .
  					" "  x ($pos % 8);
  				my $goodspaceindent = $oldindent . " "  x $pos;
  
  				if ($newindent ne $goodtabindent &&
  				    $newindent ne $goodspaceindent) {
6b9709d91   Tom Rini   scripts: update c...
3204
3205
3206
3207
3208
  
  					if (CHK("PARENTHESIS_ALIGNMENT",
  						"Alignment should match open parenthesis
  " . $hereprev) &&
  					    $fix && $line =~ /^\+/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3209
  						$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
3210
3211
  						    s/^\+[ \t]*/\+$goodtabindent/;
  					}
d45a6ae24   Kim Phillips   tools: update che...
3212
3213
3214
  				}
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3215
3216
3217
3218
3219
3220
3221
3222
3223
  # check for space after cast like "(int) foo" or "(struct foo) bar"
  # avoid checking a few false positives:
  #   "sizeof(<type>)" or "__alignof__(<type>)"
  #   function pointer declarations like "(*foo)(int) = bar;"
  #   structure definitions like "(struct foo) { 0 };"
  #   multiline macros that define functions
  #   known attributes or the __attribute__ keyword
  		if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
  		    (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
6b9709d91   Tom Rini   scripts: update c...
3224
  			if (CHK("SPACING",
6305db960   Heinrich Schuchardt   checkpatch: updat...
3225
3226
  				"No space is necessary after a cast
  " . $herecurr) &&
6b9709d91   Tom Rini   scripts: update c...
3227
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3228
3229
  				$fixed[$fixlinenr] =~
  				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
6b9709d91   Tom Rini   scripts: update c...
3230
  			}
d45a6ae24   Kim Phillips   tools: update che...
3231
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3232
3233
  # Block comment styles
  # Networking with an initial /*
d45a6ae24   Kim Phillips   tools: update che...
3234
  		if ($realfile =~ m@^(drivers/net/|net/)@ &&
6b9709d91   Tom Rini   scripts: update c...
3235
  		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
3236
3237
  		    $rawline =~ /^\+[ \t]*\*/ &&
  		    $realline > 2) {
d45a6ae24   Kim Phillips   tools: update che...
3238
3239
3240
3241
  			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
  			     "networking block comments don't use an empty /* line, use /* Comment...
  " . $hereprev);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3242
3243
3244
  # Block comments use * on subsequent lines
  		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
  		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
6b9709d91   Tom Rini   scripts: update c...
3245
3246
3247
  		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
  		    $rawline =~ /^\+/ &&			#line is new
  		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
6305db960   Heinrich Schuchardt   checkpatch: updat...
3248
3249
3250
  			WARN("BLOCK_COMMENT_STYLE",
  			     "Block comments use * on subsequent lines
  " . $hereprev);
6b9709d91   Tom Rini   scripts: update c...
3251
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3252
3253
  # Block comments use */ on trailing lines
  		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
d45a6ae24   Kim Phillips   tools: update che...
3254
3255
3256
  		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
  		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
  		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
6305db960   Heinrich Schuchardt   checkpatch: updat...
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
  			WARN("BLOCK_COMMENT_STYLE",
  			     "Block comments use a trailing */ on a separate line
  " . $herecurr);
  		}
  
  # Block comment * alignment
  		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
  		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
  		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
  		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
  		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
  		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
  			my $oldindent;
  			$prevrawline =~ m@^\+([ \t]*/?)\*@;
  			if (defined($1)) {
  				$oldindent = expand_tabs($1);
  			} else {
  				$prevrawline =~ m@^\+(.*/?)\*@;
  				$oldindent = expand_tabs($1);
  			}
  			$rawline =~ m@^\+([ \t]*)\*@;
  			my $newindent = $1;
  			$newindent = expand_tabs($newindent);
  			if (length($oldindent) ne length($newindent)) {
  				WARN("BLOCK_COMMENT_STYLE",
  				     "Block comments should align the * on each line
  " . $hereprev);
  			}
  		}
  
  # check for missing blank lines after struct/union declarations
  # with exceptions for various attributes and macros
  		if ($prevline =~ /^[\+ ]};?\s*$/ &&
  		    $line =~ /^\+/ &&
  		    !($line =~ /^\+\s*$/ ||
  		      $line =~ /^\+\s*EXPORT_SYMBOL/ ||
  		      $line =~ /^\+\s*MODULE_/i ||
  		      $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
  		      $line =~ /^\+[a-z_]*init/ ||
  		      $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
  		      $line =~ /^\+\s*DECLARE/ ||
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
3298
  		      $line =~ /^\+\s*builtin_[\w_]*driver/ ||
6305db960   Heinrich Schuchardt   checkpatch: updat...
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
  		      $line =~ /^\+\s*__setup/)) {
  			if (CHK("LINE_SPACING",
  				"Please use a blank line after function/struct/union/enum declarations
  " . $hereprev) &&
  			    $fix) {
  				fix_insert_line($fixlinenr, "\+");
  			}
  		}
  
  # check for multiple consecutive blank lines
  		if ($prevline =~ /^[\+ ]\s*$/ &&
  		    $line =~ /^\+\s*$/ &&
  		    $last_blank_line != ($linenr - 1)) {
  			if (CHK("LINE_SPACING",
  				"Please don't use multiple blank lines
  " . $hereprev) &&
  			    $fix) {
  				fix_delete_line($fixlinenr, $rawline);
  			}
  
  			$last_blank_line = $linenr;
  		}
  
  # check for missing blank lines after declarations
  		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
  			# actual declarations
  		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
  			# function pointer declarations
  		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
  			# foo bar; where foo is some local typedef or #define
  		     $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
  			# known declaration macros
  		     $prevline =~ /^\+\s+$declaration_macros/) &&
  			# for "else if" which can look like "$Ident $Ident"
  		    !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
  			# other possible extensions of declaration lines
  		      $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
  			# not starting a section or a macro "\" extended line
  		      $prevline =~ /(?:\{\s*|\\)$/) &&
  			# looks like a declaration
  		    !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
  			# function pointer declarations
  		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
  			# foo bar; where foo is some local typedef or #define
  		      $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
  			# known declaration macros
  		      $sline =~ /^\+\s+$declaration_macros/ ||
  			# start of struct or union or enum
  		      $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
  			# start or end of block or continuation of declaration
  		      $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
  			# bitfield continuation
  		      $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
  			# other possible extensions of declaration lines
  		      $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
  			# indentation of previous and current line are the same
  		    (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
  			if (WARN("LINE_SPACING",
  				 "Missing a blank line after declarations
  " . $hereprev) &&
  			    $fix) {
  				fix_insert_line($fixlinenr, "\+");
  			}
d45a6ae24   Kim Phillips   tools: update che...
3362
  		}
05622191e   Joe Hershberger   tools: checkpatch...
3363
3364
3365
3366
3367
  # check for spaces at the beginning of a line.
  # Exceptions:
  #  1) within comments
  #  2) indented preprocessor commands
  #  3) hanging labels
6b9709d91   Tom Rini   scripts: update c...
3368
  		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
05622191e   Joe Hershberger   tools: checkpatch...
3369
3370
3371
  			my $herevet = "$here
  " . cat_vet($rawline) . "
  ";
6b9709d91   Tom Rini   scripts: update c...
3372
3373
3374
3375
  			if (WARN("LEADING_SPACE",
  				 "please, no spaces at the start of a line
  " . $herevet) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3376
  				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
6b9709d91   Tom Rini   scripts: update c...
3377
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3378
3379
3380
3381
  		}
  
  # check we are in a valid C source file if not then ignore this hunk
  		next if ($realfile !~ /\.(h|c)$/);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
3382
3383
3384
3385
3386
3387
  # check for unusual line ending [ or (
  		if ($line =~ /^\+.*([\[\(])\s*$/) {
  			CHK("OPEN_ENDED_LINE",
  			    "Lines should not end with a '$1'
  " . $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
  # check if this appears to be the start function declaration, save the name
  		if ($sline =~ /^\+\{\s*$/ &&
  		    $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
  			$context_function = $1;
  		}
  
  # check if this appears to be the end of function declaration
  		if ($sline =~ /^\+\}\s*$/) {
  			undef $context_function;
  		}
  
  # check indentation of any line with a bare else
  # (but not if it is a multiple line "if (foo) return bar; else return baz;")
  # if the previous line is a break or return and is indented 1 tab more...
  		if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
  			my $tabs = length($1) + 1;
  			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
  			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
  			     defined $lines[$linenr] &&
  			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
  				WARN("UNNECESSARY_ELSE",
  				     "else is not generally useful after a break or return
  " . $hereprev);
  			}
  		}
  
  # check indentation of a line with a break;
  # if the previous line is a goto or return and is indented the same # of tabs
  		if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
  			my $tabs = $1;
  			if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
  				WARN("UNNECESSARY_BREAK",
  				     "break is not useful after a goto or return
  " . $hereprev);
  			}
d45a6ae24   Kim Phillips   tools: update che...
3423
  		}
05622191e   Joe Hershberger   tools: checkpatch...
3424
3425
3426
3427
3428
3429
  # check for RCS/CVS revision markers
  		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
  			WARN("CVS_KEYWORD",
  			     "CVS style keyword markers, these will _not_ be updated
  ". $herecurr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
3430
3431
3432
3433
3434
3435
  # check for old HOTPLUG __dev<foo> section markings
  		if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
  			WARN("HOTPLUG_SECTION",
  			     "Using $1 is unnecessary
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
3436
3437
3438
  # Check for potential 'bare' types
  		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
  		    $realline_next);
d45a6ae24   Kim Phillips   tools: update che...
3439
3440
  #print "LINE<$line>
  ";
6305db960   Heinrich Schuchardt   checkpatch: updat...
3441
  		if ($linenr > $suppress_statement &&
6b9709d91   Tom Rini   scripts: update c...
3442
  		    $realcnt && $sline =~ /.\s*\S/) {
05622191e   Joe Hershberger   tools: checkpatch...
3443
3444
3445
3446
3447
3448
3449
3450
  			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
  				ctx_statement_block($linenr, $realcnt, 0);
  			$stat =~ s/
  ./
   /g;
  			$cond =~ s/
  ./
   /g;
d45a6ae24   Kim Phillips   tools: update che...
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
  #print "linenr<$linenr> <$stat>
  ";
  			# If this statement has no statement boundaries within
  			# it there is no point in retrying a statement scan
  			# until we hit end of it.
  			my $frag = $stat; $frag =~ s/;+\s*$//;
  			if ($frag !~ /(?:{|;)/) {
  #print "skip<$line_nr_next>
  ";
  				$suppress_statement = $line_nr_next;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
  			# Find the real next line.
  			$realline_next = $line_nr_next;
  			if (defined $realline_next &&
  			    (!defined $lines[$realline_next - 1] ||
  			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
  				$realline_next++;
  			}
  
  			my $s = $stat;
  			$s =~ s/{.*$//s;
  
  			# Ignore goto labels.
  			if ($s =~ /$Ident:\*$/s) {
  
  			# Ignore functions being called
  			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
  
  			} elsif ($s =~ /^.\s*else\b/s) {
  
  			# declarations always start with types
  			} 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) {
  				my $type = $1;
  				$type =~ s/\s+/ /g;
  				possible($type, "A:" . $s);
  
  			# definitions in global scope can only start with types
  			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
  				possible($1, "B:" . $s);
  			}
  
  			# any (foo ... *) is a pointer cast, and foo is a type
  			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
  				possible($1, "C:" . $s);
  			}
  
  			# Check for any sort of function declaration.
  			# int foo(something bar, other baz);
  			# void (*store_gdt)(x86_descr_ptr *);
  			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
  				my ($name_len) = length($1);
  
  				my $ctx = $s;
  				substr($ctx, 0, $name_len + 1, '');
  				$ctx =~ s/\)[^\)]*$//;
  
  				for my $arg (split(/\s*,\s*/, $ctx)) {
  					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
  
  						possible($1, "D:" . $s);
  					}
  				}
  			}
  
  		}
  
  #
  # Checks which may be anchored in the context.
  #
  
  # Check for switch () and associated case and default
  # statements should be at the same indent.
  		if ($line=~/\bswitch\s*\(.*\)/) {
  			my $err = '';
  			my $sep = '';
  			my @ctx = ctx_block_outer($linenr, $realcnt);
  			shift(@ctx);
  			for my $ctx (@ctx) {
  				my ($clen, $cindent) = line_stats($ctx);
  				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
  							$indent != $cindent) {
  					$err .= "$sep$ctx
  ";
  					$sep = '';
  				} else {
  					$sep = "[...]
  ";
  				}
  			}
  			if ($err ne '') {
  				ERROR("SWITCH_CASE_INDENT_LEVEL",
  				      "switch and case should be at the same indent
  $hereline$err");
  			}
  		}
  
  # if/while/etc brace do not go on next line, unless defining a do while loop,
  # or if that brace on the next line is for something else
6305db960   Heinrich Schuchardt   checkpatch: updat...
3549
  		if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
05622191e   Joe Hershberger   tools: checkpatch...
3550
3551
3552
  			my $pre_ctx = "$1$2";
  
  			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
d45a6ae24   Kim Phillips   tools: update che...
3553
3554
3555
3556
3557
3558
  
  			if ($line =~ /^\+\t{6,}/) {
  				WARN("DEEP_INDENTATION",
  				     "Too many leading tabs - consider code refactoring
  " . $herecurr);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
  			my $ctx_cnt = $realcnt - $#ctx - 1;
  			my $ctx = join("
  ", @ctx);
  
  			my $ctx_ln = $linenr;
  			my $ctx_skip = $realcnt;
  
  			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
  					defined $lines[$ctx_ln - 1] &&
  					$lines[$ctx_ln - 1] =~ /^-/)) {
  				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>
  ";
  				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
  				$ctx_ln++;
  			}
  
  			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>
  ";
  			#print "pre<$pre_ctx>
  line<$line>
  ctx<$ctx>
  next<$lines[$ctx_ln - 1]>
  ";
6305db960   Heinrich Schuchardt   checkpatch: updat...
3582
  			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
05622191e   Joe Hershberger   tools: checkpatch...
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
  				ERROR("OPEN_BRACE",
  				      "that open brace { should be on the previous line
  " .
  					"$here
  $ctx
  $rawlines[$ctx_ln - 1]
  ");
  			}
  			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
  			    $ctx =~ /\)\s*\;\s*$/ &&
  			    defined $lines[$ctx_ln - 1])
  			{
  				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
  				if ($nindent > $indent) {
  					WARN("TRAILING_SEMICOLON",
  					     "trailing semicolon indicates no statements, indent implies otherwise
  " .
  						"$here
  $ctx
  $rawlines[$ctx_ln - 1]
  ");
  				}
  			}
  		}
  
  # Check relative indent for conditionals and blocks.
6305db960   Heinrich Schuchardt   checkpatch: updat...
3609
  		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
d45a6ae24   Kim Phillips   tools: update che...
3610
3611
3612
  			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
  				ctx_statement_block($linenr, $realcnt, 0)
  					if (!defined $stat);
05622191e   Joe Hershberger   tools: checkpatch...
3613
3614
3615
  			my ($s, $c) = ($stat, $cond);
  
  			substr($s, 0, length($c), '');
6305db960   Heinrich Schuchardt   checkpatch: updat...
3616
3617
3618
  			# remove inline comments
  			$s =~ s/$;/ /g;
  			$c =~ s/$;/ /g;
05622191e   Joe Hershberger   tools: checkpatch...
3619
3620
3621
3622
3623
  
  			# Find out how long the conditional actually is.
  			my @newlines = ($c =~ /
  /gs);
  			my $cond_lines = 1 + $#newlines;
6305db960   Heinrich Schuchardt   checkpatch: updat...
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
  			# Make sure we remove the line prefixes as we have
  			# none on the first line, and are going to readd them
  			# where necessary.
  			$s =~ s/
  ./
  /gs;
  			while ($s =~ /
  \s+\\
  /) {
  				$cond_lines += $s =~ s/
  \s+\\
  /
  /g;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
  			# We want to check the first line inside the block
  			# starting at the end of the conditional, so remove:
  			#  1) any blank line termination
  			#  2) any opening brace { on end of the line
  			#  3) any do (...) {
  			my $continuation = 0;
  			my $check = 0;
  			$s =~ s/^.*\bdo\b//;
  			$s =~ s/^\s*{//;
  			if ($s =~ s/^\s*\\//) {
  				$continuation = 1;
  			}
  			if ($s =~ s/^\s*?
  //) {
  				$check = 1;
  				$cond_lines++;
  			}
  
  			# Also ignore a loop construct at the end of a
  			# preprocessor statement.
  			if (($prevline =~ /^.\s*#\s*define\s/ ||
  			    $prevline =~ /\\\s*$/) && $continuation == 0) {
  				$check = 0;
  			}
  
  			my $cond_ptr = -1;
  			$continuation = 0;
  			while ($cond_ptr != $cond_lines) {
  				$cond_ptr = $cond_lines;
  
  				# If we see an #else/#elif then the code
  				# is not linear.
  				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
  					$check = 0;
  				}
  
  				# Ignore:
  				#  1) blank lines, they should be at 0,
  				#  2) preprocessor lines, and
  				#  3) labels.
  				if ($continuation ||
  				    $s =~ /^\s*?
  / ||
  				    $s =~ /^\s*#\s*?/ ||
  				    $s =~ /^\s*$Ident\s*:/) {
  					$continuation = ($s =~ /^.*?\\
  /) ? 1 : 0;
  					if ($s =~ s/^.*?
  //) {
  						$cond_lines++;
  					}
  				}
  			}
  
  			my (undef, $sindent) = line_stats("+" . $s);
  			my $stat_real = raw_line($linenr, $cond_lines);
  
  			# Check if either of these lines are modified, else
  			# this is not this patch's fault.
  			if (!defined($stat_real) ||
  			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
  				$check = 0;
  			}
  			if (defined($stat_real) && $cond_lines > 1) {
  				$stat_real = "[...]
  $stat_real";
  			}
  
  			#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>
  ";
6305db960   Heinrich Schuchardt   checkpatch: updat...
3708
3709
3710
3711
3712
3713
  			if ($check && $s ne '' &&
  			    (($sindent % 8) != 0 ||
  			     ($sindent < $indent) ||
  			     ($sindent == $indent &&
  			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
  			     ($sindent > $indent + 8))) {
05622191e   Joe Hershberger   tools: checkpatch...
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
  				WARN("SUSPECT_CODE_INDENT",
  				     "suspect code indent for conditional statements ($indent, $sindent)
  " . $herecurr . "$stat_real
  ");
  			}
  		}
  
  		# Track the 'values' across context and added lines.
  		my $opline = $line; $opline =~ s/^./ /;
  		my ($curr_values, $curr_vars) =
  				annotate_values($opline . "
  ", $prev_values);
  		$curr_values = $prev_values . $curr_values;
  		if ($dbg_values) {
  			my $outline = $opline; $outline =~ s/\t/ /g;
  			print "$linenr > .$outline
  ";
  			print "$linenr > $curr_values
  ";
  			print "$linenr >  $curr_vars
  ";
  		}
  		$prev_values = substr($curr_values, -1);
  
  #ignore lines not being added
6b9709d91   Tom Rini   scripts: update c...
3739
  		next if ($line =~ /^[^\+]/);
05622191e   Joe Hershberger   tools: checkpatch...
3740

6305db960   Heinrich Schuchardt   checkpatch: updat...
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
  # check for dereferences that span multiple lines
  		if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
  		    $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
  			$prevline =~ /($Lval\s*(?:\.|->))\s*$/;
  			my $ref = $1;
  			$line =~ /^.\s*($Lval)/;
  			$ref .= $1;
  			$ref =~ s/\s//g;
  			WARN("MULTILINE_DEREFERENCE",
  			     "Avoid multiple line dereference - prefer '$ref'
  " . $hereprev);
  		}
  
  # check for declarations of signed or unsigned without int
  		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
  			my $type = $1;
  			my $var = $2;
  			$var = "" if (!defined $var);
  			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
  				my $sign = $1;
  				my $pointer = $2;
  
  				$pointer = "" if (!defined $pointer);
  
  				if (WARN("UNSPECIFIED_INT",
  					 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'
  " . $herecurr) &&
  				    $fix) {
  					my $decl = trim($sign) . " int ";
  					my $comp_pointer = $pointer;
  					$comp_pointer =~ s/\s//g;
  					$decl .= $comp_pointer;
  					$decl = rtrim($decl) if ($var eq "");
  					$fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
  				}
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
  # TEST: allow direct testing of the type matcher.
  		if ($dbg_type) {
  			if ($line =~ /^.\s*$Declare\s*$/) {
  				ERROR("TEST_TYPE",
  				      "TEST: is type
  " . $herecurr);
  			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
  				ERROR("TEST_NOT_TYPE",
  				      "TEST: is not type ($1 is)
  ". $herecurr);
  			}
  			next;
  		}
  # TEST: allow direct testing of the attribute matcher.
  		if ($dbg_attr) {
  			if ($line =~ /^.\s*$Modifier\s*$/) {
  				ERROR("TEST_ATTR",
  				      "TEST: is attr
  " . $herecurr);
  			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
  				ERROR("TEST_NOT_ATTR",
  				      "TEST: is not attr ($1 is)
  ". $herecurr);
  			}
  			next;
  		}
  
  # check for initialisation to aggregates open brace on the next line
  		if ($line =~ /^.\s*{/ &&
  		    $prevline =~ /(?:^|[^=])=\s*$/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
  			if (ERROR("OPEN_BRACE",
  				  "that open brace { should be on the previous line
  " . $hereprev) &&
  			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
  				fix_delete_line($fixlinenr - 1, $prevrawline);
  				fix_delete_line($fixlinenr, $rawline);
  				my $fixedline = $prevrawline;
  				$fixedline =~ s/\s*=\s*$/ = {/;
  				fix_insert_line($fixlinenr, $fixedline);
  				$fixedline = $line;
  				$fixedline =~ s/^(.\s*)\{\s*/$1/;
  				fix_insert_line($fixlinenr, $fixedline);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
  		}
  
  #
  # Checks which are anchored on the added line.
  #
  
  # check for malformed paths in #include statements (uses RAW line)
  		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
  			my $path = $1;
  			if ($path =~ m{//}) {
  				ERROR("MALFORMED_INCLUDE",
d45a6ae24   Kim Phillips   tools: update che...
3832
3833
3834
3835
3836
3837
3838
  				      "malformed #include filename
  " . $herecurr);
  			}
  			if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
  				ERROR("UAPI_INCLUDE",
  				      "No #include in ...include/uapi/... should use a uapi/ path prefix
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
3839
3840
3841
3842
3843
  			}
  		}
  
  # no C99 // comments
  		if ($line =~ m{//}) {
6b9709d91   Tom Rini   scripts: update c...
3844
3845
3846
3847
  			if (ERROR("C99_COMMENTS",
  				  "do not use C99 // comments
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3848
  				my $line = $fixed[$fixlinenr];
6b9709d91   Tom Rini   scripts: update c...
3849
3850
  				if ($line =~ /\/\/(.*)$/) {
  					my $comment = trim($1);
6305db960   Heinrich Schuchardt   checkpatch: updat...
3851
  					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
6b9709d91   Tom Rini   scripts: update c...
3852
3853
  				}
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
  		}
  		# Remove C99 comments.
  		$line =~ s@//.*@@;
  		$opline =~ s@//.*@@;
  
  # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
  # the whole statement.
  #print "APW <$lines[$realline_next - 1]>
  ";
  		if (defined $realline_next &&
  		    exists $lines[$realline_next - 1] &&
  		    !defined $suppress_export{$realline_next} &&
  		    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
  		     $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
  			# Handle definitions which produce identifiers with
  			# a prefix:
  			#   XXX(foo);
  			#   EXPORT_SYMBOL(something_foo);
  			my $name = $1;
d45a6ae24   Kim Phillips   tools: update che...
3873
3874
  			if ($stat =~ /^(?:.\s*}\s*
  )?.([A-Z_]+)\s*\(\s*($Ident)/ &&
05622191e   Joe Hershberger   tools: checkpatch...
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
  			    $name =~ /^${Ident}_$2/) {
  #print "FOO C name<$name>
  ";
  				$suppress_export{$realline_next} = 1;
  
  			} elsif ($stat !~ /(?:
  				
  .}\s*$|
  				^.DEFINE_$Ident\(\Q$name\E\)|
  				^.DECLARE_$Ident\(\Q$name\E\)|
  				^.LIST_HEAD\(\Q$name\E\)|
  				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
  				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
  			    )/x) {
  #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>
  ";
  				$suppress_export{$realline_next} = 2;
  			} else {
  				$suppress_export{$realline_next} = 1;
  			}
  		}
  		if (!defined $suppress_export{$linenr} &&
  		    $prevline =~ /^.\s*$/ &&
  		    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
  		     $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
  #print "FOO B <$lines[$linenr - 1]>
  ";
  			$suppress_export{$linenr} = 2;
  		}
  		if (defined $suppress_export{$linenr} &&
  		    $suppress_export{$linenr} == 2) {
  			WARN("EXPORT_SYMBOL",
  			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable
  " . $herecurr);
  		}
  
  # check for global initialisers.
6305db960   Heinrich Schuchardt   checkpatch: updat...
3912
  		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
6b9709d91   Tom Rini   scripts: update c...
3913
  			if (ERROR("GLOBAL_INITIALISERS",
6305db960   Heinrich Schuchardt   checkpatch: updat...
3914
3915
  				  "do not initialise globals to $1
  " . $herecurr) &&
6b9709d91   Tom Rini   scripts: update c...
3916
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3917
  				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
6b9709d91   Tom Rini   scripts: update c...
3918
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3919
3920
  		}
  # check for static initialisers.
6305db960   Heinrich Schuchardt   checkpatch: updat...
3921
  		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
6b9709d91   Tom Rini   scripts: update c...
3922
  			if (ERROR("INITIALISED_STATIC",
6305db960   Heinrich Schuchardt   checkpatch: updat...
3923
3924
  				  "do not initialise statics to $1
  " .
6b9709d91   Tom Rini   scripts: update c...
3925
3926
  				      $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3927
  				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
6b9709d91   Tom Rini   scripts: update c...
3928
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3929
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
3930
3931
3932
3933
3934
3935
3936
  # check for misordered declarations of char/short/int/long with signed/unsigned
  		while ($sline =~ m{(\b$TypeMisordered\b)}g) {
  			my $tmp = trim($1);
  			WARN("MISORDERED_TYPE",
  			     "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
  # check for static const char * arrays.
  		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
  			WARN("STATIC_CONST_CHAR_ARRAY",
  			     "static const char * array should probably be static const char * const
  " .
  				$herecurr);
                 }
  
  # check for static char foo[] = "bar" declarations.
  		if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
  			WARN("STATIC_CONST_CHAR_ARRAY",
  			     "static char array declaration should probably be static const char
  " .
  				$herecurr);
                 }
6305db960   Heinrich Schuchardt   checkpatch: updat...
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
  # check for const <foo> const where <foo> is not a pointer or array type
  		if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
  			my $found = $1;
  			if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
  				WARN("CONST_CONST",
  				     "'const $found const *' should probably be 'const $found * const'
  " . $herecurr);
  			} elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
  				WARN("CONST_CONST",
  				     "'const $found const' should probably be 'const $found'
  " . $herecurr);
  			}
  		}
  
  # check for non-global char *foo[] = {"bar", ...} declarations.
  		if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
  			WARN("STATIC_CONST_CHAR_ARRAY",
  			     "char * array declaration might be better as static const
  " .
  				$herecurr);
                 }
  
  # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
  		if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
  			my $array = $1;
  			if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
  				my $array_div = $1;
  				if (WARN("ARRAY_SIZE",
  					 "Prefer ARRAY_SIZE($array)
  " . $herecurr) &&
  				    $fix) {
  					$fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
  				}
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
3987
3988
3989
3990
3991
3992
  # check for function declarations without arguments like "int foo()"
  		if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
  			if (ERROR("FUNCTION_WITHOUT_ARGS",
  				  "Bad function definition - $1() should probably be $1(void)
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
3993
  				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
6b9709d91   Tom Rini   scripts: update c...
3994
  			}
05622191e   Joe Hershberger   tools: checkpatch...
3995
3996
3997
3998
3999
4000
4001
4002
  		}
  
  # check for new typedefs, only function parameters and sparse annotations
  # make sense.
  		if ($line =~ /\btypedef\s/ &&
  		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
  		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
  		    $line !~ /\b$typeTypedefs\b/ &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
4003
  		    $line !~ /\b__bitwise\b/) {
05622191e   Joe Hershberger   tools: checkpatch...
4004
4005
4006
4007
4008
4009
4010
  			WARN("NEW_TYPEDEFS",
  			     "do not add new typedefs
  " . $herecurr);
  		}
  
  # * goes on variable not on type
  		# (char*[ const])
d45a6ae24   Kim Phillips   tools: update che...
4011
4012
4013
  		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
  			#print "AA<$1>
  ";
6b9709d91   Tom Rini   scripts: update c...
4014
  			my ($ident, $from, $to) = ($1, $2, $2);
05622191e   Joe Hershberger   tools: checkpatch...
4015
4016
4017
4018
4019
4020
4021
4022
  
  			# Should start with a space.
  			$to =~ s/^(\S)/ $1/;
  			# Should not end with a space.
  			$to =~ s/\s+$//;
  			# '*'s should not have spaces between.
  			while ($to =~ s/\*\s+\*/\*\*/) {
  			}
6b9709d91   Tom Rini   scripts: update c...
4023
4024
  ##			print "1: from<$from> to<$to> ident<$ident>
  ";
05622191e   Joe Hershberger   tools: checkpatch...
4025
  			if ($from ne $to) {
6b9709d91   Tom Rini   scripts: update c...
4026
4027
4028
4029
4030
4031
4032
  				if (ERROR("POINTER_LOCATION",
  					  "\"(foo$from)\" should be \"(foo$to)\"
  " .  $herecurr) &&
  				    $fix) {
  					my $sub_from = $ident;
  					my $sub_to = $ident;
  					$sub_to =~ s/\Q$from\E/$to/;
6305db960   Heinrich Schuchardt   checkpatch: updat...
4033
  					$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4034
4035
  					    s@\Q$sub_from\E@$sub_to@;
  				}
05622191e   Joe Hershberger   tools: checkpatch...
4036
  			}
d45a6ae24   Kim Phillips   tools: update che...
4037
4038
4039
4040
  		}
  		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
  			#print "BB<$1>
  ";
6b9709d91   Tom Rini   scripts: update c...
4041
  			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
05622191e   Joe Hershberger   tools: checkpatch...
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
  
  			# Should start with a space.
  			$to =~ s/^(\S)/ $1/;
  			# Should not end with a space.
  			$to =~ s/\s+$//;
  			# '*'s should not have spaces between.
  			while ($to =~ s/\*\s+\*/\*\*/) {
  			}
  			# Modifiers should have spaces.
  			$to =~ s/(\b$Modifier$)/$1 /;
6b9709d91   Tom Rini   scripts: update c...
4052
4053
  ##			print "2: from<$from> to<$to> ident<$ident>
  ";
05622191e   Joe Hershberger   tools: checkpatch...
4054
  			if ($from ne $to && $ident !~ /^$Modifier$/) {
6b9709d91   Tom Rini   scripts: update c...
4055
4056
4057
4058
4059
4060
4061
4062
  				if (ERROR("POINTER_LOCATION",
  					  "\"foo${from}bar\" should be \"foo${to}bar\"
  " .  $herecurr) &&
  				    $fix) {
  
  					my $sub_from = $match;
  					my $sub_to = $match;
  					$sub_to =~ s/\Q$from\E/$to/;
6305db960   Heinrich Schuchardt   checkpatch: updat...
4063
  					$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4064
4065
  					    s@\Q$sub_from\E@$sub_to@;
  				}
05622191e   Joe Hershberger   tools: checkpatch...
4066
4067
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4068
4069
  # avoid BUG() or BUG_ON()
  		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
4070
4071
4072
4073
4074
  			my $msg_level = \&WARN;
  			$msg_level = \&CHK if ($file);
  			&{$msg_level}("AVOID_BUG",
  				      "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()
  " . $herecurr);
6305db960   Heinrich Schuchardt   checkpatch: updat...
4075
  		}
05622191e   Joe Hershberger   tools: checkpatch...
4076

6305db960   Heinrich Schuchardt   checkpatch: updat...
4077
  # avoid LINUX_VERSION_CODE
05622191e   Joe Hershberger   tools: checkpatch...
4078
4079
4080
4081
4082
4083
4084
4085
4086
  		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
  			WARN("LINUX_VERSION_CODE",
  			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged
  " . $herecurr);
  		}
  
  # check for uses of printk_ratelimit
  		if ($line =~ /\bprintk_ratelimit\s*\(/) {
  			WARN("PRINTK_RATELIMITED",
6305db960   Heinrich Schuchardt   checkpatch: updat...
4087
4088
  			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
4089
  		}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
4090
4091
4092
4093
4094
  # printk should use KERN_* levels
  		if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
  			WARN("PRINTK_WITHOUT_KERN_LEVEL",
  			     "printk() should include KERN_<LEVEL> facility level
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
4095
  		}
d45a6ae24   Kim Phillips   tools: update che...
4096
4097
4098
4099
4100
4101
4102
  		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
  			my $orig = $1;
  			my $level = lc($orig);
  			$level = "warn" if ($level eq "warning");
  			my $level2 = $level;
  			$level2 = "dbg" if ($level eq "debug");
  			WARN("PREFER_PR_LEVEL",
6305db960   Heinrich Schuchardt   checkpatch: updat...
4103
4104
  			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...
  " . $herecurr);
d45a6ae24   Kim Phillips   tools: update che...
4105
4106
4107
  		}
  
  		if ($line =~ /\bpr_warning\s*\(/) {
6b9709d91   Tom Rini   scripts: update c...
4108
4109
4110
4111
  			if (WARN("PREFER_PR_LEVEL",
  				 "Prefer pr_warn(... to pr_warning(...
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4112
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4113
4114
  				    s/\bpr_warning\b/pr_warn/;
  			}
d45a6ae24   Kim Phillips   tools: update che...
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
  		}
  
  		if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
  			my $orig = $1;
  			my $level = lc($orig);
  			$level = "warn" if ($level eq "warning");
  			$level = "dbg" if ($level eq "debug");
  			WARN("PREFER_DEV_LEVEL",
  			     "Prefer dev_$level(... to dev_printk(KERN_$orig, ...
  " . $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4126
4127
4128
4129
4130
4131
4132
4133
  # ENOSYS means "bad syscall nr" and nothing else.  This will have a small
  # number of false positives, but assembly files are not checked, so at
  # least the arch entry code will not trigger this warning.
  		if ($line =~ /\bENOSYS\b/) {
  			WARN("ENOSYS",
  			     "ENOSYS means 'invalid syscall nr' and nothing else
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
4134
4135
  # function brace can't be on same line, except for #defines of do while,
  # or if closed on same line
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
4136
4137
4138
4139
  		if ($^V && $^V ge 5.10.0 &&
  		    $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
  		    $sline !~ /\#\s*define\b.*do\s*\{/ &&
  		    $sline !~ /}/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4140
  			if (ERROR("OPEN_BRACE",
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
4141
4142
  				  "open brace '{' following function definitions go on the next line
  " . $herecurr) &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
  			    $fix) {
  				fix_delete_line($fixlinenr, $rawline);
  				my $fixed_line = $rawline;
  				$fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
  				my $line1 = $1;
  				my $line2 = $2;
  				fix_insert_line($fixlinenr, ltrim($line1));
  				fix_insert_line($fixlinenr, "\+{");
  				if ($line2 !~ /^\s*$/) {
  					fix_insert_line($fixlinenr, "\+\t" . trim($line2));
  				}
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4155
4156
4157
4158
4159
  		}
  
  # open braces for enum, union and struct go on the same line.
  		if ($line =~ /^.\s*{/ &&
  		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
  			if (ERROR("OPEN_BRACE",
  				  "open brace '{' following $1 go on the same line
  " . $hereprev) &&
  			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
  				fix_delete_line($fixlinenr - 1, $prevrawline);
  				fix_delete_line($fixlinenr, $rawline);
  				my $fixedline = rtrim($prevrawline) . " {";
  				fix_insert_line($fixlinenr, $fixedline);
  				$fixedline = $rawline;
  				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
  				if ($fixedline !~ /^\+\s*$/) {
  					fix_insert_line($fixlinenr, $fixedline);
  				}
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4174
4175
4176
  		}
  
  # missing space after union, struct or enum definition
6b9709d91   Tom Rini   scripts: update c...
4177
4178
4179
4180
4181
  		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
  			if (WARN("SPACING",
  				 "missing space after $1 definition
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4182
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4183
4184
4185
4186
4187
4188
4189
  				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
  			}
  		}
  
  # Function pointer declarations
  # check spacing between type, funcptr, and args
  # canonical declaration is "type (*funcptr)(args...)"
6305db960   Heinrich Schuchardt   checkpatch: updat...
4190
  		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
6b9709d91   Tom Rini   scripts: update c...
4191
4192
4193
4194
4195
4196
  			my $declare = $1;
  			my $pre_pointer_space = $2;
  			my $post_pointer_space = $3;
  			my $funcname = $4;
  			my $post_funcname_space = $5;
  			my $pre_args_space = $6;
6305db960   Heinrich Schuchardt   checkpatch: updat...
4197
4198
4199
4200
4201
4202
4203
4204
4205
  # the $Declare variable will capture all spaces after the type
  # so check it for a missing trailing missing space but pointer return types
  # don't need a space so don't warn for those.
  			my $post_declare_space = "";
  			if ($declare =~ /(\s+)$/) {
  				$post_declare_space = $1;
  				$declare = rtrim($declare);
  			}
  			if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
6b9709d91   Tom Rini   scripts: update c...
4206
4207
4208
  				WARN("SPACING",
  				     "missing space after return type
  " . $herecurr);
6305db960   Heinrich Schuchardt   checkpatch: updat...
4209
  				$post_declare_space = " ";
6b9709d91   Tom Rini   scripts: update c...
4210
4211
4212
  			}
  
  # unnecessary space "type  (*funcptr)(args...)"
6305db960   Heinrich Schuchardt   checkpatch: updat...
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
  # This test is not currently implemented because these declarations are
  # equivalent to
  #	int  foo(int bar, ...)
  # and this is form shouldn't/doesn't generate a checkpatch warning.
  #
  #			elsif ($declare =~ /\s{2,}$/) {
  #				WARN("SPACING",
  #				     "Multiple spaces after return type
  " . $herecurr);
  #			}
6b9709d91   Tom Rini   scripts: update c...
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
  
  # unnecessary space "type ( *funcptr)(args...)"
  			if (defined $pre_pointer_space &&
  			    $pre_pointer_space =~ /^\s/) {
  				WARN("SPACING",
  				     "Unnecessary space after function pointer open parenthesis
  " . $herecurr);
  			}
  
  # unnecessary space "type (* funcptr)(args...)"
  			if (defined $post_pointer_space &&
  			    $post_pointer_space =~ /^\s/) {
  				WARN("SPACING",
  				     "Unnecessary space before function pointer name
  " . $herecurr);
  			}
  
  # unnecessary space "type (*funcptr )(args...)"
  			if (defined $post_funcname_space &&
  			    $post_funcname_space =~ /^\s/) {
  				WARN("SPACING",
  				     "Unnecessary space after function pointer name
  " . $herecurr);
  			}
  
  # unnecessary space "type (*funcptr) (args...)"
  			if (defined $pre_args_space &&
  			    $pre_args_space =~ /^\s/) {
  				WARN("SPACING",
  				     "Unnecessary space before function pointer arguments
  " . $herecurr);
  			}
  
  			if (show_type("SPACING") && $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4257
4258
  				$fixed[$fixlinenr] =~
  				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
6b9709d91   Tom Rini   scripts: update c...
4259
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
  		}
  
  # check for spacing round square brackets; allowed:
  #  1. with a type on the left -- int [] a;
  #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
  #  3. inside a curly brace -- = { [0...10] = 5 }
  		while ($line =~ /(.*?\s)\[/g) {
  			my ($where, $prefix) = ($-[1], $1);
  			if ($prefix !~ /$Type\s+$/ &&
  			    ($where != 0 || $prefix !~ /^.\s+$/) &&
d45a6ae24   Kim Phillips   tools: update che...
4270
  			    $prefix !~ /[{,]\s+$/) {
6b9709d91   Tom Rini   scripts: update c...
4271
4272
4273
4274
  				if (ERROR("BRACKET_SPACE",
  					  "space prohibited before open square bracket '['
  " . $herecurr) &&
  				    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4275
  				    $fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4276
4277
  					s/^(\+.*?)\s+\[/$1\[/;
  				}
05622191e   Joe Hershberger   tools: checkpatch...
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
  			}
  		}
  
  # check for spaces between functions and their parentheses.
  		while ($line =~ /($Ident)\s+\(/g) {
  			my $name = $1;
  			my $ctx_before = substr($line, 0, $-[1]);
  			my $ctx = "$ctx_before$name";
  
  			# Ignore those directives where spaces _are_ permitted.
  			if ($name =~ /^(?:
  				if|for|while|switch|return|case|
  				volatile|__volatile__|
  				__attribute__|format|__extension__|
  				asm|__asm__)$/x)
  			{
05622191e   Joe Hershberger   tools: checkpatch...
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
  			# cpp #define statements have non-optional spaces, ie
  			# if there is a space between the name and the open
  			# parenthesis it is simply not a parameter group.
  			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
  
  			# cpp #elif statement condition may start with a (
  			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
  
  			# If this whole things ends with a type its most
  			# likely a typedef for a function.
  			} elsif ($ctx =~ /$Type$/) {
  
  			} else {
6b9709d91   Tom Rini   scripts: update c...
4307
4308
4309
4310
  				if (WARN("SPACING",
  					 "space prohibited between function name and open parenthesis '('
  " . $herecurr) &&
  					     $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4311
  					$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4312
4313
  					    s/\b$name\s+\(/$name\(/;
  				}
05622191e   Joe Hershberger   tools: checkpatch...
4314
4315
  			}
  		}
d45a6ae24   Kim Phillips   tools: update che...
4316

05622191e   Joe Hershberger   tools: checkpatch...
4317
4318
  # Check operator spacing.
  		if (!($line=~/\#\s*include/)) {
6b9709d91   Tom Rini   scripts: update c...
4319
4320
  			my $fixed_line = "";
  			my $line_fixed = 0;
05622191e   Joe Hershberger   tools: checkpatch...
4321
4322
4323
4324
4325
  			my $ops = qr{
  				<<=|>>=|<=|>=|==|!=|
  				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
  				=>|->|<<|>>|<|>|=|!|~|
  				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
6b9709d91   Tom Rini   scripts: update c...
4326
  				\?:|\?|:
05622191e   Joe Hershberger   tools: checkpatch...
4327
4328
  			}x;
  			my @elements = split(/($ops|;)/, $opline);
6b9709d91   Tom Rini   scripts: update c...
4329
4330
4331
4332
4333
4334
4335
4336
4337
  
  ##			print("element count: <" . $#elements . ">
  ");
  ##			foreach my $el (@elements) {
  ##				print("el: <$el>
  ");
  ##			}
  
  			my @fix_elements = ();
05622191e   Joe Hershberger   tools: checkpatch...
4338
  			my $off = 0;
6b9709d91   Tom Rini   scripts: update c...
4339
4340
4341
4342
4343
4344
  			foreach my $el (@elements) {
  				push(@fix_elements, substr($rawline, $off, length($el)));
  				$off += length($el);
  			}
  
  			$off = 0;
05622191e   Joe Hershberger   tools: checkpatch...
4345
  			my $blank = copy_spacing($opline);
6b9709d91   Tom Rini   scripts: update c...
4346
  			my $last_after = -1;
05622191e   Joe Hershberger   tools: checkpatch...
4347
4348
  
  			for (my $n = 0; $n < $#elements; $n += 2) {
6b9709d91   Tom Rini   scripts: update c...
4349
4350
4351
4352
4353
  
  				my $good = $fix_elements[$n] . $fix_elements[$n + 1];
  
  ##				print("n: <$n> good: <$good>
  ");
05622191e   Joe Hershberger   tools: checkpatch...
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
  				$off += length($elements[$n]);
  
  				# Pick up the preceding and succeeding characters.
  				my $ca = substr($opline, 0, $off);
  				my $cc = '';
  				if (length($opline) >= ($off + length($elements[$n + 1]))) {
  					$cc = substr($opline, $off + length($elements[$n + 1]));
  				}
  				my $cb = "$ca$;$cc";
  
  				my $a = '';
  				$a = 'V' if ($elements[$n] ne '');
  				$a = 'W' if ($elements[$n] =~ /\s$/);
  				$a = 'C' if ($elements[$n] =~ /$;$/);
  				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
  				$a = 'O' if ($elements[$n] eq '');
  				$a = 'E' if ($ca =~ /^\s*$/);
  
  				my $op = $elements[$n + 1];
  
  				my $c = '';
  				if (defined $elements[$n + 2]) {
  					$c = 'V' if ($elements[$n + 2] ne '');
  					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
  					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
  					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
  					$c = 'O' if ($elements[$n + 2] eq '');
  					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
  				} else {
  					$c = 'E';
  				}
  
  				my $ctx = "${a}x${c}";
  
  				my $at = "(ctx:$ctx)";
  
  				my $ptr = substr($blank, 0, $off) . "^";
  				my $hereptr = "$hereline$ptr
  ";
  
  				# Pull out the value of this operator.
  				my $op_type = substr($curr_values, $off + 1, 1);
  
  				# Get the full operator variant.
  				my $opv = $op . substr($curr_vars, $off, 1);
  
  				# Ignore operators passed as parameters.
  				if ($op_type ne 'V' &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
4402
  				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
05622191e   Joe Hershberger   tools: checkpatch...
4403
4404
4405
4406
4407
4408
4409
4410
  
  #				# Ignore comments
  #				} elsif ($op =~ /^$;+$/) {
  
  				# ; should have either the end of line or a space or \ after it
  				} elsif ($op eq ';') {
  					if ($ctx !~ /.x[WEBC]/ &&
  					    $cc !~ /^\\/ && $cc !~ /^;/) {
6b9709d91   Tom Rini   scripts: update c...
4411
4412
4413
4414
4415
4416
  						if (ERROR("SPACING",
  							  "space required after that '$op' $at
  " . $hereptr)) {
  							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4417
4418
4419
4420
  					}
  
  				# // is a comment
  				} elsif ($op eq '//') {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4421
4422
4423
  				#   :   when part of a bitfield
  				} elsif ($opv eq ':B') {
  					# skip the bitfield test for now
05622191e   Joe Hershberger   tools: checkpatch...
4424
4425
  				# No spaces for:
  				#   ->
6305db960   Heinrich Schuchardt   checkpatch: updat...
4426
  				} elsif ($op eq '->') {
05622191e   Joe Hershberger   tools: checkpatch...
4427
  					if ($ctx =~ /Wx.|.xW/) {
6b9709d91   Tom Rini   scripts: update c...
4428
4429
4430
4431
4432
4433
4434
4435
4436
  						if (ERROR("SPACING",
  							  "spaces prohibited around that '$op' $at
  " . $hereptr)) {
  							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
  							if (defined $fix_elements[$n + 2]) {
  								$fix_elements[$n + 2] =~ s/^\s+//;
  							}
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4437
  					}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4438
  				# , must not have a space before and must have a space on the right.
05622191e   Joe Hershberger   tools: checkpatch...
4439
  				} elsif ($op eq ',') {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
  					my $rtrim_before = 0;
  					my $space_after = 0;
  					if ($ctx =~ /Wx./) {
  						if (ERROR("SPACING",
  							  "space prohibited before that '$op' $at
  " . $hereptr)) {
  							$line_fixed = 1;
  							$rtrim_before = 1;
  						}
  					}
05622191e   Joe Hershberger   tools: checkpatch...
4450
  					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
6b9709d91   Tom Rini   scripts: update c...
4451
4452
4453
  						if (ERROR("SPACING",
  							  "space required after that '$op' $at
  " . $hereptr)) {
6b9709d91   Tom Rini   scripts: update c...
4454
4455
  							$line_fixed = 1;
  							$last_after = $n;
6305db960   Heinrich Schuchardt   checkpatch: updat...
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
  							$space_after = 1;
  						}
  					}
  					if ($rtrim_before || $space_after) {
  						if ($rtrim_before) {
  							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
  						} else {
  							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
  						}
  						if ($space_after) {
  							$good .= " ";
6b9709d91   Tom Rini   scripts: update c...
4467
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
  					}
  
  				# '*' as part of a type definition -- reported already.
  				} elsif ($opv eq '*_') {
  					#warn "'*' is part of type
  ";
  
  				# unary operators should have a space before and
  				# none after.  May be left adjacent to another
  				# unary operator, or a cast
  				} elsif ($op eq '!' || $op eq '~' ||
  					 $opv eq '*U' || $opv eq '-U' ||
  					 $opv eq '&U' || $opv eq '&&U') {
  					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
6b9709d91   Tom Rini   scripts: update c...
4482
4483
4484
4485
4486
4487
4488
4489
  						if (ERROR("SPACING",
  							  "space required before that '$op' $at
  " . $hereptr)) {
  							if ($n != $last_after + 2) {
  								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
  								$line_fixed = 1;
  							}
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4490
4491
4492
4493
4494
  					}
  					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
  						# A unary '*' may be const
  
  					} elsif ($ctx =~ /.xW/) {
6b9709d91   Tom Rini   scripts: update c...
4495
4496
4497
4498
4499
4500
4501
4502
4503
  						if (ERROR("SPACING",
  							  "space prohibited after that '$op' $at
  " . $hereptr)) {
  							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
  							if (defined $fix_elements[$n + 2]) {
  								$fix_elements[$n + 2] =~ s/^\s+//;
  							}
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4504
4505
4506
4507
4508
  					}
  
  				# unary ++ and unary -- are allowed no space on one side.
  				} elsif ($op eq '++' or $op eq '--') {
  					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
6b9709d91   Tom Rini   scripts: update c...
4509
4510
4511
4512
4513
4514
  						if (ERROR("SPACING",
  							  "space required one side of that '$op' $at
  " . $hereptr)) {
  							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4515
4516
4517
  					}
  					if ($ctx =~ /Wx[BE]/ ||
  					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
6b9709d91   Tom Rini   scripts: update c...
4518
4519
4520
4521
4522
4523
  						if (ERROR("SPACING",
  							  "space prohibited before that '$op' $at
  " . $hereptr)) {
  							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4524
4525
  					}
  					if ($ctx =~ /ExW/) {
6b9709d91   Tom Rini   scripts: update c...
4526
4527
4528
4529
4530
4531
4532
4533
4534
  						if (ERROR("SPACING",
  							  "space prohibited after that '$op' $at
  " . $hereptr)) {
  							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
  							if (defined $fix_elements[$n + 2]) {
  								$fix_elements[$n + 2] =~ s/^\s+//;
  							}
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4535
  					}
05622191e   Joe Hershberger   tools: checkpatch...
4536
4537
4538
4539
4540
4541
4542
  				# << and >> may either have or not have spaces both sides
  				} elsif ($op eq '<<' or $op eq '>>' or
  					 $op eq '&' or $op eq '^' or $op eq '|' or
  					 $op eq '+' or $op eq '-' or
  					 $op eq '*' or $op eq '/' or
  					 $op eq '%')
  				{
6305db960   Heinrich Schuchardt   checkpatch: updat...
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
  					if ($check) {
  						if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
  							if (CHK("SPACING",
  								"spaces preferred around that '$op' $at
  " . $hereptr)) {
  								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
  								$fix_elements[$n + 2] =~ s/^\s+//;
  								$line_fixed = 1;
  							}
  						} elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
  							if (CHK("SPACING",
  								"space preferred before that '$op' $at
  " . $hereptr)) {
  								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
  								$line_fixed = 1;
  							}
  						}
  					} elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
6b9709d91   Tom Rini   scripts: update c...
4561
4562
4563
4564
4565
4566
4567
4568
4569
  						if (ERROR("SPACING",
  							  "need consistent spacing around '$op' $at
  " . $hereptr)) {
  							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
  							if (defined $fix_elements[$n + 2]) {
  								$fix_elements[$n + 2] =~ s/^\s+//;
  							}
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4570
4571
4572
4573
4574
4575
  					}
  
  				# A colon needs no spaces before when it is
  				# terminating a case value or a label.
  				} elsif ($opv eq ':C' || $opv eq ':L') {
  					if ($ctx =~ /Wx./) {
6b9709d91   Tom Rini   scripts: update c...
4576
4577
4578
4579
4580
4581
  						if (ERROR("SPACING",
  							  "space prohibited before that '$op' $at
  " . $hereptr)) {
  							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
  					}
  
  				# All the others need spaces both sides.
  				} elsif ($ctx !~ /[EWC]x[CWE]/) {
  					my $ok = 0;
  
  					# Ignore email addresses <foo@bar>
  					if (($op eq '<' &&
  					     $cc =~ /^\S+\@\S+>/) ||
  					    ($op eq '>' &&
  					     $ca =~ /<\S+\@\S+$/))
  					{
6b9709d91   Tom Rini   scripts: update c...
4594
  					    	$ok = 1;
05622191e   Joe Hershberger   tools: checkpatch...
4595
  					}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4596
4597
4598
4599
4600
4601
4602
  					# for asm volatile statements
  					# ignore a colon with another
  					# colon immediately before or after
  					if (($op eq ':') &&
  					    ($ca =~ /:$/ || $cc =~ /^:/)) {
  						$ok = 1;
  					}
6b9709d91   Tom Rini   scripts: update c...
4603
  					# messages are ERROR, but ?: are CHK
05622191e   Joe Hershberger   tools: checkpatch...
4604
  					if ($ok == 0) {
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
4605
4606
  						my $msg_level = \&ERROR;
  						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
6b9709d91   Tom Rini   scripts: update c...
4607

c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
4608
4609
4610
  						if (&{$msg_level}("SPACING",
  								  "spaces required around that '$op' $at
  " . $hereptr)) {
6b9709d91   Tom Rini   scripts: update c...
4611
4612
4613
4614
4615
4616
  							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
  							if (defined $fix_elements[$n + 2]) {
  								$fix_elements[$n + 2] =~ s/^\s+//;
  							}
  							$line_fixed = 1;
  						}
05622191e   Joe Hershberger   tools: checkpatch...
4617
4618
4619
  					}
  				}
  				$off += length($elements[$n + 1]);
6b9709d91   Tom Rini   scripts: update c...
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
  
  ##				print("n: <$n> GOOD: <$good>
  ");
  
  				$fixed_line = $fixed_line . $good;
  			}
  
  			if (($#elements % 2) == 0) {
  				$fixed_line = $fixed_line . $fix_elements[$#elements];
  			}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4630
4631
  			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
  				$fixed[$fixlinenr] = $fixed_line;
6b9709d91   Tom Rini   scripts: update c...
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
  			}
  
  
  		}
  
  # check for whitespace before a non-naked semicolon
  		if ($line =~ /^\+.*\S\s+;\s*$/) {
  			if (WARN("SPACING",
  				 "space prohibited before semicolon
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4643
  				1 while $fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4644
  				    s/^(\+.*\S)\s+;/$1;/;
05622191e   Joe Hershberger   tools: checkpatch...
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
  			}
  		}
  
  # check for multiple assignments
  		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
  			CHK("MULTIPLE_ASSIGNMENTS",
  			    "multiple assignments should be avoided
  " . $herecurr);
  		}
  
  ## # check for multiple declarations, allowing for a function declaration
  ## # continuation.
  ## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
  ## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
  ##
  ## 			# Remove any bracketed sections to ensure we do not
  ## 			# falsly report the parameters of functions.
  ## 			my $ln = $line;
  ## 			while ($ln =~ s/\([^\(\)]*\)//g) {
  ## 			}
  ## 			if ($ln =~ /,/) {
  ## 				WARN("MULTIPLE_DECLARATION",
  ##				     "declaring multiple variables together should be avoided
  " . $herecurr);
  ## 			}
  ## 		}
  
  #need space before brace following if, while, etc
6305db960   Heinrich Schuchardt   checkpatch: updat...
4673
  		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
d8a1a304e   Heiko Schocher   checkpatch: fix l...
4674
  		    $line =~ /do\{/) {
6b9709d91   Tom Rini   scripts: update c...
4675
4676
4677
4678
  			if (ERROR("SPACING",
  				  "space required before the open brace '{'
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4679
  				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
6b9709d91   Tom Rini   scripts: update c...
4680
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4681
  		}
6b9709d91   Tom Rini   scripts: update c...
4682
4683
4684
4685
4686
4687
4688
4689
  ## # check for blank lines before declarations
  ##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
  ##		    $prevrawline =~ /^.\s*$/) {
  ##			WARN("SPACING",
  ##			     "No blank lines before declarations
  " . $hereprev);
  ##		}
  ##
05622191e   Joe Hershberger   tools: checkpatch...
4690
4691
4692
  # closing brace should have a space following it when it has anything
  # on the line
  		if ($line =~ /}(?!(?:,|;|\)))\S/) {
6b9709d91   Tom Rini   scripts: update c...
4693
4694
4695
4696
  			if (ERROR("SPACING",
  				  "space required after that close brace '}'
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4697
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4698
4699
  				    s/}((?!(?:,|;|\)))\S)/} $1/;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4700
4701
4702
4703
  		}
  
  # check spacing on square brackets
  		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
6b9709d91   Tom Rini   scripts: update c...
4704
4705
4706
4707
  			if (ERROR("SPACING",
  				  "space prohibited after that open square bracket '['
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4708
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4709
4710
  				    s/\[\s+/\[/;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4711
4712
  		}
  		if ($line =~ /\s\]/) {
6b9709d91   Tom Rini   scripts: update c...
4713
4714
4715
4716
  			if (ERROR("SPACING",
  				  "space prohibited before that close square bracket ']'
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4717
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4718
4719
  				    s/\s+\]/\]/;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4720
4721
4722
4723
4724
  		}
  
  # check spacing on parentheses
  		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
  		    $line !~ /for\s*\(\s+;/) {
6b9709d91   Tom Rini   scripts: update c...
4725
4726
4727
4728
  			if (ERROR("SPACING",
  				  "space prohibited after that open parenthesis '('
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4729
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4730
4731
  				    s/\(\s+/\(/;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4732
4733
4734
4735
  		}
  		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
  		    $line !~ /for\s*\(.*;\s+\)/ &&
  		    $line !~ /:\s+\)/) {
6b9709d91   Tom Rini   scripts: update c...
4736
4737
4738
4739
  			if (ERROR("SPACING",
  				  "space prohibited before that close parenthesis ')'
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4740
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4741
4742
  				    s/\s+\)/\)/;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4743
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
  # check unnecessary parentheses around addressof/dereference single $Lvals
  # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
  
  		while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
  			my $var = $1;
  			if (CHK("UNNECESSARY_PARENTHESES",
  				"Unnecessary parentheses around $var
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
  			}
  		}
  
  # check for unnecessary parentheses around function pointer uses
  # ie: (foo->bar)(); should be foo->bar();
  # but not "if (foo->bar) (" to avoid some false positives
  		if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
  			my $var = $2;
  			if (CHK("UNNECESSARY_PARENTHESES",
  				"Unnecessary parentheses around function pointer $var
  " . $herecurr) &&
  			    $fix) {
  				my $var2 = deparenthesize($var);
  				$var2 =~ s/\s//g;
  				$fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
  			}
  		}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
  # check for unnecessary parentheses around comparisons in if uses
  # when !drivers/staging or command-line uses --strict
  		if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
  		    $^V && $^V ge 5.10.0 && defined($stat) &&
  		    $stat =~ /(^.\s*if\s*($balanced_parens))/) {
  			my $if_stat = $1;
  			my $test = substr($2, 1, -1);
  			my $herectx;
  			while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
  				my $match = $1;
  				# avoid parentheses around potential macro args
  				next if ($match =~ /^\s*\w+\s*$/);
  				if (!defined($herectx)) {
  					$herectx = $here . "
  ";
  					my $cnt = statement_rawlines($if_stat);
  					for (my $n = 0; $n < $cnt; $n++) {
  						my $rl = raw_line($linenr, $n);
  						$herectx .=  $rl . "
  ";
  						last if $rl =~ /^[ \+].*\{/;
  					}
  				}
  				CHK("UNNECESSARY_PARENTHESES",
  				    "Unnecessary parentheses around '$match'
  " . $herectx);
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
4799
4800
4801
  #goto labels aren't indented, allow a single space however
  		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
  		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
6b9709d91   Tom Rini   scripts: update c...
4802
4803
4804
4805
  			if (WARN("INDENTED_LABEL",
  				 "labels should not be indented
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4806
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4807
4808
  				    s/^(.)\s+/$1/;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4809
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4810
  # return is not a function
6b9709d91   Tom Rini   scripts: update c...
4811
  		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
05622191e   Joe Hershberger   tools: checkpatch...
4812
  			my $spacing = $1;
6b9709d91   Tom Rini   scripts: update c...
4813
  			if ($^V && $^V ge 5.10.0 &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
4814
4815
4816
4817
4818
4819
4820
4821
  			    $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
  				my $value = $1;
  				$value = deparenthesize($value);
  				if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
  					ERROR("RETURN_PARENTHESES",
  					      "return is not a function, parentheses are not required
  " . $herecurr);
  				}
05622191e   Joe Hershberger   tools: checkpatch...
4822
4823
4824
4825
4826
4827
  			} elsif ($spacing !~ /\s+/) {
  				ERROR("SPACING",
  				      "space required before the open parenthesis '('
  " . $herecurr);
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
4828

6305db960   Heinrich Schuchardt   checkpatch: updat...
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
  # unnecessary return in a void function
  # at end-of-function, with the previous line a single leading tab, then return;
  # and the line before that not a goto label target like "out:"
  		if ($sline =~ /^[ \+]}\s*$/ &&
  		    $prevline =~ /^\+\treturn\s*;\s*$/ &&
  		    $linenr >= 3 &&
  		    $lines[$linenr - 3] =~ /^[ +]/ &&
  		    $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
  			WARN("RETURN_VOID",
  			     "void function return statements are not generally useful
  " . $hereprev);
                 }
6b9709d91   Tom Rini   scripts: update c...
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
  # if statements using unnecessary parentheses - ie: if ((foo == bar))
  		if ($^V && $^V ge 5.10.0 &&
  		    $line =~ /\bif\s*((?:\(\s*){2,})/) {
  			my $openparens = $1;
  			my $count = $openparens =~ tr@\(@\(@;
  			my $msg = "";
  			if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
  				my $comp = $4;	#Not $1 because of $LvalOrFunc
  				$msg = " - maybe == should be = ?" if ($comp eq "==");
  				WARN("UNNECESSARY_PARENTHESES",
  				     "Unnecessary parentheses$msg
  " . $herecurr);
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
  # comparisons with a constant or upper case identifier on the left
  #	avoid cases like "foo + BAR < baz"
  #	only fix matches surrounded by parentheses to avoid incorrect
  #	conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
  		if ($^V && $^V ge 5.10.0 &&
  		    $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
  			my $lead = $1;
  			my $const = $2;
  			my $comp = $3;
  			my $to = $4;
  			my $newcomp = $comp;
  			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
  			    $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
  			    WARN("CONSTANT_COMPARISON",
  				 "Comparisons should place the constant on the right side of the test
  " . $herecurr) &&
  			    $fix) {
  				if ($comp eq "<") {
  					$newcomp = ">";
  				} elsif ($comp eq "<=") {
  					$newcomp = ">=";
  				} elsif ($comp eq ">") {
  					$newcomp = "<";
  				} elsif ($comp eq ">=") {
  					$newcomp = "<=";
  				}
  				$fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
  			}
  		}
  
  # Return of what appears to be an errno should normally be negative
  		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
05622191e   Joe Hershberger   tools: checkpatch...
4887
4888
4889
  			my $name = $1;
  			if ($name ne 'EOF' && $name ne 'ERROR') {
  				WARN("USE_NEGATIVE_ERRNO",
6305db960   Heinrich Schuchardt   checkpatch: updat...
4890
4891
  				     "return of an errno should typically be negative (ie: return -$1)
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
4892
4893
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
4894
  # Need a space before open parenthesis after if, while etc
6b9709d91   Tom Rini   scripts: update c...
4895
4896
4897
4898
4899
  		if ($line =~ /\b(if|while|for|switch)\(/) {
  			if (ERROR("SPACING",
  				  "space required before the open parenthesis '('
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
4900
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
4901
4902
  				    s/\b(if|while|for|switch)\(/$1 \(/;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
4903
4904
4905
4906
4907
  		}
  
  # Check for illegal assignment in if conditional -- and check for trailing
  # statements after the conditional.
  		if ($line =~ /do\s*(?!{)/) {
d45a6ae24   Kim Phillips   tools: update che...
4908
4909
4910
  			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
  				ctx_statement_block($linenr, $realcnt, 0)
  					if (!defined $stat);
05622191e   Joe Hershberger   tools: checkpatch...
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
  			my ($stat_next) = ctx_statement_block($line_nr_next,
  						$remain_next, $off_next);
  			$stat_next =~ s/
  ./
   /g;
  			##print "stat<$stat> stat_next<$stat_next>
  ";
  
  			if ($stat_next =~ /^\s*while\b/) {
  				# If the statement carries leading newlines,
  				# then count those as offsets.
  				my ($whitespace) =
  					($stat_next =~ /^((?:\s*
  [+-])*\s*)/s);
  				my $offset =
  					statement_rawlines($whitespace) - 1;
  
  				$suppress_whiletrailers{$line_nr_next +
  								$offset} = 1;
  			}
  		}
  		if (!defined $suppress_whiletrailers{$linenr} &&
6b9709d91   Tom Rini   scripts: update c...
4933
  		    defined($stat) && defined($cond) &&
05622191e   Joe Hershberger   tools: checkpatch...
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
  		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
  			my ($s, $c) = ($stat, $cond);
  
  			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
  				ERROR("ASSIGN_IN_IF",
  				      "do not use assignment in if condition
  " . $herecurr);
  			}
  
  			# Find out what is on the end of the line after the
  			# conditional.
  			substr($s, 0, length($c), '');
  			$s =~ s/
  .*//g;
  			$s =~ s/$;//g; 	# Remove any comments
  			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
  			    $c !~ /}\s*while\s*/)
  			{
  				# Find out how long the conditional actually is.
  				my @newlines = ($c =~ /
  /gs);
  				my $cond_lines = 1 + $#newlines;
  				my $stat_real = '';
  
  				$stat_real = raw_line($linenr, $cond_lines)
  							. "
  " if ($cond_lines);
  				if (defined($stat_real) && $cond_lines > 1) {
  					$stat_real = "[...]
  $stat_real";
  				}
  
  				ERROR("TRAILING_STATEMENTS",
  				      "trailing statements should be on next line
  " . $herecurr . $stat_real);
  			}
  		}
  
  # Check for bitwise tests written as boolean
  		if ($line =~ /
  			(?:
  				(?:\[|\(|\&\&|\|\|)
  				\s*0[xX][0-9]+\s*
  				(?:\&\&|\|\|)
  			|
  				(?:\&\&|\|\|)
  				\s*0[xX][0-9]+\s*
  				(?:\&\&|\|\||\)|\])
  			)/x)
  		{
  			WARN("HEXADECIMAL_BOOLEAN_TEST",
  			     "boolean test with hexadecimal, perhaps just 1 \& or \|?
  " . $herecurr);
  		}
  
  # if and else should not have general statements after it
  		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
  			my $s = $1;
  			$s =~ s/$;//g; 	# Remove any comments
  			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
  				ERROR("TRAILING_STATEMENTS",
  				      "trailing statements should be on next line
  " . $herecurr);
  			}
  		}
  # if should not continue a brace
  		if ($line =~ /}\s*if\b/) {
  			ERROR("TRAILING_STATEMENTS",
6305db960   Heinrich Schuchardt   checkpatch: updat...
5002
5003
  			      "trailing statements should be on next line (or did you mean 'else if'?)
  " .
05622191e   Joe Hershberger   tools: checkpatch...
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
  				$herecurr);
  		}
  # case and default should not have general statements after them
  		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
  		    $line !~ /\G(?:
  			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
  			\s*return\s+
  		    )/xg)
  		{
  			ERROR("TRAILING_STATEMENTS",
  			      "trailing statements should be on next line
  " . $herecurr);
  		}
  
  		# Check for }<nl>else {, these must be at the same
  		# indent level to be relevant to each other.
6305db960   Heinrich Schuchardt   checkpatch: updat...
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
  		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
  		    $previndent == $indent) {
  			if (ERROR("ELSE_AFTER_BRACE",
  				  "else should follow close brace '}'
  " . $hereprev) &&
  			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
  				fix_delete_line($fixlinenr - 1, $prevrawline);
  				fix_delete_line($fixlinenr, $rawline);
  				my $fixedline = $prevrawline;
  				$fixedline =~ s/}\s*$//;
  				if ($fixedline !~ /^\+\s*$/) {
  					fix_insert_line($fixlinenr, $fixedline);
  				}
  				$fixedline = $rawline;
  				$fixedline =~ s/^(.\s*)else/$1} else/;
  				fix_insert_line($fixlinenr, $fixedline);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
5037
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
5038
5039
  		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
  		    $previndent == $indent) {
05622191e   Joe Hershberger   tools: checkpatch...
5040
5041
5042
5043
5044
5045
5046
5047
5048
  			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
  
  			# Find out what is on the end of the line after the
  			# conditional.
  			substr($s, 0, length($c), '');
  			$s =~ s/
  .*//g;
  
  			if ($s =~ /^\s*;/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
  				if (ERROR("WHILE_AFTER_BRACE",
  					  "while should follow close brace '}'
  " . $hereprev) &&
  				    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
  					fix_delete_line($fixlinenr - 1, $prevrawline);
  					fix_delete_line($fixlinenr, $rawline);
  					my $fixedline = $prevrawline;
  					my $trailing = $rawline;
  					$trailing =~ s/^\+//;
  					$trailing = trim($trailing);
  					$fixedline =~ s/}\s*$/} $trailing/;
  					fix_insert_line($fixlinenr, $fixedline);
  				}
05622191e   Joe Hershberger   tools: checkpatch...
5062
5063
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
5064
  #Specific variable tests
d45a6ae24   Kim Phillips   tools: update che...
5065
5066
  		while ($line =~ m{($Constant|$Lval)}g) {
  			my $var = $1;
6b9709d91   Tom Rini   scripts: update c...
5067
5068
5069
5070
5071
5072
5073
5074
  
  #gcc binary extension
  			if ($var =~ /^$Binary$/) {
  				if (WARN("GCC_BINARY_CONSTANT",
  					 "Avoid gcc v4.3+ binary constant extension: <$var>
  " . $herecurr) &&
  				    $fix) {
  					my $hexval = sprintf("0x%x", oct($var));
6305db960   Heinrich Schuchardt   checkpatch: updat...
5075
  					$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
  					    s/\b$var\b/$hexval/;
  				}
  			}
  
  #CamelCase
  			if ($var !~ /^$Constant$/ &&
  			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
  #Ignore Page<foo> variants
  			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
  #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
6305db960   Heinrich Schuchardt   checkpatch: updat...
5086
5087
5088
  			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
  #Ignore some three character SI units explicitly, like MiB and KHz
  			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
6b9709d91   Tom Rini   scripts: update c...
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
  				while ($var =~ m{($Ident)}g) {
  					my $word = $1;
  					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
  					if ($check) {
  						seed_camelcase_includes();
  						if (!$file && !$camelcase_file_seeded) {
  							seed_camelcase_file($realfile);
  							$camelcase_file_seeded = 1;
  						}
  					}
  					if (!defined $camelcase{$word}) {
  						$camelcase{$word} = 1;
  						CHK("CAMELCASE",
  						    "Avoid CamelCase: <$word>
  " . $herecurr);
  					}
  				}
d45a6ae24   Kim Phillips   tools: update che...
5106
5107
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
5108
5109
  
  #no spaces allowed after \ in define
6b9709d91   Tom Rini   scripts: update c...
5110
5111
5112
5113
5114
  		if ($line =~ /\#\s*define.*\\\s+$/) {
  			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
  				 "Whitespace after \\ makes next lines useless
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5115
  				$fixed[$fixlinenr] =~ s/\s+$//;
6b9709d91   Tom Rini   scripts: update c...
5116
  			}
05622191e   Joe Hershberger   tools: checkpatch...
5117
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
5118
5119
  # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
  # itself <asm/foo.h> (uses RAW line)
05622191e   Joe Hershberger   tools: checkpatch...
5120
5121
5122
5123
5124
5125
5126
  		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
  			my $file = "$1.h";
  			my $checkfile = "include/linux/$file";
  			if (-f "$root/$checkfile" &&
  			    $realfile ne $checkfile &&
  			    $1 !~ /$allowed_asm_includes/)
  			{
6305db960   Heinrich Schuchardt   checkpatch: updat...
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
  				my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
  				if ($asminclude > 0) {
  					if ($realfile =~ m{^arch/}) {
  						CHK("ARCH_INCLUDE_LINUX",
  						    "Consider using #include <linux/$file> instead of <asm/$file>
  " . $herecurr);
  					} else {
  						WARN("INCLUDE_LINUX",
  						     "Use #include <linux/$file> instead of <asm/$file>
  " . $herecurr);
  					}
05622191e   Joe Hershberger   tools: checkpatch...
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
  				}
  			}
  		}
  
  # multi-statement macros should be enclosed in a do while loop, grab the
  # first statement and ensure its the whole macro if its not enclosed
  # in a known good container
  		if ($realfile !~ m@/vmlinux.lds.h$@ &&
  		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
  			my $ln = $linenr;
  			my $cnt = $realcnt;
  			my ($off, $dstat, $dcond, $rest);
  			my $ctx = '';
6305db960   Heinrich Schuchardt   checkpatch: updat...
5151
5152
  			my $has_flow_statement = 0;
  			my $has_arg_concat = 0;
05622191e   Joe Hershberger   tools: checkpatch...
5153
  			($dstat, $dcond, $ln, $cnt, $off) =
d45a6ae24   Kim Phillips   tools: update che...
5154
5155
  				ctx_statement_block($linenr, $realcnt, 0);
  			$ctx = $dstat;
05622191e   Joe Hershberger   tools: checkpatch...
5156
5157
5158
5159
  			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>
  ";
  			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "
  ";
6305db960   Heinrich Schuchardt   checkpatch: updat...
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
  			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
  			$has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
  
  			$dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
  			my $define_args = $1;
  			my $define_stmt = $dstat;
  			my @def_args = ();
  
  			if (defined $define_args && $define_args ne "") {
  				$define_args = substr($define_args, 1, length($define_args) - 2);
  				$define_args =~ s/\s*//g;
  				@def_args = split(",", $define_args);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
5173
5174
5175
5176
5177
5178
5179
5180
5181
  			$dstat =~ s/$;//g;
  			$dstat =~ s/\\
  .//g;
  			$dstat =~ s/^\s*//s;
  			$dstat =~ s/\s*$//s;
  
  			# Flatten any parentheses and braces
  			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
  			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
6305db960   Heinrich Schuchardt   checkpatch: updat...
5182
  			       $dstat =~ s/.\[[^\[\]]*\]/1/)
d45a6ae24   Kim Phillips   tools: update che...
5183
5184
5185
5186
  			{
  			}
  
  			# Flatten any obvious string concatentation.
6305db960   Heinrich Schuchardt   checkpatch: updat...
5187
5188
  			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
  			       $dstat =~ s/$Ident\s*($String)/$1/)
05622191e   Joe Hershberger   tools: checkpatch...
5189
5190
  			{
  			}
6305db960   Heinrich Schuchardt   checkpatch: updat...
5191
5192
  			# Make asm volatile uses seem like a generic function
  			$dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
05622191e   Joe Hershberger   tools: checkpatch...
5193
5194
5195
  			my $exceptions = qr{
  				$Declare|
  				module_param_named|
d45a6ae24   Kim Phillips   tools: update che...
5196
  				MODULE_PARM_DESC|
05622191e   Joe Hershberger   tools: checkpatch...
5197
5198
5199
5200
5201
5202
  				DECLARE_PER_CPU|
  				DEFINE_PER_CPU|
  				__typeof__\(|
  				union|
  				struct|
  				\.$Ident\s*=\s*|
6305db960   Heinrich Schuchardt   checkpatch: updat...
5203
5204
  				^\"|\"$|
  				^\[
05622191e   Joe Hershberger   tools: checkpatch...
5205
5206
5207
  			}x;
  			#print "REST<$rest> dstat<$dstat> ctx<$ctx>
  ";
6305db960   Heinrich Schuchardt   checkpatch: updat...
5208
5209
5210
  
  			$ctx =~ s/
  *$//;
6305db960   Heinrich Schuchardt   checkpatch: updat...
5211
  			my $stmt_cnt = statement_rawlines($ctx);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5212
  			my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
6305db960   Heinrich Schuchardt   checkpatch: updat...
5213

d45a6ae24   Kim Phillips   tools: update che...
5214
5215
5216
  			if ($dstat ne '' &&
  			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
  			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
6b9709d91   Tom Rini   scripts: update c...
5217
  			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
6305db960   Heinrich Schuchardt   checkpatch: updat...
5218
  			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
d45a6ae24   Kim Phillips   tools: update che...
5219
5220
  			    $dstat !~ /$exceptions/ &&
  			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
6b9709d91   Tom Rini   scripts: update c...
5221
  			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
d45a6ae24   Kim Phillips   tools: update che...
5222
5223
5224
5225
  			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
  			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
  			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
  			    $dstat !~ /^do\s*{/ &&					# do {...
d8a1a304e   Heiko Schocher   checkpatch: fix l...
5226
  			    $dstat !~ /^\(\{/ &&						# ({...
6b9709d91   Tom Rini   scripts: update c...
5227
  			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
d45a6ae24   Kim Phillips   tools: update che...
5228
  			{
6305db960   Heinrich Schuchardt   checkpatch: updat...
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
  				if ($dstat =~ /^\s*if\b/) {
  					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
  					      "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects
  " . "$herectx");
  				} elsif ($dstat =~ /;/) {
  					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
  					      "Macros with multiple statements should be enclosed in a do - while loop
  " . "$herectx");
  				} else {
  					ERROR("COMPLEX_MACRO",
  					      "Macros with complex values should be enclosed in parentheses
  " . "$herectx");
  				}
  
  			}
  
  			# Make $define_stmt single line, comment-free, etc
  			my @stmt_array = split('
  ', $define_stmt);
  			my $first = 1;
  			$define_stmt = "";
  			foreach my $l (@stmt_array) {
  				$l =~ s/\\$//;
  				if ($first) {
  					$define_stmt = $l;
  					$first = 0;
  				} elsif ($l =~ /^[\+ ]/) {
  					$define_stmt .= substr($l, 1);
  				}
  			}
  			$define_stmt =~ s/$;//g;
  			$define_stmt =~ s/\s+/ /g;
  			$define_stmt = trim($define_stmt);
  
  # check if any macro arguments are reused (ignore '...' and 'type')
  			foreach my $arg (@def_args) {
  			        next if ($arg =~ /\.\.\./);
  			        next if ($arg =~ /^type$/i);
  				my $tmp_stmt = $define_stmt;
  				$tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
  				$tmp_stmt =~ s/\#+\s*$arg\b//g;
  				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
  				my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
  				if ($use_cnt > 1) {
  					CHK("MACRO_ARG_REUSE",
  					    "Macro argument reuse '$arg' - possible side-effects?
  " . "$herectx");
  				    }
  # check if any macro arguments may have other precedence issues
  				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
  				    ((defined($1) && $1 ne ',') ||
  				     (defined($2) && $2 ne ','))) {
  					CHK("MACRO_ARG_PRECEDENCE",
  					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues
  " . "$herectx");
  				}
  			}
  
  # check for macros with flow control, but without ## concatenation
  # ## concatenation is commonly a macro that defines a function so ignore those
  			if ($has_flow_statement && !$has_arg_concat) {
d45a6ae24   Kim Phillips   tools: update che...
5290
  				my $cnt = statement_rawlines($ctx);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5291
  				my $herectx = get_stat_here($linenr, $cnt, $here);
d45a6ae24   Kim Phillips   tools: update che...
5292

6305db960   Heinrich Schuchardt   checkpatch: updat...
5293
5294
5295
  				WARN("MACRO_WITH_FLOW_CONTROL",
  				     "Macros with flow control statements should be avoided
  " . "$herectx");
d45a6ae24   Kim Phillips   tools: update che...
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
  			}
  
  # check for line continuations outside of #defines, preprocessor #, and asm
  
  		} else {
  			if ($prevline !~ /^..*\\$/ &&
  			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
  			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
  			    $line =~ /^\+.*\\$/) {
  				WARN("LINE_CONTINUATIONS",
  				     "Avoid unnecessary line continuations
  " . $herecurr);
  			}
  		}
  
  # do {} while (0) macro tests:
  # single-statement macros do not need to be enclosed in do while (0) loop,
  # macro should not end with a semicolon
  		if ($^V && $^V ge 5.10.0 &&
  		    $realfile !~ m@/vmlinux.lds.h$@ &&
  		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
  			my $ln = $linenr;
  			my $cnt = $realcnt;
  			my ($off, $dstat, $dcond, $rest);
  			my $ctx = '';
  			($dstat, $dcond, $ln, $cnt, $off) =
  				ctx_statement_block($linenr, $realcnt, 0);
  			$ctx = $dstat;
  
  			$dstat =~ s/\\
  .//g;
6305db960   Heinrich Schuchardt   checkpatch: updat...
5327
  			$dstat =~ s/$;/ /g;
d45a6ae24   Kim Phillips   tools: update che...
5328
5329
5330
5331
5332
5333
5334
5335
  
  			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
  				my $stmts = $2;
  				my $semis = $3;
  
  				$ctx =~ s/
  *$//;
  				my $cnt = statement_rawlines($ctx);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5336
  				my $herectx = get_stat_here($linenr, $cnt, $here);
d45a6ae24   Kim Phillips   tools: update che...
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
  
  				if (($stmts =~ tr/;/;/) == 1 &&
  				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
  					WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
  					     "Single statement macros should not use a do {} while (0) loop
  " . "$herectx");
  				}
  				if (defined $semis && $semis ne "") {
  					WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
  					     "do {} while (0) macros should not be semicolon terminated
  " . "$herectx");
05622191e   Joe Hershberger   tools: checkpatch...
5348
  				}
6305db960   Heinrich Schuchardt   checkpatch: updat...
5349
5350
5351
5352
  			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
  				$ctx =~ s/
  *$//;
  				my $cnt = statement_rawlines($ctx);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5353
  				my $herectx = get_stat_here($linenr, $cnt, $here);
6305db960   Heinrich Schuchardt   checkpatch: updat...
5354
5355
5356
5357
  
  				WARN("TRAILING_SEMICOLON",
  				     "macros should not use a trailing semicolon
  " . "$herectx");
05622191e   Joe Hershberger   tools: checkpatch...
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
  			}
  		}
  
  # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
  # all assignments may have only one of the following with an assignment:
  #	.
  #	ALIGN(...)
  #	VMLINUX_SYMBOL(...)
  		if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
  			WARN("MISSING_VMLINUX_SYMBOL",
  			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols
  " . $herecurr);
  		}
  
  # check for redundant bracing round if etc
  		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
  			my ($level, $endln, @chunks) =
  				ctx_statement_full($linenr, $realcnt, 1);
  			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>
  ";
  			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>
  ";
  			if ($#chunks > 0 && $level == 0) {
d45a6ae24   Kim Phillips   tools: update che...
5381
5382
  				my @allowed = ();
  				my $allow = 0;
05622191e   Joe Hershberger   tools: checkpatch...
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
  				my $seen = 0;
  				my $herectx = $here . "
  ";
  				my $ln = $linenr - 1;
  				for my $chunk (@chunks) {
  					my ($cond, $block) = @{$chunk};
  
  					# If the condition carries leading newlines, then count those as offsets.
  					my ($whitespace) = ($cond =~ /^((?:\s*
  [+-])*\s*)/s);
  					my $offset = statement_rawlines($whitespace) - 1;
d45a6ae24   Kim Phillips   tools: update che...
5394
  					$allowed[$allow] = 0;
05622191e   Joe Hershberger   tools: checkpatch...
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
  					#print "COND<$cond> whitespace<$whitespace> offset<$offset>
  ";
  
  					# We have looked at and allowed this specific line.
  					$suppress_ifbraces{$ln + $offset} = 1;
  
  					$herectx .= "$rawlines[$ln + $offset]
  [...]
  ";
  					$ln += statement_rawlines($block) - 1;
  
  					substr($block, 0, length($cond), '');
  
  					$seen++ if ($block =~ /^\s*{/);
d45a6ae24   Kim Phillips   tools: update che...
5409
5410
  					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>
  ";
05622191e   Joe Hershberger   tools: checkpatch...
5411
5412
5413
  					if (statement_lines($cond) > 1) {
  						#print "APW: ALLOWED: cond<$cond>
  ";
d45a6ae24   Kim Phillips   tools: update che...
5414
  						$allowed[$allow] = 1;
05622191e   Joe Hershberger   tools: checkpatch...
5415
5416
5417
5418
  					}
  					if ($block =~/\b(?:if|for|while)\b/) {
  						#print "APW: ALLOWED: block<$block>
  ";
d45a6ae24   Kim Phillips   tools: update che...
5419
  						$allowed[$allow] = 1;
05622191e   Joe Hershberger   tools: checkpatch...
5420
5421
5422
5423
  					}
  					if (statement_block_size($block) > 1) {
  						#print "APW: ALLOWED: lines block<$block>
  ";
d45a6ae24   Kim Phillips   tools: update che...
5424
  						$allowed[$allow] = 1;
05622191e   Joe Hershberger   tools: checkpatch...
5425
  					}
d45a6ae24   Kim Phillips   tools: update che...
5426
  					$allow++;
05622191e   Joe Hershberger   tools: checkpatch...
5427
  				}
d45a6ae24   Kim Phillips   tools: update che...
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
  				if ($seen) {
  					my $sum_allowed = 0;
  					foreach (@allowed) {
  						$sum_allowed += $_;
  					}
  					if ($sum_allowed == 0) {
  						WARN("BRACES",
  						     "braces {} are not necessary for any arm of this statement
  " . $herectx);
  					} elsif ($sum_allowed != $allow &&
  						 $seen != $allow) {
  						CHK("BRACES",
  						    "braces {} should be used on all arms of this statement
  " . $herectx);
  					}
05622191e   Joe Hershberger   tools: checkpatch...
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
  				}
  			}
  		}
  		if (!defined $suppress_ifbraces{$linenr - 1} &&
  					$line =~ /\b(if|while|for|else)\b/) {
  			my $allowed = 0;
  
  			# Check the pre-context.
  			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
  				#print "APW: ALLOWED: pre<$1>
  ";
  				$allowed = 1;
  			}
  
  			my ($level, $endln, @chunks) =
  				ctx_statement_full($linenr, $realcnt, $-[0]);
  
  			# Check the condition.
  			my ($cond, $block) = @{$chunks[0]};
  			#print "CHECKING<$linenr> cond<$cond> block<$block>
  ";
  			if (defined $cond) {
  				substr($block, 0, length($cond), '');
  			}
  			if (statement_lines($cond) > 1) {
  				#print "APW: ALLOWED: cond<$cond>
  ";
  				$allowed = 1;
  			}
  			if ($block =~/\b(?:if|for|while)\b/) {
  				#print "APW: ALLOWED: block<$block>
  ";
  				$allowed = 1;
  			}
  			if (statement_block_size($block) > 1) {
  				#print "APW: ALLOWED: lines block<$block>
  ";
  				$allowed = 1;
  			}
  			# Check the post-context.
  			if (defined $chunks[1]) {
  				my ($cond, $block) = @{$chunks[1]};
  				if (defined $cond) {
  					substr($block, 0, length($cond), '');
  				}
  				if ($block =~ /^\s*\{/) {
  					#print "APW: ALLOWED: chunk-1 block<$block>
  ";
  					$allowed = 1;
  				}
  			}
  			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
05622191e   Joe Hershberger   tools: checkpatch...
5495
  				my $cnt = statement_rawlines($block);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5496
  				my $herectx = get_stat_here($linenr, $cnt, $here);
05622191e   Joe Hershberger   tools: checkpatch...
5497
5498
5499
5500
5501
5502
  
  				WARN("BRACES",
  				     "braces {} are not necessary for single statement blocks
  " . $herectx);
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
5503
5504
5505
5506
5507
5508
  # check for single line unbalanced braces
  		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
  		    $sline =~ /^.\s*else\s*\{\s*$/) {
  			CHK("BRACES", "Unbalanced braces around else statement
  " . $herecurr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
5509
  # check for unnecessary blank lines around braces
6b9709d91   Tom Rini   scripts: update c...
5510
  		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5511
5512
5513
5514
5515
5516
  			if (CHK("BRACES",
  				"Blank lines aren't necessary before a close brace '}'
  " . $hereprev) &&
  			    $fix && $prevrawline =~ /^\+/) {
  				fix_delete_line($fixlinenr - 1, $prevrawline);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
5517
  		}
6b9709d91   Tom Rini   scripts: update c...
5518
  		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5519
5520
5521
5522
5523
5524
  			if (CHK("BRACES",
  				"Blank lines aren't necessary after an open brace '{'
  " . $hereprev) &&
  			    $fix) {
  				fix_delete_line($fixlinenr, $rawline);
  			}
05622191e   Joe Hershberger   tools: checkpatch...
5525
5526
5527
5528
5529
5530
  		}
  
  # no volatiles please
  		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
  		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
  			WARN("VOLATILE",
6305db960   Heinrich Schuchardt   checkpatch: updat...
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
  			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst
  " . $herecurr);
  		}
  
  # Check for user-visible strings broken across lines, which breaks the ability
  # to grep for the string.  Make exceptions when the previous string ends in a
  # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
  # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
  		if ($line =~ /^\+\s*$String/ &&
  		    $prevline =~ /"\s*$/ &&
  		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
  			if (WARN("SPLIT_STRING",
  				 "quoted string split across lines
  " . $hereprev) &&
  				     $fix &&
  				     $prevrawline =~ /^\+.*"\s*$/ &&
  				     $last_coalesced_string_linenr != $linenr - 1) {
  				my $extracted_string = get_quoted_string($line, $rawline);
  				my $comma_close = "";
  				if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
  					$comma_close = $1;
  				}
  
  				fix_delete_line($fixlinenr - 1, $prevrawline);
  				fix_delete_line($fixlinenr, $rawline);
  				my $fixedline = $prevrawline;
  				$fixedline =~ s/"\s*$//;
  				$fixedline .= substr($extracted_string, 1) . trim($comma_close);
  				fix_insert_line($fixlinenr - 1, $fixedline);
  				$fixedline = $rawline;
  				$fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
  				if ($fixedline !~ /\+\s*$/) {
  					fix_insert_line($fixlinenr, $fixedline);
  				}
  				$last_coalesced_string_linenr = $linenr;
  			}
  		}
  
  # check for missing a space in a string concatenation
  		if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
  			WARN('MISSING_SPACE',
  			     "break quoted strings at a space character
  " . $hereprev);
  		}
  
  # check for an embedded function name in a string when the function is known
  # This does not work very well for -f --file checking as it depends on patch
  # context providing the function name or a single line form for in-file
  # function declarations
  		if ($line =~ /^\+.*$String/ &&
  		    defined($context_function) &&
  		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
  		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
  			WARN("EMBEDDED_FUNCTION_NAME",
  			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string
  " . $herecurr);
  		}
  
  # check for spaces before a quoted newline
  		if ($rawline =~ /^.*\".*\s\
  /) {
  			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
  				 "unnecessary whitespace before a quoted newline
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\
  /$1\
  /;
  			}
  
  		}
  
  # concatenated string without spaces between elements
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5604
  		if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5605
5606
5607
5608
5609
5610
  			CHK("CONCATENATED_STRING",
  			    "Concatenated strings should use spaces between elements
  " . $herecurr);
  		}
  
  # uncoalesced string fragments
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5611
  		if ($line =~ /$String\s*"/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
  			WARN("STRING_FRAGMENTS",
  			     "Consecutive strings are generally better as a single string
  " . $herecurr);
  		}
  
  # check for non-standard and hex prefixed decimal printf formats
  		my $show_L = 1;	#don't show the same defect twice
  		my $show_Z = 1;
  		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
  			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
  			$string =~ s/%%/__/g;
  			# check for %L
  			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
  				WARN("PRINTF_L",
  				     "\%L$1 is non-standard C, use %ll$1
  " . $herecurr);
  				$show_L = 0;
  			}
  			# check for %Z
  			if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
  				WARN("PRINTF_Z",
  				     "%Z$1 is non-standard C, use %z$1
  " . $herecurr);
  				$show_Z = 0;
  			}
  			# check for 0x<decimal>
  			if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
  				ERROR("PRINTF_0XDECIMAL",
  				      "Prefixing 0x with decimal output is defective
  " . $herecurr);
  			}
  		}
  
  # check for line continuations in quoted strings with odd counts of "
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5646
  		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5647
5648
5649
  			WARN("LINE_CONTINUATIONS",
  			     "Avoid line continuations in quoted strings
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
5650
5651
5652
5653
5654
5655
5656
5657
5658
  		}
  
  # warn about #if 0
  		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
  			CHK("REDUNDANT_CODE",
  			    "if this code is redundant consider removing it
  " .
  				$herecurr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
5659
5660
  # check for needless "if (<foo>) fn(<foo>)" uses
  		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
  			my $tested = quotemeta($1);
  			my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
  			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
  				my $func = $1;
  				if (WARN('NEEDLESS_IF',
  					 "$func(NULL) is safe and this check is probably not required
  " . $hereprev) &&
  				    $fix) {
  					my $do_fix = 1;
  					my $leading_tabs = "";
  					my $new_leading_tabs = "";
  					if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
  						$leading_tabs = $1;
  					} else {
  						$do_fix = 0;
  					}
  					if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
  						$new_leading_tabs = $1;
  						if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
  							$do_fix = 0;
  						}
  					} else {
  						$do_fix = 0;
  					}
  					if ($do_fix) {
  						fix_delete_line($fixlinenr - 1, $prevrawline);
  						$fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
  					}
  				}
  			}
  		}
  
  # check for unnecessary "Out of Memory" messages
  		if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
  		    $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
  		    (defined $1 || defined $3) &&
  		    $linenr > 3) {
  			my $testval = $2;
  			my $testline = $lines[$linenr - 3];
  
  			my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
  #			print("line: <$line>
  prevline: <$prevline>
  s: <$s>
  c: <$c>
  
  
  ");
  
  			if ($s =~ /(?:^|
  )[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
  				WARN("OOM_MESSAGE",
  				     "Possible unnecessary 'out of memory' message
  " . $hereprev);
  			}
  		}
  
  # check for logging functions with KERN_<LEVEL>
  		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
  		    $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
  			my $level = $1;
  			if (WARN("UNNECESSARY_KERN_LEVEL",
  				 "Possible unnecessary $level
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] =~ s/\s*$level\s*//;
  			}
  		}
  
  # check for logging continuations
  		if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
  			WARN("LOGGING_CONTINUATION",
  			     "Avoid logging continuation uses where feasible
  " . $herecurr);
  		}
  
  # check for mask then right shift without a parentheses
  		if ($^V && $^V ge 5.10.0 &&
  		    $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
  		    $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
  			WARN("MASK_THEN_SHIFT",
  			     "Possible precedence defect with mask then right shift - may need parentheses
  " . $herecurr);
  		}
  
  # check for pointer comparisons to NULL
  		if ($^V && $^V ge 5.10.0) {
  			while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
  				my $val = $1;
  				my $equal = "!";
  				$equal = "" if ($4 eq "!=");
  				if (CHK("COMPARISON_TO_NULL",
  					"Comparison to NULL could be written \"${equal}${val}\"
  " . $herecurr) &&
  					    $fix) {
  					$fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
  				}
05622191e   Joe Hershberger   tools: checkpatch...
5758
5759
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
  # check for bad placement of section $InitAttribute (e.g.: __initdata)
  		if ($line =~ /(\b$InitAttribute\b)/) {
  			my $attr = $1;
  			if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
  				my $ptr = $1;
  				my $var = $2;
  				if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
  				      ERROR("MISPLACED_INIT",
  					    "$attr should be placed after $var
  " . $herecurr)) ||
  				     ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
  				      WARN("MISPLACED_INIT",
  					   "$attr should be placed after $var
  " . $herecurr))) &&
  				    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5775
  					$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;
6b9709d91   Tom Rini   scripts: update c...
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
  				}
  			}
  		}
  
  # check for $InitAttributeData (ie: __initdata) with const
  		if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
  			my $attr = $1;
  			$attr =~ /($InitAttributePrefix)(.*)/;
  			my $attr_prefix = $1;
  			my $attr_type = $2;
  			if (ERROR("INIT_ATTRIBUTE",
  				  "Use of const init definition must use ${attr_prefix}initconst
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5790
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
  				    s/$InitAttributeData/${attr_prefix}initconst/;
  			}
  		}
  
  # check for $InitAttributeConst (ie: __initconst) without const
  		if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
  			my $attr = $1;
  			if (ERROR("INIT_ATTRIBUTE",
  				  "Use of $attr requires a separate use of const
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5802
  				my $lead = $fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
5803
5804
5805
5806
  				    /(^\+\s*(?:static\s+))/;
  				$lead = rtrim($1);
  				$lead = "$lead " if ($lead !~ /^\+$/);
  				$lead = "${lead}const ";
6305db960   Heinrich Schuchardt   checkpatch: updat...
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
  				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
  			}
  		}
  
  # check for __read_mostly with const non-pointer (should just be const)
  		if ($line =~ /\b__read_mostly\b/ &&
  		    $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
  			if (ERROR("CONST_READ_MOSTLY",
  				  "Invalid use of __read_mostly with const type
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
  			}
  		}
  
  # don't use __constant_<foo> functions outside of include/uapi/
  		if ($realfile !~ m@^include/uapi/@ &&
  		    $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
  			my $constant_func = $1;
  			my $func = $constant_func;
  			$func =~ s/^__constant_//;
  			if (WARN("CONSTANT_CONVERSION",
  				 "$constant_func should be $func
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
6b9709d91   Tom Rini   scripts: update c...
5833
5834
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
5835
  # prefer usleep_range over udelay
d45a6ae24   Kim Phillips   tools: update che...
5836
  		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5837
  			my $delay = $1;
05622191e   Joe Hershberger   tools: checkpatch...
5838
  			# ignore udelay's < 10, however
6305db960   Heinrich Schuchardt   checkpatch: updat...
5839
  			if (! ($delay < 10) ) {
05622191e   Joe Hershberger   tools: checkpatch...
5840
  				CHK("USLEEP_RANGE",
6305db960   Heinrich Schuchardt   checkpatch: updat...
5841
5842
5843
5844
5845
5846
5847
  				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt
  " . $herecurr);
  			}
  			if ($delay > 2000) {
  				WARN("LONG_UDELAY",
  				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
5848
5849
5850
5851
5852
5853
5854
  			}
  		}
  
  # warn about unexpectedly long msleep's
  		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
  			if ($1 < 20) {
  				WARN("MSLEEP",
6305db960   Heinrich Schuchardt   checkpatch: updat...
5855
5856
  				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
5857
5858
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
  # check for comparisons of jiffies
  		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
  			WARN("JIFFIES_COMPARISON",
  			     "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends
  " . $herecurr);
  		}
  
  # check for comparisons of get_jiffies_64()
  		if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
  			WARN("JIFFIES_COMPARISON",
  			     "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
  # warn about #ifdefs in C files
  #		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
  #			print "#ifdef in C files should be avoided
  ";
  #			print "$herecurr";
  #			$clean = 0;
  #		}
  
  # warn about spacing in #ifdefs
  		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
6b9709d91   Tom Rini   scripts: update c...
5882
5883
5884
5885
  			if (ERROR("SPACING",
  				  "exactly one space required after that #$1
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5886
  				$fixed[$fixlinenr] =~
6b9709d91   Tom Rini   scripts: update c...
5887
5888
  				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
  			}
05622191e   Joe Hershberger   tools: checkpatch...
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
  		}
  
  # check for spinlock_t definitions without a comment.
  		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
  		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
  			my $which = $1;
  			if (!ctx_has_comment($first_line, $linenr)) {
  				CHK("UNCOMMENTED_DEFINITION",
  				    "$1 definition without comment
  " . $herecurr);
  			}
  		}
  # check for memory barriers without a comment.
6305db960   Heinrich Schuchardt   checkpatch: updat...
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
  
  		my $barriers = qr{
  			mb|
  			rmb|
  			wmb|
  			read_barrier_depends
  		}x;
  		my $barrier_stems = qr{
  			mb__before_atomic|
  			mb__after_atomic|
  			store_release|
  			load_acquire|
  			store_mb|
  			(?:$barriers)
  		}x;
  		my $all_barriers = qr{
  			(?:$barriers)|
  			smp_(?:$barrier_stems)|
  			virt_(?:$barrier_stems)
  		}x;
  
  		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
05622191e   Joe Hershberger   tools: checkpatch...
5924
  			if (!ctx_has_comment($first_line, $linenr)) {
6b9709d91   Tom Rini   scripts: update c...
5925
5926
5927
  				WARN("MEMORY_BARRIER",
  				     "memory barrier without comment
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
5928
5929
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
  
  		my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
  
  		if ($realfile !~ m@^include/asm-generic/@ &&
  		    $realfile !~ m@/barrier\.h$@ &&
  		    $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
  		    $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
  			WARN("MEMORY_BARRIER",
  			     "__smp memory barriers shouldn't be used outside barrier.h and asm-generic
  " . $herecurr);
  		}
  
  # check for waitqueue_active without a comment.
  		if ($line =~ /\bwaitqueue_active\s*\(/) {
  			if (!ctx_has_comment($first_line, $linenr)) {
  				WARN("WAITQUEUE_ACTIVE",
  				     "waitqueue_active without comment
  " . $herecurr);
  			}
  		}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
5950
5951
5952
5953
5954
5955
  # check for smp_read_barrier_depends and read_barrier_depends
  		if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
  			WARN("READ_BARRIER_DEPENDS",
  			     "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
5956
5957
5958
5959
5960
5961
  # check of hardware specific defines
  		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
  			CHK("ARCH_DEFINES",
  			    "architecture specific defines should be avoided
  " .  $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
5962
5963
5964
5965
5966
5967
  # check that the storage class is not after a type
  		if ($line =~ /\b($Type)\s+($Storage)\b/) {
  			WARN("STORAGE_CLASS",
  			     "storage class '$2' should be located before type '$1'
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
5968
  # Check that the storage class is at the beginning of a declaration
6305db960   Heinrich Schuchardt   checkpatch: updat...
5969
5970
5971
5972
  		if ($line =~ /\b$Storage\b/ &&
  		    $line !~ /^.\s*$Storage/ &&
  		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
  		    $1 !~ /[\,\)]\s*$/) {
05622191e   Joe Hershberger   tools: checkpatch...
5973
  			WARN("STORAGE_CLASS",
6305db960   Heinrich Schuchardt   checkpatch: updat...
5974
5975
  			     "storage class should be at the beginning of the declaration
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
  		}
  
  # check the location of the inline attribute, that it is between
  # storage class and type.
  		if ($line =~ /\b$Type\s+$Inline\b/ ||
  		    $line =~ /\b$Inline\s+$Storage\b/) {
  			ERROR("INLINE_LOCATION",
  			      "inline keyword should sit between storage class and type
  " . $herecurr);
  		}
  
  # Check for __inline__ and __inline, prefer inline
6b9709d91   Tom Rini   scripts: update c...
5988
5989
5990
5991
5992
5993
  		if ($realfile !~ m@\binclude/uapi/@ &&
  		    $line =~ /\b(__inline__|__inline)\b/) {
  			if (WARN("INLINE",
  				 "plain inline is preferred over $1
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
5994
  				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6b9709d91   Tom Rini   scripts: update c...
5995
5996
  
  			}
05622191e   Joe Hershberger   tools: checkpatch...
5997
5998
5999
  		}
  
  # Check for __attribute__ packed, prefer __packed
6b9709d91   Tom Rini   scripts: update c...
6000
6001
  		if ($realfile !~ m@\binclude/uapi/@ &&
  		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
05622191e   Joe Hershberger   tools: checkpatch...
6002
6003
6004
6005
  			WARN("PREFER_PACKED",
  			     "__packed is preferred over __attribute__((packed))
  " . $herecurr);
  		}
5c761ce58   Heinrich Schuchardt   checkpatch.pl: Ad...
6006
6007
6008
6009
6010
6011
6012
  # Check for new packed members, warn to use care
  		if ($realfile !~ m@\binclude/uapi/@ &&
  		    $line =~ /\b(__attribute__\s*\(\s*\(.*\bpacked|__packed)\b/) {
  			WARN("NEW_PACKED",
  			     "Adding new packed members is to be done with care
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6013
  # Check for __attribute__ aligned, prefer __aligned
6b9709d91   Tom Rini   scripts: update c...
6014
6015
  		if ($realfile !~ m@\binclude/uapi/@ &&
  		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
05622191e   Joe Hershberger   tools: checkpatch...
6016
6017
6018
6019
  			WARN("PREFER_ALIGNED",
  			     "__aligned(size) is preferred over __attribute__((aligned(size)))
  " . $herecurr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
6020
  # Check for __attribute__ format(printf, prefer __printf
6b9709d91   Tom Rini   scripts: update c...
6021
6022
6023
6024
6025
6026
  		if ($realfile !~ m@\binclude/uapi/@ &&
  		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
  			if (WARN("PREFER_PRINTF",
  				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6027
  				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
6b9709d91   Tom Rini   scripts: update c...
6028
6029
  
  			}
d45a6ae24   Kim Phillips   tools: update che...
6030
6031
6032
  		}
  
  # Check for __attribute__ format(scanf, prefer __scanf
6b9709d91   Tom Rini   scripts: update c...
6033
6034
6035
6036
6037
6038
  		if ($realfile !~ m@\binclude/uapi/@ &&
  		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
  			if (WARN("PREFER_SCANF",
  				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
  				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
  			}
  		}
  
  # Check for __attribute__ weak, or __weak declarations (may have link issues)
  		if ($^V && $^V ge 5.10.0 &&
  		    $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
  		    ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
  		     $line =~ /\b__weak\b/)) {
  			ERROR("WEAK_DECLARATION",
  			      "Using weak declarations can have unintended link defects
  " . $herecurr);
  		}
  
  # check for c99 types like uint8_t used outside of uapi/ and tools/
  		if ($realfile !~ m@\binclude/uapi/@ &&
  		    $realfile !~ m@\btools/@ &&
  		    $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
  			my $type = $1;
  			if ($type =~ /\b($typeC99Typedefs)\b/) {
  				$type = $1;
  				my $kernel_type = 'u';
  				$kernel_type = 's' if ($type =~ /^_*[si]/);
  				$type =~ /(\d+)/;
  				$kernel_type .= $1;
  				if (CHK("PREFER_KERNEL_TYPES",
  					"Prefer kernel type '$kernel_type' over '$type'
  " . $herecurr) &&
  				    $fix) {
  					$fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
  				}
  			}
  		}
  
  # check for cast of C90 native int or longer types constants
  		if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
  			my $cast = $1;
  			my $const = $2;
  			if (WARN("TYPECAST_INT_CONSTANT",
  				 "Unnecessary typecast of c90 int constant
  " . $herecurr) &&
  			    $fix) {
  				my $suffix = "";
  				my $newconst = $const;
  				$newconst =~ s/${Int_type}$//;
  				$suffix .= 'U' if ($cast =~ /\bunsigned\b/);
  				if ($cast =~ /\blong\s+long\b/) {
  					$suffix .= 'LL';
  				} elsif ($cast =~ /\blong\b/) {
  					$suffix .= 'L';
  				}
  				$fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6b9709d91   Tom Rini   scripts: update c...
6091
  			}
d45a6ae24   Kim Phillips   tools: update che...
6092
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6093
6094
6095
6096
6097
6098
  # check for sizeof(&)
  		if ($line =~ /\bsizeof\s*\(\s*\&/) {
  			WARN("SIZEOF_ADDRESS",
  			     "sizeof(& should be avoided
  " . $herecurr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
6099
6100
  # check for sizeof without parenthesis
  		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6b9709d91   Tom Rini   scripts: update c...
6101
6102
6103
6104
  			if (WARN("SIZEOF_PARENTHESIS",
  				 "sizeof $1 should be sizeof($1)
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6105
  				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6b9709d91   Tom Rini   scripts: update c...
6106
  			}
d45a6ae24   Kim Phillips   tools: update che...
6107
  		}
d45a6ae24   Kim Phillips   tools: update che...
6108
6109
6110
6111
6112
6113
  # check for struct spinlock declarations
  		if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
  			WARN("USE_SPINLOCK_T",
  			     "struct spinlock should be spinlock_t
  " . $herecurr);
  		}
6b9709d91   Tom Rini   scripts: update c...
6114
6115
6116
  # check for seq_printf uses that could be seq_puts
  		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
  			my $fmt = get_quoted_string($line, $rawline);
6305db960   Heinrich Schuchardt   checkpatch: updat...
6117
6118
  			$fmt =~ s/%%//g;
  			if ($fmt !~ /%/) {
6b9709d91   Tom Rini   scripts: update c...
6119
6120
6121
6122
  				if (WARN("PREFER_SEQ_PUTS",
  					 "Prefer seq_puts to seq_printf
  " . $herecurr) &&
  				    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6123
6124
6125
6126
  					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
  				}
  			}
  		}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6127
  # check for vsprintf extension %p<foo> misuses
6305db960   Heinrich Schuchardt   checkpatch: updat...
6128
6129
6130
6131
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
  		    $1 !~ /^_*volatile_*$/) {
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6132
6133
6134
6135
  			my $specifier;
  			my $extension;
  			my $bad_specifier = "";
  			my $stat_real;
6305db960   Heinrich Schuchardt   checkpatch: updat...
6136
6137
6138
6139
6140
6141
  			my $lc = $stat =~ tr@
  @@;
  			$lc = $lc + $linenr;
  		        for (my $count = $linenr; $count <= $lc; $count++) {
  				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
  				$fmt =~ s/%%//g;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
  
  				while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
  					$specifier = $1;
  					$extension = $2;
  					if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
  						$bad_specifier = $specifier;
  						last;
  					}
  					if ($extension eq "x" && !defined($stat_real)) {
  						if (!defined($stat_real)) {
  							$stat_real = get_stat_real($linenr, $lc);
  						}
  						WARN("VSPRINTF_SPECIFIER_PX",
  						     "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.
  " . "$here
  $stat_real
  ");
  					}
6b9709d91   Tom Rini   scripts: update c...
6160
  				}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
  				if ($bad_specifier ne "") {
  					my $stat_real = get_stat_real($linenr, $lc);
  					my $ext_type = "Invalid";
  					my $use = "";
  					if ($bad_specifier =~ /p[Ff]/) {
  						$ext_type = "Deprecated";
  						$use = " - use %pS instead";
  						$use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
  					}
  
  					WARN("VSPRINTF_POINTER_EXTENSION",
  					     "$ext_type vsprintf pointer extension '$bad_specifier'$use
  " . "$here
  $stat_real
  ");
6305db960   Heinrich Schuchardt   checkpatch: updat...
6176
  				}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6177
  			}
6b9709d91   Tom Rini   scripts: update c...
6178
  		}
d45a6ae24   Kim Phillips   tools: update che...
6179
6180
6181
  # Check for misused memsets
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
6182
  		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
d45a6ae24   Kim Phillips   tools: update che...
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
  
  			my $ms_addr = $2;
  			my $ms_val = $7;
  			my $ms_size = $12;
  
  			if ($ms_size =~ /^(0x|)0$/i) {
  				ERROR("MEMSET",
  				      "memset to 0's uses 0 as the 2nd argument, not the 3rd
  " . "$here
  $stat
  ");
  			} elsif ($ms_size =~ /^(0x|)1$/i) {
  				WARN("MEMSET",
  				     "single byte memset is suspicious. Swapped 2nd/3rd argument?
  " . "$here
  $stat
  ");
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
6202
  # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6305db960   Heinrich Schuchardt   checkpatch: updat...
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
  #		if ($^V && $^V ge 5.10.0 &&
  #		    defined $stat &&
  #		    $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
  #			if (WARN("PREFER_ETHER_ADDR_COPY",
  #				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)
  " . "$here
  $stat
  ") &&
  #			    $fix) {
  #				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
  #			}
  #		}
  
  # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
  #		if ($^V && $^V ge 5.10.0 &&
  #		    defined $stat &&
  #		    $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
  #			WARN("PREFER_ETHER_ADDR_EQUAL",
  #			     "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()
  " . "$here
  $stat
  ")
  #		}
  
  # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
  # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
  #		if ($^V && $^V ge 5.10.0 &&
  #		    defined $stat &&
  #		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
  #
  #			my $ms_val = $7;
  #
  #			if ($ms_val =~ /^(?:0x|)0+$/i) {
  #				if (WARN("PREFER_ETH_ZERO_ADDR",
  #					 "Prefer eth_zero_addr over memset()
  " . "$here
  $stat
  ") &&
  #				    $fix) {
  #					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
  #				}
  #			} elsif ($ms_val =~ /^(?:0xff|255)$/i) {
  #				if (WARN("PREFER_ETH_BROADCAST_ADDR",
  #					 "Prefer eth_broadcast_addr() over memset()
  " . "$here
  $stat
  ") &&
  #				    $fix) {
  #					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
  #				}
  #			}
  #		}
6b9709d91   Tom Rini   scripts: update c...
6255

d45a6ae24   Kim Phillips   tools: update che...
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
  # typecasts on min/max could be min_t/max_t
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
  			if (defined $2 || defined $7) {
  				my $call = $1;
  				my $cast1 = deparenthesize($2);
  				my $arg1 = $3;
  				my $cast2 = deparenthesize($7);
  				my $arg2 = $8;
  				my $cast;
  
  				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
  					$cast = "$cast1 or $cast2";
  				} elsif ($cast1 ne "") {
  					$cast = $cast1;
  				} else {
  					$cast = $cast2;
  				}
  				WARN("MINMAX",
  				     "$call() should probably be ${call}_t($cast, $arg1, $arg2)
  " . "$here
  $stat
  ");
  			}
  		}
  
  # check usleep_range arguments
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
  			my $min = $1;
  			my $max = $7;
  			if ($min eq $max) {
  				WARN("USLEEP_RANGE",
  				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt
  " . "$here
  $stat
  ");
  			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
  				 $min > $max) {
  				WARN("USLEEP_RANGE",
  				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt
  " . "$here
  $stat
  ");
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
6304
6305
6306
  # check for naked sscanf
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
6307
  		    $line =~ /\bsscanf\b/ &&
6b9709d91   Tom Rini   scripts: update c...
6308
6309
6310
6311
6312
6313
  		    ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
  		     $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
  		     $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
  			my $lc = $stat =~ tr@
  @@;
  			$lc = $lc + $linenr;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6314
  			my $stat_real = get_stat_real($linenr, $lc);
6b9709d91   Tom Rini   scripts: update c...
6315
6316
6317
6318
6319
6320
  			WARN("NAKED_SSCANF",
  			     "unchecked sscanf return value
  " . "$here
  $stat_real
  ");
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6321
6322
6323
6324
6325
6326
6327
  # check for simple sscanf that should be kstrto<foo>
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $line =~ /\bsscanf\b/) {
  			my $lc = $stat =~ tr@
  @@;
  			$lc = $lc + $linenr;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6328
  			my $stat_real = get_stat_real($linenr, $lc);
6305db960   Heinrich Schuchardt   checkpatch: updat...
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
  			if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
  				my $format = $6;
  				my $count = $format =~ tr@%@%@;
  				if ($count == 1 &&
  				    $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
  					WARN("SSCANF_TO_KSTRTO",
  					     "Prefer kstrto<type> to single variable sscanf
  " . "$here
  $stat_real
  ");
  				}
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
6342
6343
6344
6345
6346
6347
6348
  # check for new externs in .h files.
  		if ($realfile =~ /\.h$/ &&
  		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
  			if (CHK("AVOID_EXTERNS",
  				"extern prototypes should be avoided in .h files
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6349
  				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6b9709d91   Tom Rini   scripts: update c...
6350
6351
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
  # check for new externs in .c files.
  		if ($realfile =~ /\.c$/ && defined $stat &&
  		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
  		{
  			my $function_name = $1;
  			my $paren_space = $2;
  
  			my $s = $stat;
  			if (defined $cond) {
  				substr($s, 0, length($cond), '');
  			}
  			if ($s =~ /^\s*;/ &&
  			    $function_name ne 'uninitialized_var')
  			{
  				WARN("AVOID_EXTERNS",
  				     "externs should be avoided in .c files
  " .  $herecurr);
  			}
  
  			if ($paren_space =~ /
  /) {
  				WARN("FUNCTION_ARGUMENTS",
  				     "arguments for function declarations should follow identifier
  " . $herecurr);
  			}
  
  		} elsif ($realfile =~ /\.c$/ && defined $stat &&
  		    $stat =~ /^.\s*extern\s+/)
  		{
  			WARN("AVOID_EXTERNS",
  			     "externs should be avoided in .c files
  " .  $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6385
6386
  # check for function declarations that have arguments without identifier names
  		if (defined $stat &&
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6387
  		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
  		    $1 ne "void") {
  			my $args = trim($1);
  			while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
  				my $arg = trim($1);
  				if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
  					WARN("FUNCTION_ARGUMENTS",
  					     "function definition argument '$arg' should also have an identifier name
  " . $herecurr);
  				}
  			}
  		}
  
  # check for function definitions
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
  			$context_function = $1;
  
  # check for multiline function definition with misplaced open brace
  			my $ok = 0;
  			my $cnt = statement_rawlines($stat);
  			my $herectx = $here . "
  ";
  			for (my $n = 0; $n < $cnt; $n++) {
  				my $rl = raw_line($linenr, $n);
  				$herectx .=  $rl . "
  ";
  				$ok = 1 if ($rl =~ /^[ \+]\{/);
  				$ok = 1 if ($rl =~ /\{/ && $n == 0);
  				last if $rl =~ /^[ \+].*\{/;
  			}
  			if (!$ok) {
  				ERROR("OPEN_BRACE",
  				      "open brace '{' following function definitions go on the next line
  " . $herectx);
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6425
6426
6427
6428
6429
6430
  # checks for new __setup's
  		if ($rawline =~ /\b__setup\("([^"]*)"/) {
  			my $name = $1;
  
  			if (!grep(/$name/, @setup_docs)) {
  				CHK("UNDOCUMENTED_SETUP",
6305db960   Heinrich Schuchardt   checkpatch: updat...
6431
6432
  				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
6433
6434
6435
6436
6437
6438
6439
6440
6441
  			}
  		}
  
  # check for pointless casting of kmalloc return
  		if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
  			WARN("UNNECESSARY_CASTS",
  			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html
  " . $herecurr);
  		}
6b9709d91   Tom Rini   scripts: update c...
6442
6443
6444
6445
6446
6447
6448
6449
  # alloc style
  # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
  		if ($^V && $^V ge 5.10.0 &&
  		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
  			CHK("ALLOC_SIZEOF_STRUCT",
  			    "Prefer $3(sizeof(*$1)...) over $3($4...)
  " . $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
  # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
  			my $oldfunc = $3;
  			my $a1 = $4;
  			my $a2 = $10;
  			my $newfunc = "kmalloc_array";
  			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
  			my $r1 = $a1;
  			my $r2 = $a2;
  			if ($a1 =~ /^sizeof\s*\S/) {
  				$r1 = $a2;
  				$r2 = $a1;
  			}
  			if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
  			    !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6467
  				my $cnt = statement_rawlines($stat);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6468
  				my $herectx = get_stat_here($linenr, $cnt, $here);
6305db960   Heinrich Schuchardt   checkpatch: updat...
6469
6470
6471
6472
6473
6474
6475
6476
6477
  				if (WARN("ALLOC_WITH_MULTIPLY",
  					 "Prefer $newfunc over $oldfunc with multiply
  " . $herectx) &&
  				    $cnt == 1 &&
  				    $fix) {
  					$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;
  				}
  			}
  		}
6b9709d91   Tom Rini   scripts: update c...
6478
6479
6480
6481
6482
6483
6484
  # check for krealloc arg reuse
  		if ($^V && $^V ge 5.10.0 &&
  		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
  			WARN("KREALLOC_ARG_REUSE",
  			     "Reusing the krealloc arg is almost always a bug
  " . $herecurr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
6485
6486
6487
6488
6489
6490
  # check for alloc argument mismatch
  		if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
  			WARN("ALLOC_ARRAY_ARGS",
  			     "$1 uses number as first arg, sizeof is generally wrong
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6491
6492
  # check for multiple semicolons
  		if ($line =~ /;\s*;\s*$/) {
6b9709d91   Tom Rini   scripts: update c...
6493
6494
6495
6496
  			if (WARN("ONE_SEMICOLON",
  				 "Statements terminations use 1 semicolon
  " . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
  				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
  			}
  		}
  
  # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
  		if ($realfile !~ m@^include/uapi/@ &&
  		    $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
  			my $ull = "";
  			$ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
  			if (CHK("BIT_MACRO",
  				"Prefer using the BIT$ull macro
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
  			}
  		}
  
  # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
  		if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
  			my $config = $1;
  			if (WARN("PREFER_IS_ENABLED",
  				 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE
  " . $herecurr) &&
  			    $fix) {
  				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6b9709d91   Tom Rini   scripts: update c...
6522
6523
  			}
  		}
fc0b5948e   Robert P. J. Day   Various, accumula...
6524
  # check for case / default statements not preceded by break/fallthrough/switch
6b9709d91   Tom Rini   scripts: update c...
6525
6526
6527
6528
6529
  		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
  			my $has_break = 0;
  			my $has_statement = 0;
  			my $count = 0;
  			my $prevline = $linenr;
6305db960   Heinrich Schuchardt   checkpatch: updat...
6530
  			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6b9709d91   Tom Rini   scripts: update c...
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
  				$prevline--;
  				my $rline = $rawlines[$prevline - 1];
  				my $fline = $lines[$prevline - 1];
  				last if ($fline =~ /^\@\@/);
  				next if ($fline =~ /^\-/);
  				next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
  				$has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
  				next if ($fline =~ /^.[\s$;]*$/);
  				$has_statement = 1;
  				$count++;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6541
  				$has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6b9709d91   Tom Rini   scripts: update c...
6542
6543
6544
  			}
  			if (!$has_break && $has_statement) {
  				WARN("MISSING_BREAK",
fc0b5948e   Robert P. J. Day   Various, accumula...
6545
6546
  				     "Possible switch case/default not preceded by break or fallthrough comment
  " . $herecurr);
6b9709d91   Tom Rini   scripts: update c...
6547
  			}
05622191e   Joe Hershberger   tools: checkpatch...
6548
  		}
d45a6ae24   Kim Phillips   tools: update che...
6549
6550
6551
6552
  # check for switch/default statements without a break;
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
d45a6ae24   Kim Phillips   tools: update che...
6553
  			my $cnt = statement_rawlines($stat);
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6554
  			my $herectx = get_stat_here($linenr, $cnt, $here);
d45a6ae24   Kim Phillips   tools: update che...
6555
6556
6557
  			WARN("DEFAULT_NO_BREAK",
  			     "switch default: should use break
  " . $herectx);
172a3a82a   Eric Nelson   checkpatch: add c...
6558
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6559
  # check for gcc specific __FUNCTION__
6b9709d91   Tom Rini   scripts: update c...
6560
6561
6562
6563
6564
  		if ($line =~ /\b__FUNCTION__\b/) {
  			if (WARN("USE_FUNC",
  				 "__func__ should be used instead of gcc specific __FUNCTION__
  "  . $herecurr) &&
  			    $fix) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6565
  				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6b9709d91   Tom Rini   scripts: update c...
6566
  			}
05622191e   Joe Hershberger   tools: checkpatch...
6567
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6568
6569
6570
6571
6572
6573
  # check for uses of __DATE__, __TIME__, __TIMESTAMP__
  		while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
  			ERROR("DATE_TIME",
  			      "Use of the '$1' macro makes the build non-deterministic
  " . $herecurr);
  		}
d45a6ae24   Kim Phillips   tools: update che...
6574
6575
6576
6577
6578
6579
  # check for use of yield()
  		if ($line =~ /\byield\s*\(\s*\)/) {
  			WARN("YIELD",
  			     "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)
  "  . $herecurr);
  		}
6b9709d91   Tom Rini   scripts: update c...
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
  # check for comparisons against true and false
  		if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
  			my $lead = $1;
  			my $arg = $2;
  			my $test = $3;
  			my $otype = $4;
  			my $trail = $5;
  			my $op = "!";
  
  			($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
  
  			my $type = lc($otype);
  			if ($type =~ /^(?:true|false)$/) {
  				if (("$test" eq "==" && "$type" eq "true") ||
  				    ("$test" eq "!=" && "$type" eq "false")) {
  					$op = "";
  				}
  
  				CHK("BOOL_COMPARISON",
  				    "Using comparison to $otype is error prone
  " . $herecurr);
  
  ## maybe suggesting a correct construct would better
  ##				    "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'
  " . $herecurr);
  
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6608
6609
6610
6611
6612
  # check for semaphores initialized locked
  		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
  			WARN("CONSIDER_COMPLETION",
  			     "consider using a completion
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
6613
  		}
d45a6ae24   Kim Phillips   tools: update che...
6614
6615
6616
  
  # recommend kstrto* over simple_strto* and strict_strto*
  		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
05622191e   Joe Hershberger   tools: checkpatch...
6617
  			WARN("CONSIDER_KSTRTO",
d45a6ae24   Kim Phillips   tools: update che...
6618
6619
  			     "$1 is obsolete, use k$3 instead
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
6620
  		}
d45a6ae24   Kim Phillips   tools: update che...
6621

6305db960   Heinrich Schuchardt   checkpatch: updat...
6622
  # check for __initcall(), use device_initcall() explicitly or more appropriate function please
05622191e   Joe Hershberger   tools: checkpatch...
6623
6624
  		if ($line =~ /^.\s*__initcall\s*\(/) {
  			WARN("USE_DEVICE_INITCALL",
6305db960   Heinrich Schuchardt   checkpatch: updat...
6625
6626
6627
6628
6629
6630
  			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)
  " . $herecurr);
  		}
  
  # check for various structs that are normally const (ops, kgdb, device_tree)
  # and avoid what seem like struct definitions 'struct foo {'
05622191e   Joe Hershberger   tools: checkpatch...
6631
  		if ($line !~ /\bconst\b/ &&
6305db960   Heinrich Schuchardt   checkpatch: updat...
6632
  		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
05622191e   Joe Hershberger   tools: checkpatch...
6633
  			WARN("CONST_STRUCT",
6305db960   Heinrich Schuchardt   checkpatch: updat...
6634
6635
  			     "struct $1 should normally be const
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
  		}
  
  # use of NR_CPUS is usually wrong
  # ignore definitions of NR_CPUS and usage to define arrays as likely right
  		if ($line =~ /\bNR_CPUS\b/ &&
  		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
  		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
  		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
  		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
  		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
  		{
  			WARN("NR_CPUS",
  			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc
  " . $herecurr);
  		}
6b9709d91   Tom Rini   scripts: update c...
6651
6652
6653
6654
6655
6656
  # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
  		if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
  			ERROR("DEFINE_ARCH_HAS",
  			      "#define of '$1' is wrong - use Kconfig variables or standard guards instead
  " . $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6657
6658
6659
6660
6661
6662
  # likely/unlikely comparisons similar to "(likely(foo) > 0)"
  		if ($^V && $^V ge 5.10.0 &&
  		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
  			WARN("LIKELY_MISUSE",
  			     "Using $1 should generally have parentheses around the comparison
  " . $herecurr);
05622191e   Joe Hershberger   tools: checkpatch...
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
  		}
  
  # whine mightly about in_atomic
  		if ($line =~ /\bin_atomic\s*\(/) {
  			if ($realfile =~ m@^drivers/@) {
  				ERROR("IN_ATOMIC",
  				      "do not use in_atomic in drivers
  " . $herecurr);
  			} elsif ($realfile !~ m@^kernel/@) {
  				WARN("IN_ATOMIC",
  				     "use of in_atomic() is incorrect outside core kernel code
  " . $herecurr);
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6677
6678
6679
6680
6681
6682
  # check for mutex_trylock_recursive usage
  		if ($line =~ /mutex_trylock_recursive/) {
  			ERROR("LOCKING",
  			      "recursive locking is bad, do not use this ever.
  " . $herecurr);
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
  # check for lockdep_set_novalidate_class
  		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
  		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
  			if ($realfile !~ m@^kernel/lockdep@ &&
  			    $realfile !~ m@^include/linux/lockdep@ &&
  			    $realfile !~ m@^drivers/base/core@) {
  				ERROR("LOCKDEP",
  				      "lockdep_no_validate class is reserved for device->mutex.
  " . $herecurr);
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6694
6695
  		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
  		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
05622191e   Joe Hershberger   tools: checkpatch...
6696
6697
6698
6699
  			WARN("EXPORTED_WORLD_WRITABLE",
  			     "Exporting world writable files is usually an error. Consider more restrictive permissions.
  " . $herecurr);
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6700

c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
  # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
  # and whether or not function naming is typical and if
  # DEVICE_ATTR permissions uses are unusual too
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $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*\)/) {
  			my $var = $1;
  			my $perms = $2;
  			my $show = $3;
  			my $store = $4;
  			my $octal_perms = perms_to_octal($perms);
  			if ($show =~ /^${var}_show$/ &&
  			    $store =~ /^${var}_store$/ &&
  			    $octal_perms eq "0644") {
  				if (WARN("DEVICE_ATTR_RW",
  					 "Use DEVICE_ATTR_RW
  " . $herecurr) &&
  				    $fix) {
  					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
  				}
  			} elsif ($show =~ /^${var}_show$/ &&
  				 $store =~ /^NULL$/ &&
  				 $octal_perms eq "0444") {
  				if (WARN("DEVICE_ATTR_RO",
  					 "Use DEVICE_ATTR_RO
  " . $herecurr) &&
  				    $fix) {
  					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
  				}
  			} elsif ($show =~ /^NULL$/ &&
  				 $store =~ /^${var}_store$/ &&
  				 $octal_perms eq "0200") {
  				if (WARN("DEVICE_ATTR_WO",
  					 "Use DEVICE_ATTR_WO
  " . $herecurr) &&
  				    $fix) {
  					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
  				}
  			} elsif ($octal_perms eq "0644" ||
  				 $octal_perms eq "0444" ||
  				 $octal_perms eq "0200") {
  				my $newshow = "$show";
  				$newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
  				my $newstore = $store;
  				$newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
  				my $rename = "";
  				if ($show ne $newshow) {
  					$rename .= " '$show' to '$newshow'";
  				}
  				if ($store ne $newstore) {
  					$rename .= " '$store' to '$newstore'";
  				}
  				WARN("DEVICE_ATTR_FUNCTIONS",
  				     "Consider renaming function(s)$rename
  " . $herecurr);
  			} else {
  				WARN("DEVICE_ATTR_PERMS",
  				     "DEVICE_ATTR unusual permissions '$perms' used
  " . $herecurr);
  			}
  		}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6762
6763
  # Mode permission misuses where it seems decimal should be octal
  # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6764
6765
6766
6767
  # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
  #   specific definition of not visible in sysfs.
  # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
  #   use the default permissions
6305db960   Heinrich Schuchardt   checkpatch: updat...
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
  		if ($^V && $^V ge 5.10.0 &&
  		    defined $stat &&
  		    $line =~ /$mode_perms_search/) {
  			foreach my $entry (@mode_permission_funcs) {
  				my $func = $entry->[0];
  				my $arg_pos = $entry->[1];
  
  				my $lc = $stat =~ tr@
  @@;
  				$lc = $lc + $linenr;
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6778
  				my $stat_real = get_stat_real($linenr, $lc);
6305db960   Heinrich Schuchardt   checkpatch: updat...
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
  
  				my $skip_args = "";
  				if ($arg_pos > 1) {
  					$arg_pos--;
  					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
  				}
  				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
  				if ($stat =~ /$test/) {
  					my $val = $1;
  					$val = $6 if ($skip_args ne "");
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6789
6790
6791
  					if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
  					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
  					     ($val =~ /^$Octal$/ && length($val) ne 4))) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
  						ERROR("NON_OCTAL_PERMISSIONS",
  						      "Use 4 digit octal (0777) not decimal permissions
  " . "$here
  " . $stat_real);
  					}
  					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
  						ERROR("EXPORTED_WORLD_WRITABLE",
  						      "Exporting writable files is usually an error. Consider more restrictive permissions.
  " . "$here
  " . $stat_real);
  					}
  				}
  			}
  		}
  
  # check for uses of S_<PERMS> that could be octal for readability
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6808
6809
6810
  		while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
  			my $oval = $1;
  			my $octal = perms_to_octal($oval);
6305db960   Heinrich Schuchardt   checkpatch: updat...
6811
6812
6813
6814
  			if (WARN("SYMBOLIC_PERMS",
  				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.
  " . $herecurr) &&
  			    $fix) {
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6815
  				$fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6305db960   Heinrich Schuchardt   checkpatch: updat...
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
  			}
  		}
  
  # validate content of MODULE_LICENSE against list from include/linux/module.h
  		if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
  			my $extracted_string = get_quoted_string($line, $rawline);
  			my $valid_licenses = qr{
  						GPL|
  						GPL\ v2|
  						GPL\ and\ additional\ rights|
  						Dual\ BSD/GPL|
  						Dual\ MIT/GPL|
  						Dual\ MPL/GPL|
  						Proprietary
  					}x;
  			if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
  				WARN("MODULE_LICENSE",
  				     "unknown module license " . $extracted_string . "
  " . $herecurr);
  			}
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
  	}
  
  	# If we have no input at all, then there is nothing to report on
  	# so just keep quiet.
  	if ($#rawlines == -1) {
  		exit(0);
  	}
  
  	# In mailback mode only produce a report in the negative, for
  	# things that appear to be patches.
  	if ($mailback && ($clean == 1 || !$is_patch)) {
  		exit(0);
  	}
  
  	# This is not a patch, and we are are in 'no-patch' mode so
  	# just keep quiet.
  	if (!$chk_patch && !$is_patch) {
  		exit(0);
  	}
c398f2df7   Heinrich Schuchardt   checkpatch.pl: up...
6856
  	if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
05622191e   Joe Hershberger   tools: checkpatch...
6857
6858
6859
6860
  		ERROR("NOT_UNIFIED_DIFF",
  		      "Does not appear to be a unified-diff format patch
  ");
  	}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6861
  	if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
05622191e   Joe Hershberger   tools: checkpatch...
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
  		ERROR("MISSING_SIGN_OFF",
  		      "Missing Signed-off-by: line(s)
  ");
  	}
  
  	print report_dump();
  	if ($summary && !($clean == 1 && $quiet == 1)) {
  		print "$filename " if ($summary_file);
  		print "total: $cnt_error errors, $cnt_warn warnings, " .
  			(($check)? "$cnt_chk checks, " : "") .
  			"$cnt_lines lines checked
  ";
05622191e   Joe Hershberger   tools: checkpatch...
6874
6875
6876
  	}
  
  	if ($quiet == 0) {
6305db960   Heinrich Schuchardt   checkpatch: updat...
6877
6878
6879
  		# If there were any defects found and not already fixing them
  		if (!$clean and !$fix) {
  			print << "EOM"
d45a6ae24   Kim Phillips   tools: update che...
6880

6305db960   Heinrich Schuchardt   checkpatch: updat...
6881
6882
6883
  NOTE: For some of the reported defects, checkpatch may be able to
        mechanically convert to the typical style using --fix or --fix-inplace.
  EOM
d45a6ae24   Kim Phillips   tools: update che...
6884
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6885
6886
6887
  		# If there were whitespace errors which cleanpatch can fix
  		# then suggest that.
  		if ($rpt_cleaners) {
05622191e   Joe Hershberger   tools: checkpatch...
6888
  			$rpt_cleaners = 0;
6305db960   Heinrich Schuchardt   checkpatch: updat...
6889
6890
6891
6892
6893
  			print << "EOM"
  
  NOTE: Whitespace errors detected.
        You may wish to use scripts/cleanpatch or scripts/cleanfile
  EOM
05622191e   Joe Hershberger   tools: checkpatch...
6894
6895
  		}
  	}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6896
6897
6898
  	if ($clean == 0 && $fix &&
  	    ("@rawlines" ne "@fixed" ||
  	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6b9709d91   Tom Rini   scripts: update c...
6899
6900
6901
6902
  		my $newfile = $filename;
  		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
  		my $linecount = 0;
  		my $f;
6305db960   Heinrich Schuchardt   checkpatch: updat...
6903
  		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6b9709d91   Tom Rini   scripts: update c...
6904
6905
6906
6907
6908
6909
6910
6911
  		open($f, '>', $newfile)
  		    or die "$P: Can't open $newfile for write
  ";
  		foreach my $fixed_line (@fixed) {
  			$linecount++;
  			if ($file) {
  				if ($linecount > 3) {
  					$fixed_line =~ s/^\+//;
6305db960   Heinrich Schuchardt   checkpatch: updat...
6912
6913
  					print $f $fixed_line . "
  ";
6b9709d91   Tom Rini   scripts: update c...
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
  				}
  			} else {
  				print $f $fixed_line . "
  ";
  			}
  		}
  		close($f);
  
  		if (!$quiet) {
  			print << "EOM";
6305db960   Heinrich Schuchardt   checkpatch: updat...
6924

6b9709d91   Tom Rini   scripts: update c...
6925
6926
6927
6928
6929
6930
6931
  Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
  
  Do _NOT_ trust the results written to this file.
  Do _NOT_ submit these changes without inspecting them for correctness.
  
  This EXPERIMENTAL file is simply a convenience to help rewrite patches.
  No warranties, expressed or implied...
6b9709d91   Tom Rini   scripts: update c...
6932
6933
  EOM
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6934
  	}
6305db960   Heinrich Schuchardt   checkpatch: updat...
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
  	if ($quiet == 0) {
  		print "
  ";
  		if ($clean == 1) {
  			print "$vname has no obvious style problems and is ready for submission.
  ";
  		} else {
  			print "$vname has style problems, please review.
  ";
  		}
05622191e   Joe Hershberger   tools: checkpatch...
6945
  	}
05622191e   Joe Hershberger   tools: checkpatch...
6946
6947
  	return $clean;
  }