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