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