Whamcloud - gitweb
8e4cbb6f5e253c0b017a7ae755e469fff24909ac
[fs/lustre-release.git] / contrib / 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 # Based on linux/scripts/checkpatch.pl from 2.6.38 but uses Lustre
9 # specific deprecated symbol/functions/include lists rather than
10 # Documentation/feature-removal-schedule.txt.
11
12 use strict;
13
14 my $P = $0;
15 $P =~ s@.*/@@g;
16
17 my $V = '0.32';
18
19 use Getopt::Long qw(:config no_auto_abbrev);
20
21 my $quiet = 0;
22 my $tree = 0;
23 my $chk_signoff = 0;
24 my $chk_patch = 1;
25 my $tst_only;
26 my $emacs = 0;
27 my $terse = 0;
28 my $file = 0;
29 my $check = 0;
30 my $summary = 1;
31 my $mailback = 0;
32 my $summary_file = 0;
33 my $show_types = 0;
34 my $root;
35 my %debug;
36 my %ignore_type = ();
37 my @ignore = ();
38 my $help = 0;
39 my $configuration_file = ".checkpatch.conf";
40
41 sub help {
42         my ($exitcode) = @_;
43
44         print << "EOM";
45 Usage: $P [OPTION]... [FILE]...
46 Version: $V
47
48 Options:
49   -q, --quiet                quiet
50   --no-tree                  run without a kernel tree
51   --no-signoff               do not check for 'Signed-off-by' line
52   --patch                    treat FILE as patchfile (default)
53   --emacs                    emacs compile window format
54   --terse                    one line per report
55   -f, --file                 treat FILE as regular source file
56   --subjective, --strict     enable more subjective tests
57   --ignore TYPE(,TYPE2...)   ignore various comma separated message types
58   --show-types               show the message "types" in the output
59   --root=PATH                PATH to the kernel tree root
60   --no-summary               suppress the per-file summary
61   --mailback                 only produce a report in case of warnings/errors
62   --summary-file             include the filename in summary
63   --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
64                              'values', 'possible', 'type', and 'attr' (default
65                              is all off)
66   --test-only=WORD           report only warnings/errors containing WORD
67                              literally
68   -h, --help, --version      display this help and exit
69
70 When FILE is - read standard input.
71 EOM
72
73         exit($exitcode);
74 }
75
76 my $conf = which_conf($configuration_file);
77 if (-f $conf) {
78         my @conf_args;
79         open(my $conffile, '<', "$conf")
80             or warn "$P: Can't find a readable $configuration_file file $!\n";
81
82         while (<$conffile>) {
83                 my $line = $_;
84
85                 $line =~ s/\s*\n?$//g;
86                 $line =~ s/^\s*//g;
87                 $line =~ s/\s+/ /g;
88
89                 next if ($line =~ m/^\s*#/);
90                 next if ($line =~ m/^\s*$/);
91
92                 my @words = split(" ", $line);
93                 foreach my $word (@words) {
94                         last if ($word =~ m/^#/);
95                         push (@conf_args, $word);
96                 }
97         }
98         close($conffile);
99         unshift(@ARGV, @conf_args) if @conf_args;
100 }
101
102 GetOptions(
103         'q|quiet+'      => \$quiet,
104         'tree!'         => \$tree,
105         'signoff!'      => \$chk_signoff,
106         'patch!'        => \$chk_patch,
107         'emacs!'        => \$emacs,
108         'terse!'        => \$terse,
109         'f|file!'       => \$file,
110         'subjective!'   => \$check,
111         'strict!'       => \$check,
112         'ignore=s'      => \@ignore,
113         'show-types!'   => \$show_types,
114         'root=s'        => \$root,
115         'summary!'      => \$summary,
116         'mailback!'     => \$mailback,
117         'summary-file!' => \$summary_file,
118
119         'debug=s'       => \%debug,
120         'test-only=s'   => \$tst_only,
121         'h|help'        => \$help,
122         'version'       => \$help
123 ) or help(1);
124
125 help(0) if ($help);
126
127 my $exit = 0;
128
129 if ($#ARGV < 0) {
130         print "$P: no input files\n";
131         exit(1);
132 }
133
134 @ignore = split(/,/, join(',',@ignore));
135 foreach my $word (@ignore) {
136         $word =~ s/\s*\n?$//g;
137         $word =~ s/^\s*//g;
138         $word =~ s/\s+/ /g;
139         $word =~ tr/[a-z]/[A-Z]/;
140
141         next if ($word =~ m/^\s*#/);
142         next if ($word =~ m/^\s*$/);
143
144         $ignore_type{$word}++;
145 }
146
147 my $dbg_values = 0;
148 my $dbg_possible = 0;
149 my $dbg_type = 0;
150 my $dbg_attr = 0;
151 for my $key (keys %debug) {
152         ## no critic
153         eval "\${dbg_$key} = '$debug{$key}';";
154         die "$@" if ($@);
155 }
156
157 my $rpt_cleaners = 0;
158
159 if ($terse) {
160         $emacs = 1;
161         $quiet++;
162 }
163
164 if ($tree) {
165         if (defined $root) {
166                 if (!top_of_kernel_tree($root)) {
167                         die "$P: $root: --root does not point at a valid tree\n";
168                 }
169         } else {
170                 if (top_of_kernel_tree('.')) {
171                         $root = '.';
172                 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
173                                                 top_of_kernel_tree($1)) {
174                         $root = $1;
175                 }
176         }
177
178         if (!defined $root) {
179                 print "Must be run from the top-level dir. of a kernel tree\n";
180                 exit(2);
181         }
182 }
183
184 my $emitted_corrupt = 0;
185
186 our $Ident      = qr{
187                         [A-Za-z_][A-Za-z\d_]*
188                         (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
189                 }x;
190 our $Storage    = qr{extern|static|asmlinkage};
191 our $Sparse     = qr{
192                         __user|
193                         __kernel|
194                         __force|
195                         __iomem|
196                         __must_check|
197                         __init_refok|
198                         __kprobes|
199                         __ref|
200                         __rcu
201                 }x;
202
203 # Notes to $Attribute:
204 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
205 our $Attribute  = qr{
206                         const|
207                         __percpu|
208                         __nocast|
209                         __safe|
210                         __bitwise__|
211                         __packed__|
212                         __packed2__|
213                         __naked|
214                         __maybe_unused|
215                         __always_unused|
216                         __noreturn|
217                         __used|
218                         __cold|
219                         __noclone|
220                         __deprecated|
221                         __read_mostly|
222                         __kprobes|
223                         __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
224                         ____cacheline_aligned|
225                         ____cacheline_aligned_in_smp|
226                         ____cacheline_internodealigned_in_smp|
227                         __weak
228                   }x;
229 our $Modifier;
230 our $Inline     = qr{inline|__always_inline|noinline};
231 our $Member     = qr{->$Ident|\.$Ident|\[[^]]*\]};
232 our $Lval       = qr{$Ident(?:$Member)*};
233
234 our $Constant   = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
235 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
236 our $Compare    = qr{<=|>=|==|!=|<|>};
237 our $Operators  = qr{
238                         <=|>=|==|!=|
239                         =>|->|<<|>>|<|>|!|~|
240                         &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
241                   }x;
242
243 our $NonptrType;
244 our $Type;
245 our $Declare;
246
247 our $NON_ASCII_UTF8     = qr{
248         [\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
249         |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
250         | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
251         |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
252         |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
253         | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
254         |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
255 }x;
256
257 our $UTF8       = qr{
258         [\x09\x0A\x0D\x20-\x7E]              # ASCII
259         | $NON_ASCII_UTF8
260 }x;
261
262 our $typeTypedefs = qr{(?x:
263         (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
264         atomic_t
265 )};
266
267 our $logFunctions = qr{(?x:
268         printk(?:_ratelimited|_once|)|
269         [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
270         WARN(?:_RATELIMIT|_ONCE|)|
271         panic|
272         MODULE_[A-Z_]+
273 )};
274
275 our $signature_tags = qr{(?xi:
276         Signed-off-by:|
277         Acked-by:|
278         Tested-by:|
279         Reviewed-by:|
280         Reported-by:|
281         To:|
282         Cc:
283 )};
284
285 our @typeList = (
286         qr{void},
287         qr{(?:unsigned\s+)?char},
288         qr{(?:unsigned\s+)?short},
289         qr{(?:unsigned\s+)?int},
290         qr{(?:unsigned\s+)?long},
291         qr{(?:unsigned\s+)?long\s+int},
292         qr{(?:unsigned\s+)?long\s+long},
293         qr{(?:unsigned\s+)?long\s+long\s+int},
294         qr{unsigned},
295         qr{float},
296         qr{double},
297         qr{bool},
298         qr{struct\s+$Ident},
299         qr{union\s+$Ident},
300         qr{enum\s+$Ident},
301         qr{${Ident}_t},
302         qr{${Ident}_handler},
303         qr{${Ident}_handler_fn},
304 );
305 our @modifierList = (
306         qr{fastcall},
307 );
308
309 our $allowed_asm_includes = qr{(?x:
310         irq|
311         memory
312 )};
313 # memory.h: ARM has a custom one
314
315 sub build_types {
316         my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
317         my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
318         $Modifier       = qr{(?:$Attribute|$Sparse|$mods)};
319         $NonptrType     = qr{
320                         (?:$Modifier\s+|const\s+)*
321                         (?:
322                                 (?:typeof|__typeof__)\s*\([^\)]*\)|
323                                 (?:$typeTypedefs\b)|
324                                 (?:${all}\b)
325                         )
326                         (?:\s+$Modifier|\s+const)*
327                   }x;
328         $Type   = qr{
329                         $NonptrType
330                         (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
331                         (?:\s+$Inline|\s+$Modifier)*
332                   }x;
333         $Declare        = qr{(?:$Storage\s+)?$Type};
334 }
335 build_types();
336
337 our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
338
339 our $Typecast   = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
340 our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
341 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
342
343 sub deparenthesize {
344         my ($string) = @_;
345         return "" if (!defined($string));
346         $string =~ s@^\s*\(\s*@@g;
347         $string =~ s@\s*\)\s*$@@g;
348         $string =~ s@\s+@ @g;
349         return $string;
350 }
351
352 $chk_signoff = 0 if ($file);
353
354 my %dep_includes = (
355         'asm/types.h',                  'linux/types.h',
356         'asm/uaccess.h',                'linux/uaccess.h',
357 );
358
359 my %dep_functions = (
360         'CFS_ATOMIC_INIT',              'ATOMIC_INIT',
361         'cfs_atomic_add',               'atomic_add',
362         'cfs_atomic_add_return',        'atomic_add_return',
363         'cfs_atomic_add_unless',        'atomic_add_unless',
364         'cfs_atomic_cmpxchg',           'atomic_cmpxchg',
365         'cfs_atomic_dec',               'atomic_dec',
366         'cfs_atomic_dec_and_lock',      'atomic_dec_and_lock',
367         'cfs_atomic_dec_and_test',      'atomic_dec_and_test',
368         'cfs_atomic_dec_return',        'atomic_dec_return',
369         'cfs_atomic_inc',               'atomic_inc',
370         'cfs_atomic_inc_and_test',      'atomic_inc_and_test',
371         'cfs_atomic_inc_not_zero',      'atomic_inc_not_zero',
372         'cfs_atomic_inc_return',        'atomic_inc_return',
373         'cfs_atomic_read',              'atomic_read',
374         'cfs_atomic_set',               'atomic_set',
375         'cfs_atomic_sub',               'atomic_sub',
376         'cfs_atomic_sub_and_test',      'atomic_sub_and_test',
377         'cfs_atomic_sub_return',        'atomic_sub_return',
378         'cfs_atomic_t',                 'atomic_t',
379
380         'CFS_HLIST_HEAD',               'HLIST_HEAD',
381         'CFS_HLIST_HEAD_INIT',          'HLIST_HEAD_INIT',
382         'CFS_INIT_HLIST_HEAD',          'INIT_HLIST_HEAD',
383         'CFS_INIT_HLIST_NODE',          'INIT_HLIST_NODE',
384         'cfs_hlist_add_after',          'hlist_add_after',
385         'cfs_hlist_add_before',         'hlist_add_before',
386         'cfs_hlist_add_head',           'hlist_add_head',
387         'cfs_hlist_del',                'hlist_del',
388         'cfs_hlist_del_init',           'hlist_del_init',
389         'cfs_hlist_empty',              'hlist_empty',
390         'cfs_hlist_entry',              'hlist_entry',
391         'cfs_hlist_for_each',           'hlist_for_each',
392         'cfs_hlist_for_each_safe',      'hlist_for_each_safe',
393         'cfs_hlist_head_t',             'struct hlist_head',
394         'cfs_hlist_node_t',             'struct hlist_node',
395         'cfs_hlist_unhashed',           'hlist_unhashed',
396
397         'cfs_inode_t',                  'struct inode',
398
399         'CFS_INIT_LIST_HEAD',           'INIT_LIST_HEAD',
400         'CFS_LIST_HEAD',                'struct list_head foo = LIST_HEAD_INIT(foo);',
401         'CFS_LIST_HEAD_INIT',           'LIST_HEAD_INIT',
402         'cfs_list_add',                 'list_add',
403         'cfs_list_add_tail',            'list_add_tail',
404         'cfs_list_del',                 'list_del',
405         'cfs_list_del_init',            'list_del_init',
406         'cfs_list_empty',               'list_empty',
407         'cfs_list_empty_careful',       'list_empty_careful',
408         'cfs_list_entry',               'list_entry',
409         'cfs_list_for_each',            'list_for_each',
410         'cfs_list_for_each_entry',      'list_for_each_entry',
411         'cfs_list_for_each_entry_continue',
412                                         'list_for_each_entry_continue',
413         'cfs_list_for_each_entry_reverse',
414                                         'list_for_each_entry_reverse',
415         'cfs_list_for_each_entry_safe',
416                                         'list_for_each_entry_safe',
417         'cfs_list_for_each_entry_safe_from',
418                                         'list_for_each_entry_safe_from',
419         'cfs_list_for_each_entry_safe_reverse',
420                                         'list_for_each_entry_safe_reverse',
421         'cfs_list_for_each_entry_safe_typed',
422                                         'list_for_each_entry_safe_typed',
423         'cfs_list_for_each_entry_typed',
424                                         'list_for_each_entry_typed',
425         'cfs_list_for_each_prev',       'list_for_each_prev',
426         'cfs_list_for_each_safe',       'list_for_each_safe',
427         'cfs_list_move',                'list_move',
428         'cfs_list_move_tail',           'list_move_tail',
429         'cfs_list_splice',              'list_splice',
430         'cfs_list_splice_init',         'list_splice_init',
431         'cfs_list_splice_tail',         'list_splice_tail',
432         'cfs_list_t',                   'struct list_head',
433
434         'CFS_PAGE_MASK',                'PAGE_CACHE_MASK or PAGE_MASK',
435         'CFS_PAGE_SIZE',                'PAGE_CACHE_SIZE or PAGE_SIZE',
436
437         'cfs_proc_dir_entry_t',         'struct proc_dir_entry',
438
439         'cfs_rcu_head_t',               'struct rcu_head',
440
441         'cfs_hash_lock_t',              'union cfs_hash_lock',
442         'cfs_hash_bucket_t',            'struct cfs_hash_bucket',
443         'cfs_hash_bd_t',                'struct cfs_hash_bd',
444         'cfs_hash_t',                   'struct cfs_hash',
445         'cfs_hash_lock_ops_t',          'struct cfs_hash_lock_ops',
446         'cfs_hash_hlist_ops_t',         'struct cfs_hash_hlist_ops',
447         'cfs_hash_ops_t',               'struct cfs_hash_ops',
448         'cfs_hash_head_t',              'struct cfs_hash_head',
449         'cfs_hash_head_dep_t',          'struct cfs_hash_head_dep',
450         'cfs_hash_dhead_t',             'struct cfs_hash_dhead',
451         'cfs_hash_dhead_dep_t',         'struct cfs_hash_dhead_dep',
452         'cfs_hash_lookup_intent_t',     'enum cfs_hash_lookup_intent',
453         'cfs_hash_cond_arg_t',          'struct cfs_hash_cond_arg',
454
455         'LPROCFS',                      'CONFIG_PROC_FS',
456         'alloca',                       'malloc',
457         'mktemp',                       'mkstemp',
458         'sprintf',                      'snprintf',
459         'strcpy',                       'strncpy',
460         'strcat',                       'strncat',
461         'tempnam',                      'mkstemp',
462         'OBD_FREE_LARGE',               'OBD_FREE',
463         'f_dentry',                     'f_path.dentry',
464 );
465
466 my @rawlines = ();
467 my @lines = ();
468 my $vname;
469 for my $filename (@ARGV) {
470         my $FILE;
471         if ($file) {
472                 open($FILE, '-|', "diff -u /dev/null $filename") ||
473                         die "$P: $filename: diff failed - $!\n";
474         } elsif ($filename eq '-') {
475                 open($FILE, '<&STDIN');
476         } else {
477                 open($FILE, '<', "$filename") ||
478                         die "$P: $filename: open failed - $!\n";
479         }
480         if ($filename eq '-') {
481                 $vname = 'Your patch';
482         } else {
483                 $vname = $filename;
484         }
485         while (<$FILE>) {
486                 chomp;
487                 push(@rawlines, $_);
488         }
489         close($FILE);
490         if (!process($filename)) {
491                 $exit = 1;
492         }
493         @rawlines = ();
494         @lines = ();
495 }
496
497 exit($exit);
498
499 sub top_of_kernel_tree {
500         my ($root) = @_;
501
502         my @tree_check = (
503                 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
504                 "README", "Documentation", "arch", "include", "drivers",
505                 "fs", "init", "ipc", "kernel", "lib", "scripts",
506         );
507
508         foreach my $check (@tree_check) {
509                 if (! -e $root . '/' . $check) {
510                         return 0;
511                 }
512         }
513         return 1;
514     }
515
516 sub parse_email {
517         my ($formatted_email) = @_;
518
519         my $name = "";
520         my $address = "";
521         my $comment = "";
522
523         if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
524                 $name = $1;
525                 $address = $2;
526                 $comment = $3 if defined $3;
527         } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
528                 $address = $1;
529                 $comment = $2 if defined $2;
530         } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
531                 $address = $1;
532                 $comment = $2 if defined $2;
533                 $formatted_email =~ s/$address.*$//;
534                 $name = $formatted_email;
535                 $name =~ s/^\s+|\s+$//g;
536                 $name =~ s/^\"|\"$//g;
537                 # If there's a name left after stripping spaces and
538                 # leading quotes, and the address doesn't have both
539                 # leading and trailing angle brackets, the address
540                 # is invalid. ie:
541                 #   "joe smith joe@smith.com" bad
542                 #   "joe smith <joe@smith.com" bad
543                 if ($name ne "" && $address !~ /^<[^>]+>$/) {
544                         $name = "";
545                         $address = "";
546                         $comment = "";
547                 }
548         }
549
550         $name =~ s/^\s+|\s+$//g;
551         $name =~ s/^\"|\"$//g;
552         $address =~ s/^\s+|\s+$//g;
553         $address =~ s/^\<|\>$//g;
554
555         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
556                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
557                 $name = "\"$name\"";
558         }
559
560         return ($name, $address, $comment);
561 }
562
563 sub format_email {
564         my ($name, $address) = @_;
565
566         my $formatted_email;
567
568         $name =~ s/^\s+|\s+$//g;
569         $name =~ s/^\"|\"$//g;
570         $address =~ s/^\s+|\s+$//g;
571
572         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
573                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
574                 $name = "\"$name\"";
575         }
576
577         if ("$name" eq "") {
578                 $formatted_email = "$address";
579         } else {
580                 $formatted_email = "$name <$address>";
581         }
582
583         return $formatted_email;
584 }
585
586 sub which_conf {
587         my ($conf) = @_;
588
589         foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
590                 if (-e "$path/$conf") {
591                         return "$path/$conf";
592                 }
593         }
594
595         return "";
596 }
597
598 sub expand_tabs {
599         my ($str) = @_;
600
601         my $res = '';
602         my $n = 0;
603         for my $c (split(//, $str)) {
604                 if ($c eq "\t") {
605                         $res .= ' ';
606                         $n++;
607                         for (; ($n % 8) != 0; $n++) {
608                                 $res .= ' ';
609                         }
610                         next;
611                 }
612                 $res .= $c;
613                 $n++;
614         }
615
616         return $res;
617 }
618 sub copy_spacing {
619         (my $res = shift) =~ tr/\t/ /c;
620         return $res;
621 }
622
623 sub line_stats {
624         my ($line) = @_;
625
626         # Drop the diff line leader and expand tabs
627         $line =~ s/^.//;
628         $line = expand_tabs($line);
629
630         # Pick the indent from the front of the line.
631         my ($white) = ($line =~ /^(\s*)/);
632
633         return (length($line), length($white));
634 }
635
636 my $sanitise_quote = '';
637
638 sub sanitise_line_reset {
639         my ($in_comment) = @_;
640
641         if ($in_comment) {
642                 $sanitise_quote = '*/';
643         } else {
644                 $sanitise_quote = '';
645         }
646 }
647 sub sanitise_line {
648         my ($line) = @_;
649
650         my $res = '';
651         my $l = '';
652
653         my $qlen = 0;
654         my $off = 0;
655         my $c;
656
657         # Always copy over the diff marker.
658         $res = substr($line, 0, 1);
659
660         for ($off = 1; $off < length($line); $off++) {
661                 $c = substr($line, $off, 1);
662
663                 # Comments we are wacking completly including the begin
664                 # and end, all to $;.
665                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
666                         $sanitise_quote = '*/';
667
668                         substr($res, $off, 2, "$;$;");
669                         $off++;
670                         next;
671                 }
672                 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
673                         $sanitise_quote = '';
674                         substr($res, $off, 2, "$;$;");
675                         $off++;
676                         next;
677                 }
678                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
679                         $sanitise_quote = '//';
680
681                         substr($res, $off, 2, $sanitise_quote);
682                         $off++;
683                         next;
684                 }
685
686                 # A \ in a string means ignore the next character.
687                 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
688                     $c eq "\\") {
689                         substr($res, $off, 2, 'XX');
690                         $off++;
691                         next;
692                 }
693                 # Regular quotes.
694                 if ($c eq "'" || $c eq '"') {
695                         if ($sanitise_quote eq '') {
696                                 $sanitise_quote = $c;
697
698                                 substr($res, $off, 1, $c);
699                                 next;
700                         } elsif ($sanitise_quote eq $c) {
701                                 $sanitise_quote = '';
702                         }
703                 }
704
705                 #print "c<$c> SQ<$sanitise_quote>\n";
706                 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
707                         substr($res, $off, 1, $;);
708                 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
709                         substr($res, $off, 1, $;);
710                 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
711                         substr($res, $off, 1, 'X');
712                 } else {
713                         substr($res, $off, 1, $c);
714                 }
715         }
716
717         if ($sanitise_quote eq '//') {
718                 $sanitise_quote = '';
719         }
720
721         # The pathname on a #include may be surrounded by '<' and '>'.
722         if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
723                 my $clean = 'X' x length($1);
724                 $res =~ s@\<.*\>@<$clean>@;
725
726         # The whole of a #error is a string.
727         } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
728                 my $clean = 'X' x length($1);
729                 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
730         }
731
732         return $res;
733 }
734
735 sub ctx_statement_block {
736         my ($linenr, $remain, $off) = @_;
737         my $line = $linenr - 1;
738         my $blk = '';
739         my $soff = $off;
740         my $coff = $off - 1;
741         my $coff_set = 0;
742
743         my $loff = 0;
744
745         my $type = '';
746         my $level = 0;
747         my @stack = ();
748         my $p;
749         my $c;
750         my $len = 0;
751
752         my $remainder;
753         while (1) {
754                 @stack = (['', 0]) if ($#stack == -1);
755
756                 #warn "CSB: blk<$blk> remain<$remain>\n";
757                 # If we are about to drop off the end, pull in more
758                 # context.
759                 if ($off >= $len) {
760                         for (; $remain > 0; $line++) {
761                                 last if (!defined $lines[$line]);
762                                 next if ($lines[$line] =~ /^-/);
763                                 $remain--;
764                                 $loff = $len;
765                                 $blk .= $lines[$line] . "\n";
766                                 $len = length($blk);
767                                 $line++;
768                                 last;
769                         }
770                         # Bail if there is no further context.
771                         #warn "CSB: blk<$blk> off<$off> len<$len>\n";
772                         if ($off >= $len) {
773                                 last;
774                         }
775                         if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
776                                 $level++;
777                                 $type = '#';
778                         }
779                 }
780                 $p = $c;
781                 $c = substr($blk, $off, 1);
782                 $remainder = substr($blk, $off);
783
784                 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
785
786                 # Handle nested #if/#else.
787                 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
788                         push(@stack, [ $type, $level ]);
789                 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
790                         ($type, $level) = @{$stack[$#stack - 1]};
791                 } elsif ($remainder =~ /^#\s*endif\b/) {
792                         ($type, $level) = @{pop(@stack)};
793                 }
794
795                 # Statement ends at the ';' or a close '}' at the
796                 # outermost level.
797                 if ($level == 0 && $c eq ';') {
798                         last;
799                 }
800
801                 # An else is really a conditional as long as its not else if
802                 if ($level == 0 && $coff_set == 0 &&
803                                 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
804                                 $remainder =~ /^(else)(?:\s|{)/ &&
805                                 $remainder !~ /^else\s+if\b/) {
806                         $coff = $off + length($1) - 1;
807                         $coff_set = 1;
808                         #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
809                         #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
810                 }
811
812                 if (($type eq '' || $type eq '(') && $c eq '(') {
813                         $level++;
814                         $type = '(';
815                 }
816                 if ($type eq '(' && $c eq ')') {
817                         $level--;
818                         $type = ($level != 0)? '(' : '';
819
820                         if ($level == 0 && $coff < $soff) {
821                                 $coff = $off;
822                                 $coff_set = 1;
823                                 #warn "CSB: mark coff<$coff>\n";
824                         }
825                 }
826                 if (($type eq '' || $type eq '{') && $c eq '{') {
827                         $level++;
828                         $type = '{';
829                 }
830                 if ($type eq '{' && $c eq '}') {
831                         $level--;
832                         $type = ($level != 0)? '{' : '';
833
834                         if ($level == 0) {
835                                 if (substr($blk, $off + 1, 1) eq ';') {
836                                         $off++;
837                                 }
838                                 last;
839                         }
840                 }
841                 # Preprocessor commands end at the newline unless escaped.
842                 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
843                         $level--;
844                         $type = '';
845                         $off++;
846                         last;
847                 }
848                 $off++;
849         }
850         # We are truly at the end, so shuffle to the next line.
851         if ($off == $len) {
852                 $loff = $len + 1;
853                 $line++;
854                 $remain--;
855         }
856
857         my $statement = substr($blk, $soff, $off - $soff + 1);
858         my $condition = substr($blk, $soff, $coff - $soff + 1);
859
860         #warn "STATEMENT<$statement>\n";
861         #warn "CONDITION<$condition>\n";
862
863         #print "coff<$coff> soff<$off> loff<$loff>\n";
864
865         return ($statement, $condition,
866                         $line, $remain + 1, $off - $loff + 1, $level);
867 }
868
869 sub statement_lines {
870         my ($stmt) = @_;
871
872         # Strip the diff line prefixes and rip blank lines at start and end.
873         $stmt =~ s/(^|\n)./$1/g;
874         $stmt =~ s/^\s*//;
875         $stmt =~ s/\s*$//;
876
877         my @stmt_lines = ($stmt =~ /\n/g);
878
879         return $#stmt_lines + 2;
880 }
881
882 sub statement_rawlines {
883         my ($stmt) = @_;
884
885         my @stmt_lines = ($stmt =~ /\n/g);
886
887         return $#stmt_lines + 2;
888 }
889
890 sub statement_block_size {
891         my ($stmt) = @_;
892
893         $stmt =~ s/(^|\n)./$1/g;
894         $stmt =~ s/^\s*{//;
895         $stmt =~ s/}\s*$//;
896         $stmt =~ s/^\s*//;
897         $stmt =~ s/\s*$//;
898
899         my @stmt_lines = ($stmt =~ /\n/g);
900         my @stmt_statements = ($stmt =~ /;/g);
901
902         my $stmt_lines = $#stmt_lines + 2;
903         my $stmt_statements = $#stmt_statements + 1;
904
905         if ($stmt_lines > $stmt_statements) {
906                 return $stmt_lines;
907         } else {
908                 return $stmt_statements;
909         }
910 }
911
912 sub ctx_statement_full {
913         my ($linenr, $remain, $off) = @_;
914         my ($statement, $condition, $level);
915
916         my (@chunks);
917
918         # Grab the first conditional/block pair.
919         ($statement, $condition, $linenr, $remain, $off, $level) =
920                                 ctx_statement_block($linenr, $remain, $off);
921         #print "F: c<$condition> s<$statement> remain<$remain>\n";
922         push(@chunks, [ $condition, $statement ]);
923         if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
924                 return ($level, $linenr, @chunks);
925         }
926
927         # Pull in the following conditional/block pairs and see if they
928         # could continue the statement.
929         for (;;) {
930                 ($statement, $condition, $linenr, $remain, $off, $level) =
931                                 ctx_statement_block($linenr, $remain, $off);
932                 #print "C: c<$condition> s<$statement> remain<$remain>\n";
933                 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
934                 #print "C: push\n";
935                 push(@chunks, [ $condition, $statement ]);
936         }
937
938         return ($level, $linenr, @chunks);
939 }
940
941 sub ctx_block_get {
942         my ($linenr, $remain, $outer, $open, $close, $off) = @_;
943         my $line;
944         my $start = $linenr - 1;
945         my $blk = '';
946         my @o;
947         my @c;
948         my @res = ();
949
950         my $level = 0;
951         my @stack = ($level);
952         for ($line = $start; $remain > 0; $line++) {
953                 next if ($rawlines[$line] =~ /^-/);
954                 $remain--;
955
956                 $blk .= $rawlines[$line];
957
958                 # Handle nested #if/#else.
959                 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
960                         push(@stack, $level);
961                 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
962                         $level = $stack[$#stack - 1];
963                 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
964                         $level = pop(@stack);
965                 }
966
967                 foreach my $c (split(//, $lines[$line])) {
968                         ##print "C<$c>L<$level><$open$close>O<$off>\n";
969                         if ($off > 0) {
970                                 $off--;
971                                 next;
972                         }
973
974                         if ($c eq $close && $level > 0) {
975                                 $level--;
976                                 last if ($level == 0);
977                         } elsif ($c eq $open) {
978                                 $level++;
979                         }
980                 }
981
982                 if (!$outer || $level <= 1) {
983                         push(@res, $rawlines[$line]);
984                 }
985
986                 last if ($level == 0);
987         }
988
989         return ($level, @res);
990 }
991 sub ctx_block_outer {
992         my ($linenr, $remain) = @_;
993
994         my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
995         return @r;
996 }
997 sub ctx_block {
998         my ($linenr, $remain) = @_;
999
1000         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1001         return @r;
1002 }
1003 sub ctx_statement {
1004         my ($linenr, $remain, $off) = @_;
1005
1006         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1007         return @r;
1008 }
1009 sub ctx_block_level {
1010         my ($linenr, $remain) = @_;
1011
1012         return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1013 }
1014 sub ctx_statement_level {
1015         my ($linenr, $remain, $off) = @_;
1016
1017         return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1018 }
1019
1020 sub ctx_locate_comment {
1021         my ($first_line, $end_line) = @_;
1022
1023         # Catch a comment on the end of the line itself.
1024         my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1025         return $current_comment if (defined $current_comment);
1026
1027         # Look through the context and try and figure out if there is a
1028         # comment.
1029         my $in_comment = 0;
1030         $current_comment = '';
1031         for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1032                 my $line = $rawlines[$linenr - 1];
1033                 #warn "           $line\n";
1034                 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1035                         $in_comment = 1;
1036                 }
1037                 if ($line =~ m@/\*@) {
1038                         $in_comment = 1;
1039                 }
1040                 if (!$in_comment && $current_comment ne '') {
1041                         $current_comment = '';
1042                 }
1043                 $current_comment .= $line . "\n" if ($in_comment);
1044                 if ($line =~ m@\*/@) {
1045                         $in_comment = 0;
1046                 }
1047         }
1048
1049         chomp($current_comment);
1050         return($current_comment);
1051 }
1052 sub ctx_has_comment {
1053         my ($first_line, $end_line) = @_;
1054         my $cmt = ctx_locate_comment($first_line, $end_line);
1055
1056         ##print "LINE: $rawlines[$end_line - 1 ]\n";
1057         ##print "CMMT: $cmt\n";
1058
1059         return ($cmt ne '');
1060 }
1061
1062 sub raw_line {
1063         my ($linenr, $cnt) = @_;
1064
1065         my $offset = $linenr - 1;
1066         $cnt++;
1067
1068         my $line;
1069         while ($cnt) {
1070                 $line = $rawlines[$offset++];
1071                 next if (defined($line) && $line =~ /^-/);
1072                 $cnt--;
1073         }
1074
1075         return $line;
1076 }
1077
1078 sub cat_vet {
1079         my ($vet) = @_;
1080         my ($res, $coded);
1081
1082         $res = '';
1083         while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1084                 $res .= $1;
1085                 if ($2 ne '') {
1086                         $coded = sprintf("^%c", unpack('C', $2) + 64);
1087                         $res .= $coded;
1088                 }
1089         }
1090         $res =~ s/$/\$/;
1091
1092         return $res;
1093 }
1094
1095 my $av_preprocessor = 0;
1096 my $av_pending;
1097 my @av_paren_type;
1098 my $av_pend_colon;
1099
1100 sub annotate_reset {
1101         $av_preprocessor = 0;
1102         $av_pending = '_';
1103         @av_paren_type = ('E');
1104         $av_pend_colon = 'O';
1105 }
1106
1107 sub annotate_values {
1108         my ($stream, $type) = @_;
1109
1110         my $res;
1111         my $var = '_' x length($stream);
1112         my $cur = $stream;
1113
1114         print "$stream\n" if ($dbg_values > 1);
1115
1116         while (length($cur)) {
1117                 @av_paren_type = ('E') if ($#av_paren_type < 0);
1118                 print " <" . join('', @av_paren_type) .
1119                                 "> <$type> <$av_pending>" if ($dbg_values > 1);
1120                 if ($cur =~ /^(\s+)/o) {
1121                         print "WS($1)\n" if ($dbg_values > 1);
1122                         if ($1 =~ /\n/ && $av_preprocessor) {
1123                                 $type = pop(@av_paren_type);
1124                                 $av_preprocessor = 0;
1125                         }
1126
1127                 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1128                         print "CAST($1)\n" if ($dbg_values > 1);
1129                         push(@av_paren_type, $type);
1130                         $type = 'c';
1131
1132                 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1133                         print "DECLARE($1)\n" if ($dbg_values > 1);
1134                         $type = 'T';
1135
1136                 } elsif ($cur =~ /^($Modifier)\s*/) {
1137                         print "MODIFIER($1)\n" if ($dbg_values > 1);
1138                         $type = 'T';
1139
1140                 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1141                         print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1142                         $av_preprocessor = 1;
1143                         push(@av_paren_type, $type);
1144                         if ($2 ne '') {
1145                                 $av_pending = 'N';
1146                         }
1147                         $type = 'E';
1148
1149                 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1150                         print "UNDEF($1)\n" if ($dbg_values > 1);
1151                         $av_preprocessor = 1;
1152                         push(@av_paren_type, $type);
1153
1154                 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1155                         print "PRE_START($1)\n" if ($dbg_values > 1);
1156                         $av_preprocessor = 1;
1157
1158                         push(@av_paren_type, $type);
1159                         push(@av_paren_type, $type);
1160                         $type = 'E';
1161
1162                 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1163                         print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1164                         $av_preprocessor = 1;
1165
1166                         push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1167
1168                         $type = 'E';
1169
1170                 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1171                         print "PRE_END($1)\n" if ($dbg_values > 1);
1172
1173                         $av_preprocessor = 1;
1174
1175                         # Assume all arms of the conditional end as this
1176                         # one does, and continue as if the #endif was not here.
1177                         pop(@av_paren_type);
1178                         push(@av_paren_type, $type);
1179                         $type = 'E';
1180
1181                 } elsif ($cur =~ /^(\\\n)/o) {
1182                         print "PRECONT($1)\n" if ($dbg_values > 1);
1183
1184                 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1185                         print "ATTR($1)\n" if ($dbg_values > 1);
1186                         $av_pending = $type;
1187                         $type = 'N';
1188
1189                 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1190                         print "SIZEOF($1)\n" if ($dbg_values > 1);
1191                         if (defined $2) {
1192                                 $av_pending = 'V';
1193                         }
1194                         $type = 'N';
1195
1196                 } elsif ($cur =~ /^(if|while|for)\b/o) {
1197                         print "COND($1)\n" if ($dbg_values > 1);
1198                         $av_pending = 'E';
1199                         $type = 'N';
1200
1201                 } elsif ($cur =~/^(case)/o) {
1202                         print "CASE($1)\n" if ($dbg_values > 1);
1203                         $av_pend_colon = 'C';
1204                         $type = 'N';
1205
1206                 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1207                         print "KEYWORD($1)\n" if ($dbg_values > 1);
1208                         $type = 'N';
1209
1210                 } elsif ($cur =~ /^(\()/o) {
1211                         print "PAREN('$1')\n" if ($dbg_values > 1);
1212                         push(@av_paren_type, $av_pending);
1213                         $av_pending = '_';
1214                         $type = 'N';
1215
1216                 } elsif ($cur =~ /^(\))/o) {
1217                         my $new_type = pop(@av_paren_type);
1218                         if ($new_type ne '_') {
1219                                 $type = $new_type;
1220                                 print "PAREN('$1') -> $type\n"
1221                                                         if ($dbg_values > 1);
1222                         } else {
1223                                 print "PAREN('$1')\n" if ($dbg_values > 1);
1224                         }
1225
1226                 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1227                         print "FUNC($1)\n" if ($dbg_values > 1);
1228                         $type = 'V';
1229                         $av_pending = 'V';
1230
1231                 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1232                         if (defined $2 && $type eq 'C' || $type eq 'T') {
1233                                 $av_pend_colon = 'B';
1234                         } elsif ($type eq 'E') {
1235                                 $av_pend_colon = 'L';
1236                         }
1237                         print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1238                         $type = 'V';
1239
1240                 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1241                         print "IDENT($1)\n" if ($dbg_values > 1);
1242                         $type = 'V';
1243
1244                 } elsif ($cur =~ /^($Assignment)/o) {
1245                         print "ASSIGN($1)\n" if ($dbg_values > 1);
1246                         $type = 'N';
1247
1248                 } elsif ($cur =~/^(;|{|})/) {
1249                         print "END($1)\n" if ($dbg_values > 1);
1250                         $type = 'E';
1251                         $av_pend_colon = 'O';
1252
1253                 } elsif ($cur =~/^(,)/) {
1254                         print "COMMA($1)\n" if ($dbg_values > 1);
1255                         $type = 'C';
1256
1257                 } elsif ($cur =~ /^(\?)/o) {
1258                         print "QUESTION($1)\n" if ($dbg_values > 1);
1259                         $type = 'N';
1260
1261                 } elsif ($cur =~ /^(:)/o) {
1262                         print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1263
1264                         substr($var, length($res), 1, $av_pend_colon);
1265                         if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1266                                 $type = 'E';
1267                         } else {
1268                                 $type = 'N';
1269                         }
1270                         $av_pend_colon = 'O';
1271
1272                 } elsif ($cur =~ /^(\[)/o) {
1273                         print "CLOSE($1)\n" if ($dbg_values > 1);
1274                         $type = 'N';
1275
1276                 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1277                         my $variant;
1278
1279                         print "OPV($1)\n" if ($dbg_values > 1);
1280                         if ($type eq 'V') {
1281                                 $variant = 'B';
1282                         } else {
1283                                 $variant = 'U';
1284                         }
1285
1286                         substr($var, length($res), 1, $variant);
1287                         $type = 'N';
1288
1289                 } elsif ($cur =~ /^($Operators)/o) {
1290                         print "OP($1)\n" if ($dbg_values > 1);
1291                         if ($1 ne '++' && $1 ne '--') {
1292                                 $type = 'N';
1293                         }
1294
1295                 } elsif ($cur =~ /(^.)/o) {
1296                         print "C($1)\n" if ($dbg_values > 1);
1297                 }
1298                 if (defined $1) {
1299                         $cur = substr($cur, length($1));
1300                         $res .= $type x length($1);
1301                 }
1302         }
1303
1304         return ($res, $var);
1305 }
1306
1307 sub possible {
1308         my ($possible, $line) = @_;
1309         my $notPermitted = qr{(?:
1310                 ^(?:
1311                         $Modifier|
1312                         $Storage|
1313                         $Type|
1314                         DEFINE_\S+
1315                 )$|
1316                 ^(?:
1317                         goto|
1318                         return|
1319                         case|
1320                         else|
1321                         asm|__asm__|
1322                         do|
1323                         \#|
1324                         \#\#|
1325                 )(?:\s|$)|
1326                 ^(?:typedef|struct|enum)\b
1327             )}x;
1328         warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1329         if ($possible !~ $notPermitted) {
1330                 # Check for modifiers.
1331                 $possible =~ s/\s*$Storage\s*//g;
1332                 $possible =~ s/\s*$Sparse\s*//g;
1333                 if ($possible =~ /^\s*$/) {
1334
1335                 } elsif ($possible =~ /\s/) {
1336                         $possible =~ s/\s*$Type\s*//g;
1337                         for my $modifier (split(' ', $possible)) {
1338                                 if ($modifier !~ $notPermitted) {
1339                                         warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1340                                         push(@modifierList, $modifier);
1341                                 }
1342                         }
1343
1344                 } else {
1345                         warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1346                         push(@typeList, $possible);
1347                 }
1348                 build_types();
1349         } else {
1350                 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1351         }
1352 }
1353
1354 my $prefix = '';
1355
1356 sub show_type {
1357        return !defined $ignore_type{$_[0]};
1358 }
1359
1360 sub report {
1361         if (!show_type($_[1]) ||
1362             (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1363                 return 0;
1364         }
1365         my $line;
1366         if ($show_types) {
1367                 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1368         } else {
1369                 $line = "$prefix$_[0]: $_[2]\n";
1370         }
1371         $line = (split('\n', $line))[0] . "\n" if ($terse);
1372
1373         push(our @report, $line);
1374
1375         return 1;
1376 }
1377 sub report_dump {
1378         our @report;
1379 }
1380
1381 sub ERROR {
1382         if (report("ERROR", $_[0], $_[1])) {
1383                 our $clean = 0;
1384                 our $cnt_error++;
1385         }
1386 }
1387 sub WARN {
1388         if (report("WARNING", $_[0], $_[1])) {
1389                 our $clean = 0;
1390                 our $cnt_warn++;
1391         }
1392 }
1393 sub CHK {
1394         if ($check && report("CHECK", $_[0], $_[1])) {
1395                 our $clean = 0;
1396                 our $cnt_chk++;
1397         }
1398 }
1399
1400 sub check_absolute_file {
1401         my ($absolute, $herecurr) = @_;
1402         my $file = $absolute;
1403
1404         ##print "absolute<$absolute>\n";
1405
1406         # See if any suffix of this path is a path within the tree.
1407         while ($file =~ s@^[^/]*/@@) {
1408                 if (-f "$root/$file") {
1409                         ##print "file<$file>\n";
1410                         last;
1411                 }
1412         }
1413         if (! -f _)  {
1414                 return 0;
1415         }
1416
1417         # It is, so see if the prefix is acceptable.
1418         my $prefix = $absolute;
1419         substr($prefix, -length($file)) = '';
1420
1421         ##print "prefix<$prefix>\n";
1422         if ($prefix ne ".../") {
1423                 WARN("USE_RELATIVE_PATH",
1424                      "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1425         }
1426 }
1427
1428 sub process {
1429         my $filename = shift;
1430
1431         my $linenr=0;
1432         my $prevline="";
1433         my $prevrawline="";
1434         my $stashline="";
1435         my $stashrawline="";
1436
1437         my $length;
1438         my $indent;
1439         my $previndent=0;
1440         my $stashindent=0;
1441
1442         our $clean = 1;
1443         my $signoff = 0;
1444         my $is_patch = 0;
1445
1446         my $in_header_lines = 1;
1447         my $in_commit_log = 0;          #Scanning lines before patch
1448
1449         our @report = ();
1450         our $cnt_lines = 0;
1451         our $cnt_error = 0;
1452         our $cnt_warn = 0;
1453         our $cnt_chk = 0;
1454
1455         # Trace the real file/line as we go.
1456         my $realfile = '';
1457         my $realline = 0;
1458         my $realcnt = 0;
1459         my $here = '';
1460         my $in_comment = 0;
1461         my $comment_edge = 0;
1462         my $first_line = 0;
1463         my $p1_prefix = '';
1464
1465         my $prev_values = 'E';
1466
1467         # suppression flags
1468         my %suppress_ifbraces;
1469         my %suppress_whiletrailers;
1470         my %suppress_export;
1471         my $suppress_statement = 0;
1472
1473         # Pre-scan the patch sanitizing the lines.
1474         # Pre-scan the patch looking for any __setup documentation.
1475         #
1476         my @setup_docs = ();
1477         my $setup_docs = 0;
1478
1479         sanitise_line_reset();
1480         my $line;
1481         foreach my $rawline (@rawlines) {
1482                 $linenr++;
1483                 $line = $rawline;
1484
1485                 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1486                         $setup_docs = 0;
1487                         if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1488                                 $setup_docs = 1;
1489                         }
1490                         #next;
1491                 }
1492                 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1493                         $realline=$1-1;
1494                         if (defined $2) {
1495                                 $realcnt=$3+1;
1496                         } else {
1497                                 $realcnt=1+1;
1498                         }
1499                         $in_comment = 0;
1500
1501                         # Guestimate if this is a continuing comment.  Run
1502                         # the context looking for a comment "edge".  If this
1503                         # edge is a close comment then we must be in a comment
1504                         # at context start.
1505                         my $edge;
1506                         my $cnt = $realcnt;
1507                         for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1508                                 next if (defined $rawlines[$ln - 1] &&
1509                                          $rawlines[$ln - 1] =~ /^-/);
1510                                 $cnt--;
1511                                 #print "RAW<$rawlines[$ln - 1]>\n";
1512                                 last if (!defined $rawlines[$ln - 1]);
1513                                 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1514                                     $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1515                                         ($edge) = $1;
1516                                         last;
1517                                 }
1518                         }
1519                         if (defined $edge && $edge eq '*/') {
1520                                 $in_comment = 1;
1521                         }
1522
1523                         # Guestimate if this is a continuing comment.  If this
1524                         # is the start of a diff block and this line starts
1525                         # ' *' then it is very likely a comment.
1526                         if (!defined $edge &&
1527                             $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1528                         {
1529                                 $in_comment = 1;
1530                         }
1531
1532                         ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1533                         sanitise_line_reset($in_comment);
1534
1535                 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1536                         # Standardise the strings and chars within the input to
1537                         # simplify matching -- only bother with positive lines.
1538                         $line = sanitise_line($rawline);
1539                 }
1540                 push(@lines, $line);
1541
1542                 if ($realcnt > 1) {
1543                         $realcnt-- if ($line =~ /^(?:\+| |$)/);
1544                 } else {
1545                         $realcnt = 0;
1546                 }
1547
1548                 #print "==>$rawline\n";
1549                 #print "-->$line\n";
1550
1551                 if ($setup_docs && $line =~ /^\+/) {
1552                         push(@setup_docs, $line);
1553                 }
1554         }
1555
1556         $prefix = '';
1557
1558         $realcnt = 0;
1559         $linenr = 0;
1560         foreach my $line (@lines) {
1561                 $linenr++;
1562
1563                 my $rawline = $rawlines[$linenr - 1];
1564
1565 #extract the line range in the file after the patch is applied
1566                 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1567                         $is_patch = 1;
1568                         $first_line = $linenr + 1;
1569                         $realline=$1-1;
1570                         if (defined $2) {
1571                                 $realcnt=$3+1;
1572                         } else {
1573                                 $realcnt=1+1;
1574                         }
1575                         annotate_reset();
1576                         $prev_values = 'E';
1577
1578                         %suppress_ifbraces = ();
1579                         %suppress_whiletrailers = ();
1580                         %suppress_export = ();
1581                         $suppress_statement = 0;
1582                         next;
1583
1584 # track the line number as we move through the hunk, note that
1585 # new versions of GNU diff omit the leading space on completely
1586 # blank context lines so we need to count that too.
1587                 } elsif ($line =~ /^( |\+|$)/) {
1588                         $realline++;
1589                         $realcnt-- if ($realcnt != 0);
1590
1591                         # Measure the line length and indent.
1592                         ($length, $indent) = line_stats($rawline);
1593
1594                         # Track the previous line.
1595                         ($prevline, $stashline) = ($stashline, $line);
1596                         ($previndent, $stashindent) = ($stashindent, $indent);
1597                         ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1598
1599                         #warn "line<$line>\n";
1600
1601                 } elsif ($realcnt == 1) {
1602                         $realcnt--;
1603                 }
1604
1605                 my $hunk_line = ($realcnt != 0);
1606
1607 #make up the handle for any error we report on this line
1608                 $prefix = "$filename:$realline: " if ($emacs && $file);
1609                 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1610
1611                 $here = "#$linenr: " if (!$file);
1612                 $here = "#$realline: " if ($file);
1613
1614                 # extract the filename as it passes
1615                 if ($line =~ /^diff --git.*?(\S+)$/) {
1616                         $realfile = $1;
1617                         $realfile =~ s@^([^/]*)/@@;
1618                         $in_commit_log = 0;
1619                 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1620                         $realfile = $1;
1621                         $realfile =~ s@^([^/]*)/@@;
1622                         $in_commit_log = 0;
1623
1624                         $p1_prefix = $1;
1625                         if (!$file && $tree && $p1_prefix ne '' &&
1626                             -e "$root/$p1_prefix") {
1627                                 WARN("PATCH_PREFIX",
1628                                      "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1629                         }
1630
1631                         if ($realfile =~ m@^include/asm/@) {
1632                                 ERROR("MODIFIED_INCLUDE_ASM",
1633                                       "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1634                         }
1635                         next;
1636                 }
1637
1638                 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1639
1640                 my $hereline = "$here\n$rawline\n";
1641                 my $herecurr = "$here\n$rawline\n";
1642                 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1643
1644                 $cnt_lines++ if ($realcnt != 0);
1645
1646 # Check for incorrect file permissions
1647                 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1648                         my $permhere = $here . "FILE: $realfile\n";
1649                         if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1650                                 ERROR("EXECUTE_PERMISSIONS",
1651                                       "do not set execute permissions for source files\n" . $permhere);
1652                         }
1653                 }
1654
1655 # Check the patch for a signoff:
1656                 if ($line =~ /^\s*signed-off-by:/i) {
1657                         $signoff++;
1658                         $in_commit_log = 0;
1659                 }
1660
1661 # Check signature styles
1662                 if (!$in_header_lines &&
1663                     $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1664                         my $space_before = $1;
1665                         my $sign_off = $2;
1666                         my $space_after = $3;
1667                         my $email = $4;
1668                         my $ucfirst_sign_off = ucfirst(lc($sign_off));
1669
1670                         if (defined $space_before && $space_before ne "") {
1671                                 WARN("BAD_SIGN_OFF",
1672                                      "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1673                         }
1674                         if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1675                                 WARN("BAD_SIGN_OFF",
1676                                      "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1677                         }
1678                         if (!defined $space_after || $space_after ne " ") {
1679                                 WARN("BAD_SIGN_OFF",
1680                                      "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1681                         }
1682
1683                         my ($email_name, $email_address, $comment) = parse_email($email);
1684                         my $suggested_email = format_email(($email_name, $email_address));
1685                         if ($suggested_email eq "") {
1686                                 ERROR("BAD_SIGN_OFF",
1687                                       "Unrecognized email address: '$email'\n" . $herecurr);
1688                         } else {
1689                                 my $dequoted = $suggested_email;
1690                                 $dequoted =~ s/^"//;
1691                                 $dequoted =~ s/" </ </;
1692                                 # Don't force email to have quotes
1693                                 # Allow just an angle bracketed address
1694                                 if ("$dequoted$comment" ne $email &&
1695                                     "<$email_address>$comment" ne $email &&
1696                                     "$suggested_email$comment" ne $email) {
1697                                         WARN("BAD_SIGN_OFF",
1698                                              "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1699                                 }
1700                         }
1701                 }
1702
1703 # Check for wrappage within a valid hunk of the file
1704                 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1705                         ERROR("CORRUPTED_PATCH",
1706                               "patch seems to be corrupt (line wrapped?)\n" .
1707                                 $herecurr) if (!$emitted_corrupt++);
1708                 }
1709
1710 # Check for absolute kernel paths.
1711                 if ($tree) {
1712                         while ($line =~ m{(?:^|\s)(/\S*)}g) {
1713                                 my $file = $1;
1714
1715                                 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1716                                     check_absolute_file($1, $herecurr)) {
1717                                         #
1718                                 } else {
1719                                         check_absolute_file($file, $herecurr);
1720                                 }
1721                         }
1722                 }
1723
1724 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1725                 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1726                     $rawline !~ m/^$UTF8*$/) {
1727                         my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1728
1729                         my $blank = copy_spacing($rawline);
1730                         my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1731                         my $hereptr = "$hereline$ptr\n";
1732
1733                         CHK("INVALID_UTF8",
1734                             "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1735                 }
1736
1737 # Check if it's the start of a commit log
1738 # (not a header line and we haven't seen the patch filename)
1739                 if ($in_header_lines && $realfile =~ /^$/ &&
1740                     $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1741                         $in_header_lines = 0;
1742                         $in_commit_log = 1;
1743                 }
1744
1745 # Still not yet in a patch, check for any UTF-8
1746                 if ($in_commit_log && $realfile =~ /^$/ &&
1747                     $rawline =~ /$NON_ASCII_UTF8/) {
1748                         CHK("UTF8_BEFORE_PATCH",
1749                             "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1750                 }
1751
1752 # ignore non-hunk lines and lines being removed
1753                 next if (!$hunk_line || $line =~ /^-/);
1754
1755 #trailing whitespace
1756                 if ($line =~ /^\+.*\015/) {
1757                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1758                         ERROR("DOS_LINE_ENDINGS",
1759                               "DOS line endings\n" . $herevet);
1760
1761                 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1762                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1763                         ERROR("TRAILING_WHITESPACE",
1764                               "trailing whitespace\n" . $herevet);
1765                         $rpt_cleaners = 1;
1766                 }
1767
1768 # check for Kconfig help text having a real description
1769 # Only applies when adding the entry originally, after that we do not have
1770 # sufficient context to determine whether it is indeed long enough.
1771                 if ($realfile =~ /Kconfig/ &&
1772                     $line =~ /.\s*config\s+/) {
1773                         my $length = 0;
1774                         my $cnt = $realcnt;
1775                         my $ln = $linenr + 1;
1776                         my $f;
1777                         my $is_start = 0;
1778                         my $is_end = 0;
1779                         for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1780                                 $f = $lines[$ln - 1];
1781                                 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1782                                 $is_end = $lines[$ln - 1] =~ /^\+/;
1783
1784                                 next if ($f =~ /^-/);
1785
1786                                 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1787                                         $is_start = 1;
1788                                 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1789                                         $length = -1;
1790                                 }
1791
1792                                 $f =~ s/^.//;
1793                                 $f =~ s/#.*//;
1794                                 $f =~ s/^\s+//;
1795                                 next if ($f =~ /^$/);
1796                                 if ($f =~ /^\s*config\s/) {
1797                                         $is_end = 1;
1798                                         last;
1799                                 }
1800                                 $length++;
1801                         }
1802                         WARN("CONFIG_DESCRIPTION",
1803                              "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1804                         #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1805                 }
1806
1807                 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1808                     ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1809                         my $flag = $1;
1810                         my $replacement = {
1811                                 'EXTRA_AFLAGS' =>   'asflags-y',
1812                                 'EXTRA_CFLAGS' =>   'ccflags-y',
1813                                 'EXTRA_CPPFLAGS' => 'cppflags-y',
1814                                 'EXTRA_LDFLAGS' =>  'ldflags-y',
1815                         };
1816
1817                         WARN("DEPRECATED_VARIABLE",
1818                              "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1819                 }
1820
1821 # check we are in a valid source file if not then ignore this hunk
1822                 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1823
1824 #80 column limit
1825                 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1826                     $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1827                     !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1828                     $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1829                     $length > 80)
1830                 {
1831                         WARN("LONG_LINE",
1832                              "line over 80 characters\n" . $herecurr);
1833                 }
1834
1835 # check for spaces before a quoted newline
1836                 if ($rawline =~ /^.*\".*\s\\n/) {
1837                         WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1838                              "unnecessary whitespace before a quoted newline\n" . $herecurr);
1839                 }
1840
1841 # check for adding lines without a newline.
1842                 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1843                         WARN("MISSING_EOF_NEWLINE",
1844                              "adding a line without newline at end of file\n" . $herecurr);
1845                 }
1846
1847 # Blackfin: use hi/lo macros
1848                 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1849                         if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1850                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1851                                 ERROR("LO_MACRO",
1852                                       "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1853                         }
1854                         if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1855                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1856                                 ERROR("HI_MACRO",
1857                                       "use the HI() macro, not (... >> 16)\n" . $herevet);
1858                         }
1859                 }
1860
1861 # check we are in a valid source file C, perl or bash script
1862 # if not then ignore this hunk
1863                 next if ($realfile !~ /\.(h|c|pl|sh)$/);
1864
1865 # at the beginning of a line any tabs must come first and anything
1866 # more than 8 must use tabs.
1867                 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1868                     $rawline =~ /^\+\s*        \s*/) {
1869                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1870                         ERROR("CODE_INDENT",
1871                               "code indent should use tabs where possible\n" . $herevet);
1872                         $rpt_cleaners = 1;
1873                 }
1874
1875 # check for space before tabs.
1876                 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1877                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1878                         WARN("SPACE_BEFORE_TAB",
1879                              "please, no space before tabs\n" . $herevet);
1880                 }
1881
1882 # check for spaces at the beginning of a line.
1883 # Exceptions:
1884 #  1) within comments
1885 #  2) indented preprocessor commands
1886 #  3) hanging labels
1887                 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1888                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1889                         WARN("LEADING_SPACE",
1890                              "please, no spaces at the start of a line\n" . $herevet);
1891                 }
1892
1893 # check we are in a valid C source file if not then ignore this hunk
1894                 next if ($realfile !~ /\.(h|c)$/);
1895
1896 # check for RCS/CVS revision markers
1897                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1898                         WARN("CVS_KEYWORD",
1899                              "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1900                 }
1901
1902 # Blackfin: don't use __builtin_bfin_[cs]sync
1903                 if ($line =~ /__builtin_bfin_csync/) {
1904                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1905                         ERROR("CSYNC",
1906                               "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1907                 }
1908                 if ($line =~ /__builtin_bfin_ssync/) {
1909                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1910                         ERROR("SSYNC",
1911                               "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1912                 }
1913
1914 # Check for potential 'bare' types
1915                 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1916                     $realline_next);
1917 #print "LINE<$line>\n";
1918                 if ($linenr >= $suppress_statement &&
1919                     $realcnt && $line =~ /.\s*\S/) {
1920                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1921                                 ctx_statement_block($linenr, $realcnt, 0);
1922                         $stat =~ s/\n./\n /g;
1923                         $cond =~ s/\n./\n /g;
1924
1925 #print "linenr<$linenr> <$stat>\n";
1926                         # If this statement has no statement boundaries within
1927                         # it there is no point in retrying a statement scan
1928                         # until we hit end of it.
1929                         my $frag = $stat; $frag =~ s/;+\s*$//;
1930                         if ($frag !~ /(?:{|;)/) {
1931 #print "skip<$line_nr_next>\n";
1932                                 $suppress_statement = $line_nr_next;
1933                         }
1934
1935                         # Find the real next line.
1936                         $realline_next = $line_nr_next;
1937                         if (defined $realline_next &&
1938                             (!defined $lines[$realline_next - 1] ||
1939                              substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1940                                 $realline_next++;
1941                         }
1942
1943                         my $s = $stat;
1944                         $s =~ s/{.*$//s;
1945
1946                         # Ignore goto labels.
1947                         if ($s =~ /$Ident:\*$/s) {
1948
1949                         # Ignore functions being called
1950                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1951
1952                         } elsif ($s =~ /^.\s*else\b/s) {
1953
1954                         # declarations always start with types
1955                         } 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) {
1956                                 my $type = $1;
1957                                 $type =~ s/\s+/ /g;
1958                                 possible($type, "A:" . $s);
1959
1960                         # definitions in global scope can only start with types
1961                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1962                                 possible($1, "B:" . $s);
1963                         }
1964
1965                         # any (foo ... *) is a pointer cast, and foo is a type
1966                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1967                                 possible($1, "C:" . $s);
1968                         }
1969
1970                         # Check for any sort of function declaration.
1971                         # int foo(something bar, other baz);
1972                         # void (*store_gdt)(x86_descr_ptr *);
1973                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1974                                 my ($name_len) = length($1);
1975
1976                                 my $ctx = $s;
1977                                 substr($ctx, 0, $name_len + 1, '');
1978                                 $ctx =~ s/\)[^\)]*$//;
1979
1980                                 for my $arg (split(/\s*,\s*/, $ctx)) {
1981                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1982
1983                                                 possible($1, "D:" . $s);
1984                                         }
1985                                 }
1986                         }
1987
1988                 }
1989
1990 #
1991 # Checks which may be anchored in the context.
1992 #
1993
1994 # Check for switch () and associated case and default
1995 # statements should be at the same indent.
1996                 if ($line=~/\bswitch\s*\(.*\)/) {
1997                         my $err = '';
1998                         my $sep = '';
1999                         my @ctx = ctx_block_outer($linenr, $realcnt);
2000                         shift(@ctx);
2001                         for my $ctx (@ctx) {
2002                                 my ($clen, $cindent) = line_stats($ctx);
2003                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2004                                                         $indent != $cindent) {
2005                                         $err .= "$sep$ctx\n";
2006                                         $sep = '';
2007                                 } else {
2008                                         $sep = "[...]\n";
2009                                 }
2010                         }
2011                         if ($err ne '') {
2012                                 ERROR("SWITCH_CASE_INDENT_LEVEL",
2013                                       "switch and case should be at the same indent\n$hereline$err");
2014                         }
2015                 }
2016
2017 # if/while/etc brace do not go on next line, unless defining a do while loop,
2018 # or if that brace on the next line is for something else
2019                 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2020                         my $pre_ctx = "$1$2";
2021
2022                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2023
2024                         if ($line =~ /^\+\t{6,}/) {
2025                                 WARN("DEEP_INDENTATION",
2026                                      "Too many leading tabs - consider code refactoring\n" . $herecurr);
2027                         }
2028
2029                         my $ctx_cnt = $realcnt - $#ctx - 1;
2030                         my $ctx = join("\n", @ctx);
2031
2032                         my $ctx_ln = $linenr;
2033                         my $ctx_skip = $realcnt;
2034
2035                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2036                                         defined $lines[$ctx_ln - 1] &&
2037                                         $lines[$ctx_ln - 1] =~ /^-/)) {
2038                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2039                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2040                                 $ctx_ln++;
2041                         }
2042
2043                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2044                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2045
2046                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2047                                 ERROR("OPEN_BRACE",
2048                                       "that open brace { should be on the previous line\n" .
2049                                         "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2050                         }
2051                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2052                             $ctx =~ /\)\s*\;\s*$/ &&
2053                             defined $lines[$ctx_ln - 1])
2054                         {
2055                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2056                                 if ($nindent > $indent) {
2057                                         WARN("TRAILING_SEMICOLON",
2058                                              "trailing semicolon indicates no statements, indent implies otherwise\n" .
2059                                                 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2060                                 }
2061                         }
2062                 }
2063
2064 # Check relative indent for conditionals and blocks.
2065                 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2066                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2067                                 ctx_statement_block($linenr, $realcnt, 0)
2068                                         if (!defined $stat);
2069                         my ($s, $c) = ($stat, $cond);
2070
2071                         substr($s, 0, length($c), '');
2072
2073                         # Make sure we remove the line prefixes as we have
2074                         # none on the first line, and are going to readd them
2075                         # where necessary.
2076                         $s =~ s/\n./\n/gs;
2077
2078                         # Find out how long the conditional actually is.
2079                         my @newlines = ($c =~ /\n/gs);
2080                         my $cond_lines = 1 + $#newlines;
2081
2082                         # We want to check the first line inside the block
2083                         # starting at the end of the conditional, so remove:
2084                         #  1) any blank line termination
2085                         #  2) any opening brace { on end of the line
2086                         #  3) any do (...) {
2087                         my $continuation = 0;
2088                         my $check = 0;
2089                         $s =~ s/^.*\bdo\b//;
2090                         $s =~ s/^\s*{//;
2091                         if ($s =~ s/^\s*\\//) {
2092                                 $continuation = 1;
2093                         }
2094                         if ($s =~ s/^\s*?\n//) {
2095                                 $check = 1;
2096                                 $cond_lines++;
2097                         }
2098
2099                         # Also ignore a loop construct at the end of a
2100                         # preprocessor statement.
2101                         if (($prevline =~ /^.\s*#\s*define\s/ ||
2102                             $prevline =~ /\\\s*$/) && $continuation == 0) {
2103                                 $check = 0;
2104                         }
2105
2106                         my $cond_ptr = -1;
2107                         $continuation = 0;
2108                         while ($cond_ptr != $cond_lines) {
2109                                 $cond_ptr = $cond_lines;
2110
2111                                 # If we see an #else/#elif then the code
2112                                 # is not linear.
2113                                 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2114                                         $check = 0;
2115                                 }
2116
2117                                 # Ignore:
2118                                 #  1) blank lines, they should be at 0,
2119                                 #  2) preprocessor lines, and
2120                                 #  3) labels.
2121                                 if ($continuation ||
2122                                     $s =~ /^\s*?\n/ ||
2123                                     $s =~ /^\s*#\s*?/ ||
2124                                     $s =~ /^\s*$Ident\s*:/) {
2125                                         $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2126                                         if ($s =~ s/^.*?\n//) {
2127                                                 $cond_lines++;
2128                                         }
2129                                 }
2130                         }
2131
2132                         my (undef, $sindent) = line_stats("+" . $s);
2133                         my $stat_real = raw_line($linenr, $cond_lines);
2134
2135                         # Check if either of these lines are modified, else
2136                         # this is not this patch's fault.
2137                         if (!defined($stat_real) ||
2138                             $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2139                                 $check = 0;
2140                         }
2141                         if (defined($stat_real) && $cond_lines > 1) {
2142                                 $stat_real = "[...]\n$stat_real";
2143                         }
2144
2145                         #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";
2146
2147                         if ($check && (($sindent % 8) != 0 ||
2148                             ($sindent <= $indent && $s ne ''))) {
2149                                 WARN("SUSPECT_CODE_INDENT",
2150                                      "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2151                         }
2152                 }
2153
2154                 # Track the 'values' across context and added lines.
2155                 my $opline = $line; $opline =~ s/^./ /;
2156                 my ($curr_values, $curr_vars) =
2157                                 annotate_values($opline . "\n", $prev_values);
2158                 $curr_values = $prev_values . $curr_values;
2159                 if ($dbg_values) {
2160                         my $outline = $opline; $outline =~ s/\t/ /g;
2161                         print "$linenr > .$outline\n";
2162                         print "$linenr > $curr_values\n";
2163                         print "$linenr >  $curr_vars\n";
2164                 }
2165                 $prev_values = substr($curr_values, -1);
2166
2167 #ignore lines not being added
2168                 if ($line=~/^[^\+]/) {next;}
2169
2170 # TEST: allow direct testing of the type matcher.
2171                 if ($dbg_type) {
2172                         if ($line =~ /^.\s*$Declare\s*$/) {
2173                                 ERROR("TEST_TYPE",
2174                                       "TEST: is type\n" . $herecurr);
2175                         } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2176                                 ERROR("TEST_NOT_TYPE",
2177                                       "TEST: is not type ($1 is)\n". $herecurr);
2178                         }
2179                         next;
2180                 }
2181 # TEST: allow direct testing of the attribute matcher.
2182                 if ($dbg_attr) {
2183                         if ($line =~ /^.\s*$Modifier\s*$/) {
2184                                 ERROR("TEST_ATTR",
2185                                       "TEST: is attr\n" . $herecurr);
2186                         } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2187                                 ERROR("TEST_NOT_ATTR",
2188                                       "TEST: is not attr ($1 is)\n". $herecurr);
2189                         }
2190                         next;
2191                 }
2192
2193 # check for initialisation to aggregates open brace on the next line
2194                 if ($line =~ /^.\s*{/ &&
2195                     $prevline =~ /(?:^|[^=])=\s*$/) {
2196                         ERROR("OPEN_BRACE",
2197                               "that open brace { should be on the previous line\n" . $hereprev);
2198                 }
2199
2200 #
2201 # Checks which are anchored on the added line.
2202 #
2203
2204 # check for malformed paths in #include statements (uses RAW line)
2205                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2206                         my $path = $1;
2207                         if ($path =~ m{//}) {
2208                                 ERROR("MALFORMED_INCLUDE",
2209                                       "malformed #include filename\n" .
2210                                         $herecurr);
2211                         }
2212                 }
2213
2214 # no C99 // comments
2215                 if ($line =~ m{//}) {
2216                         ERROR("C99_COMMENTS",
2217                               "do not use C99 // comments\n" . $herecurr);
2218                 }
2219                 # Remove C99 comments.
2220                 $line =~ s@//.*@@;
2221                 $opline =~ s@//.*@@;
2222
2223 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2224 # the whole statement.
2225 #print "APW <$lines[$realline_next - 1]>\n";
2226                 if (defined $realline_next &&
2227                     exists $lines[$realline_next - 1] &&
2228                     !defined $suppress_export{$realline_next} &&
2229                     ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2230                      $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2231                         # Handle definitions which produce identifiers with
2232                         # a prefix:
2233                         #   XXX(foo);
2234                         #   EXPORT_SYMBOL(something_foo);
2235                         my $name = $1;
2236                         if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2237                             $name =~ /^${Ident}_$2/) {
2238 #print "FOO C name<$name>\n";
2239                                 $suppress_export{$realline_next} = 1;
2240
2241                         } elsif ($stat !~ /(?:
2242                                 \n.}\s*$|
2243                                 ^.DEFINE_$Ident\(\Q$name\E\)|
2244                                 ^.DECLARE_$Ident\(\Q$name\E\)|
2245                                 ^.LIST_HEAD\(\Q$name\E\)|
2246                                 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2247                                 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2248                             )/x) {
2249 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2250                                 $suppress_export{$realline_next} = 2;
2251                         } else {
2252                                 $suppress_export{$realline_next} = 1;
2253                         }
2254                 }
2255                 if (!defined $suppress_export{$linenr} &&
2256                     $prevline =~ /^.\s*$/ &&
2257                     ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2258                      $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2259 #print "FOO B <$lines[$linenr - 1]>\n";
2260                         $suppress_export{$linenr} = 2;
2261                 }
2262                 if (defined $suppress_export{$linenr} &&
2263                     $suppress_export{$linenr} == 2) {
2264                         WARN("EXPORT_SYMBOL",
2265                              "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2266                 }
2267
2268 # check for global initialisers.
2269                 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2270                         ERROR("GLOBAL_INITIALISERS",
2271                               "do not initialise globals to 0 or NULL\n" .
2272                                 $herecurr);
2273                 }
2274 # check for static initialisers.
2275                 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2276                         ERROR("INITIALISED_STATIC",
2277                               "do not initialise statics to 0 or NULL\n" .
2278                                 $herecurr);
2279                 }
2280
2281 # check for static const char * arrays.
2282                 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2283                         WARN("STATIC_CONST_CHAR_ARRAY",
2284                              "static const char * array should probably be static const char * const\n" .
2285                                 $herecurr);
2286                }
2287
2288 # check for static char foo[] = "bar" declarations.
2289                 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2290                         WARN("STATIC_CONST_CHAR_ARRAY",
2291                              "static char array declaration should probably be static const char\n" .
2292                                 $herecurr);
2293                }
2294
2295 # check for declarations of struct pci_device_id
2296                 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2297                         WARN("DEFINE_PCI_DEVICE_TABLE",
2298                              "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2299                 }
2300
2301 # check for new typedefs, only function parameters and sparse annotations
2302 # make sense.
2303                 if ($line =~ /\btypedef\s/ &&
2304                     $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2305                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2306                     $line !~ /\b$typeTypedefs\b/ &&
2307                     $line !~ /\b__bitwise(?:__|)\b/) {
2308                         WARN("NEW_TYPEDEFS",
2309                              "do not add new typedefs\n" . $herecurr);
2310                 }
2311
2312 # * goes on variable not on type
2313                 # (char*[ const])
2314                 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2315                         #print "AA<$1>\n";
2316                         my ($from, $to) = ($2, $2);
2317
2318                         # Should start with a space.
2319                         $to =~ s/^(\S)/ $1/;
2320                         # Should not end with a space.
2321                         $to =~ s/\s+$//;
2322                         # '*'s should not have spaces between.
2323                         while ($to =~ s/\*\s+\*/\*\*/) {
2324                         }
2325
2326                         #print "from<$from> to<$to>\n";
2327                         if ($from ne $to) {
2328                                 ERROR("POINTER_LOCATION",
2329                                       "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2330                         }
2331                 }
2332                 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2333                         #print "BB<$1>\n";
2334                         my ($from, $to, $ident) = ($2, $2, $3);
2335
2336                         # Should start with a space.
2337                         $to =~ s/^(\S)/ $1/;
2338                         # Should not end with a space.
2339                         $to =~ s/\s+$//;
2340                         # '*'s should not have spaces between.
2341                         while ($to =~ s/\*\s+\*/\*\*/) {
2342                         }
2343                         # Modifiers should have spaces.
2344                         $to =~ s/(\b$Modifier$)/$1 /;
2345
2346                         #print "from<$from> to<$to> ident<$ident>\n";
2347                         if ($from ne $to && $ident !~ /^$Modifier$/) {
2348                                 ERROR("POINTER_LOCATION",
2349                                       "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2350                         }
2351                 }
2352
2353 # # no BUG() or BUG_ON()
2354 #               if ($line =~ /\b(BUG|BUG_ON)\b/) {
2355 #                       print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2356 #                       print "$herecurr";
2357 #                       $clean = 0;
2358 #               }
2359
2360                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2361                         WARN("LINUX_VERSION_CODE",
2362                              "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2363                 }
2364
2365 # check for uses of printk_ratelimit
2366                 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2367                         WARN("PRINTK_RATELIMITED",
2368 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2369                 }
2370
2371 # printk should use KERN_* levels.  Note that follow on printk's on the
2372 # same line do not need a level, so we use the current block context
2373 # to try and find and validate the current printk.  In summary the current
2374 # printk includes all preceding printk's which have no newline on the end.
2375 # we assume the first bad printk is the one to report.
2376                 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2377                         my $ok = 0;
2378                         for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2379                                 #print "CHECK<$lines[$ln - 1]\n";
2380                                 # we have a preceding printk if it ends
2381                                 # with "\n" ignore it, else it is to blame
2382                                 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2383                                         if ($rawlines[$ln - 1] !~ m{\\n"}) {
2384                                                 $ok = 1;
2385                                         }
2386                                         last;
2387                                 }
2388                         }
2389                         if ($ok == 0) {
2390                                 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2391                                      "printk() should include KERN_ facility level\n" . $herecurr);
2392                         }
2393                 }
2394
2395 # function brace can't be on same line, except for #defines of do while,
2396 # or if closed on same line
2397                 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2398                     !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2399                         ERROR("OPEN_BRACE",
2400                               "open brace '{' following function declarations go on the next line\n" . $herecurr);
2401                 }
2402
2403 # open braces for enum, union and struct go on the same line.
2404                 if ($line =~ /^.\s*{/ &&
2405                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2406                         ERROR("OPEN_BRACE",
2407                               "open brace '{' following $1 go on the same line\n" . $hereprev);
2408                 }
2409
2410 # missing space after union, struct or enum definition
2411                 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2412                     WARN("SPACING",
2413                          "missing space after $1 definition\n" . $herecurr);
2414                 }
2415
2416 # check for spacing round square brackets; allowed:
2417 #  1. with a type on the left -- int [] a;
2418 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2419 #  3. inside a curly brace -- = { [0...10] = 5 }
2420                 while ($line =~ /(.*?\s)\[/g) {
2421                         my ($where, $prefix) = ($-[1], $1);
2422                         if ($prefix !~ /$Type\s+$/ &&
2423                             ($where != 0 || $prefix !~ /^.\s+$/) &&
2424                             $prefix !~ /{\s+$/) {
2425                                 ERROR("BRACKET_SPACE",
2426                                       "space prohibited before open square bracket '['\n" . $herecurr);
2427                         }
2428                 }
2429
2430 # check for spaces between functions and their parentheses.
2431                 while ($line =~ /($Ident)\s+\(/g) {
2432                         my $name = $1;
2433                         my $ctx_before = substr($line, 0, $-[1]);
2434                         my $ctx = "$ctx_before$name";
2435
2436                         # Ignore those directives where spaces _are_ permitted.
2437                         if ($name =~ /^(?:
2438                                 if|for|while|switch|return|case|
2439                                 volatile|__volatile__|
2440                                 __attribute__|format|__extension__|
2441                                 asm|__asm__)$/x)
2442                         {
2443
2444                         # cpp #define statements have non-optional spaces, ie
2445                         # if there is a space between the name and the open
2446                         # parenthesis it is simply not a parameter group.
2447                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2448
2449                         # cpp #elif statement condition may start with a (
2450                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2451
2452                         # If this whole things ends with a type its most
2453                         # likely a typedef for a function.
2454                         } elsif ($ctx =~ /$Type$/) {
2455
2456                         } else {
2457                                 WARN("SPACING",
2458                                      "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2459                         }
2460                 }
2461 # Check operator spacing.
2462                 if (!($line=~/\#\s*include/)) {
2463                         my $ops = qr{
2464                                 <<=|>>=|<=|>=|==|!=|
2465                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2466                                 =>|->|<<|>>|<|>|=|!|~|
2467                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2468                                 \?|:
2469                         }x;
2470                         my @elements = split(/($ops|;)/, $opline);
2471                         my $off = 0;
2472
2473                         my $blank = copy_spacing($opline);
2474
2475                         for (my $n = 0; $n < $#elements; $n += 2) {
2476                                 $off += length($elements[$n]);
2477
2478                                 # Pick up the preceding and succeeding characters.
2479                                 my $ca = substr($opline, 0, $off);
2480                                 my $cc = '';
2481                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2482                                         $cc = substr($opline, $off + length($elements[$n + 1]));
2483                                 }
2484                                 my $cb = "$ca$;$cc";
2485
2486                                 my $a = '';
2487                                 $a = 'V' if ($elements[$n] ne '');
2488                                 $a = 'W' if ($elements[$n] =~ /\s$/);
2489                                 $a = 'C' if ($elements[$n] =~ /$;$/);
2490                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2491                                 $a = 'O' if ($elements[$n] eq '');
2492                                 $a = 'E' if ($ca =~ /^\s*$/);
2493
2494                                 my $op = $elements[$n + 1];
2495
2496                                 my $c = '';
2497                                 if (defined $elements[$n + 2]) {
2498                                         $c = 'V' if ($elements[$n + 2] ne '');
2499                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2500                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2501                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2502                                         $c = 'O' if ($elements[$n + 2] eq '');
2503                                         $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2504                                 } else {
2505                                         $c = 'E';
2506                                 }
2507
2508                                 my $ctx = "${a}x${c}";
2509
2510                                 my $at = "(ctx:$ctx)";
2511
2512                                 my $ptr = substr($blank, 0, $off) . "^";
2513                                 my $hereptr = "$hereline$ptr\n";
2514
2515                                 # Pull out the value of this operator.
2516                                 my $op_type = substr($curr_values, $off + 1, 1);
2517
2518                                 # Get the full operator variant.
2519                                 my $opv = $op . substr($curr_vars, $off, 1);
2520
2521                                 # Ignore operators passed as parameters.
2522                                 if ($op_type ne 'V' &&
2523                                     $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2524
2525 #                               # Ignore comments
2526 #                               } elsif ($op =~ /^$;+$/) {
2527
2528                                 # ; should have either the end of line or a space or \ after it
2529                                 } elsif ($op eq ';') {
2530                                         if ($ctx !~ /.x[WEBC]/ &&
2531                                             $cc !~ /^\\/ && $cc !~ /^;/) {
2532                                                 ERROR("SPACING",
2533                                                       "space required after that '$op' $at\n" . $hereptr);
2534                                         }
2535
2536                                 # // is a comment
2537                                 } elsif ($op eq '//') {
2538
2539                                 # No spaces for:
2540                                 #   ->
2541                                 #   :   when part of a bitfield
2542                                 } elsif ($op eq '->' || $opv eq ':B') {
2543                                         if ($ctx =~ /Wx.|.xW/) {
2544                                                 ERROR("SPACING",
2545                                                       "spaces prohibited around that '$op' $at\n" . $hereptr);
2546                                         }
2547
2548                                 # , must have a space on the right.
2549                                 } elsif ($op eq ',') {
2550                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2551                                                 ERROR("SPACING",
2552                                                       "space required after that '$op' $at\n" . $hereptr);
2553                                         }
2554
2555                                 # '*' as part of a type definition -- reported already.
2556                                 } elsif ($opv eq '*_') {
2557                                         #warn "'*' is part of type\n";
2558
2559                                 # unary operators should have a space before and
2560                                 # none after.  May be left adjacent to another
2561                                 # unary operator, or a cast
2562                                 } elsif ($op eq '!' || $op eq '~' ||
2563                                          $opv eq '*U' || $opv eq '-U' ||
2564                                          $opv eq '&U' || $opv eq '&&U') {
2565                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2566                                                 ERROR("SPACING",
2567                                                       "space required before that '$op' $at\n" . $hereptr);
2568                                         }
2569                                         if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2570                                                 # A unary '*' may be const
2571
2572                                         } elsif ($ctx =~ /.xW/) {
2573                                                 ERROR("SPACING",
2574                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2575                                         }
2576
2577                                 # unary ++ and unary -- are allowed no space on one side.
2578                                 } elsif ($op eq '++' or $op eq '--') {
2579                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2580                                                 ERROR("SPACING",
2581                                                       "space required one side of that '$op' $at\n" . $hereptr);
2582                                         }
2583                                         if ($ctx =~ /Wx[BE]/ ||
2584                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2585                                                 ERROR("SPACING",
2586                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2587                                         }
2588                                         if ($ctx =~ /ExW/) {
2589                                                 ERROR("SPACING",
2590                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2591                                         }
2592
2593
2594                                 # << and >> may either have or not have spaces both sides
2595                                 } elsif ($op eq '<<' or $op eq '>>' or
2596                                          $op eq '&' or $op eq '^' or $op eq '|' or
2597                                          $op eq '+' or $op eq '-' or
2598                                          $op eq '*' or $op eq '/' or
2599                                          $op eq '%')
2600                                 {
2601                                         if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2602                                                 ERROR("SPACING",
2603                                                       "need consistent spacing around '$op' $at\n" .
2604                                                         $hereptr);
2605                                         }
2606
2607                                 # A colon needs no spaces before when it is
2608                                 # terminating a case value or a label.
2609                                 } elsif ($opv eq ':C' || $opv eq ':L') {
2610                                         if ($ctx =~ /Wx./) {
2611                                                 ERROR("SPACING",
2612                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2613                                         }
2614
2615                                 # All the others need spaces both sides.
2616                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2617                                         my $ok = 0;
2618
2619                                         # Ignore email addresses <foo@bar>
2620                                         if (($op eq '<' &&
2621                                              $cc =~ /^\S+\@\S+>/) ||
2622                                             ($op eq '>' &&
2623                                              $ca =~ /<\S+\@\S+$/))
2624                                         {
2625                                                 $ok = 1;
2626                                         }
2627
2628                                         # Ignore ?:
2629                                         if (($opv eq ':O' && $ca =~ /\?$/) ||
2630                                             ($op eq '?' && $cc =~ /^:/)) {
2631                                                 $ok = 1;
2632                                         }
2633
2634                                         if ($ok == 0) {
2635                                                 ERROR("SPACING",
2636                                                       "spaces required around that '$op' $at\n" . $hereptr);
2637                                         }
2638                                 }
2639                                 $off += length($elements[$n + 1]);
2640                         }
2641                 }
2642
2643 # check for multiple assignments
2644                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2645                         CHK("MULTIPLE_ASSIGNMENTS",
2646                             "multiple assignments should be avoided\n" . $herecurr);
2647                 }
2648
2649 ## # check for multiple declarations, allowing for a function declaration
2650 ## # continuation.
2651 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2652 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2653 ##
2654 ##                      # Remove any bracketed sections to ensure we do not
2655 ##                      # falsly report the parameters of functions.
2656 ##                      my $ln = $line;
2657 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
2658 ##                      }
2659 ##                      if ($ln =~ /,/) {
2660 ##                              WARN("MULTIPLE_DECLARATION",
2661 ##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
2662 ##                      }
2663 ##              }
2664
2665 #need space before brace following if, while, etc
2666                 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2667                     $line =~ /do{/) {
2668                         ERROR("SPACING",
2669                               "space required before the open brace '{'\n" . $herecurr);
2670                 }
2671
2672 # closing brace should have a space following it when it has anything
2673 # on the line
2674                 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2675                         ERROR("SPACING",
2676                               "space required after that close brace '}'\n" . $herecurr);
2677                 }
2678
2679 # check spacing on square brackets
2680                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2681                         ERROR("SPACING",
2682                               "space prohibited after that open square bracket '['\n" . $herecurr);
2683                 }
2684                 if ($line =~ /\s\]/) {
2685                         ERROR("SPACING",
2686                               "space prohibited before that close square bracket ']'\n" . $herecurr);
2687                 }
2688
2689 # check spacing on parentheses
2690                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2691                     $line !~ /for\s*\(\s+;/) {
2692                         ERROR("SPACING",
2693                               "space prohibited after that open parenthesis '('\n" . $herecurr);
2694                 }
2695                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2696                     $line !~ /for\s*\(.*;\s+\)/ &&
2697                     $line !~ /:\s+\)/) {
2698                         ERROR("SPACING",
2699                               "space prohibited before that close parenthesis ')'\n" . $herecurr);
2700                 }
2701
2702 #goto labels aren't indented, allow a single space however
2703                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2704                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2705                         WARN("INDENTED_LABEL",
2706                              "labels should not be indented\n" . $herecurr);
2707                 }
2708
2709 # Return is not a function.
2710                 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2711                         my $spacing = $1;
2712                         my $value = $2;
2713
2714                         # Flatten any parentheses
2715                         $value =~ s/\(/ \(/g;
2716                         $value =~ s/\)/\) /g;
2717                         while ($value =~ s/\[[^\[\]]*\]/1/ ||
2718                                $value !~ /(?:$Ident|-?$Constant)\s*
2719                                              $Compare\s*
2720                                              (?:$Ident|-?$Constant)/x &&
2721                                $value =~ s/\([^\(\)]*\)/1/) {
2722                         }
2723 #print "value<$value>\n";
2724                         if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2725                                 ERROR("RETURN_PARENTHESES",
2726                                       "return is not a function, parentheses are not required\n" . $herecurr);
2727
2728                         } elsif ($spacing !~ /\s+/) {
2729                                 ERROR("SPACING",
2730                                       "space required before the open parenthesis '('\n" . $herecurr);
2731                         }
2732                 }
2733 # Return of what appears to be an errno should normally be -'ve
2734                 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2735                         my $name = $1;
2736                         if ($name ne 'EOF' && $name ne 'ERROR') {
2737                                 WARN("USE_NEGATIVE_ERRNO",
2738                                      "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2739                         }
2740                 }
2741
2742 # Need a space before open parenthesis after if, while etc
2743                 if ($line=~/\b(if|while|for|switch)\(/) {
2744                         ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2745                 }
2746
2747 # Check for illegal assignment in if conditional -- and check for trailing
2748 # statements after the conditional.
2749                 if ($line =~ /do\s*(?!{)/) {
2750                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2751                                 ctx_statement_block($linenr, $realcnt, 0)
2752                                         if (!defined $stat);
2753                         my ($stat_next) = ctx_statement_block($line_nr_next,
2754                                                 $remain_next, $off_next);
2755                         $stat_next =~ s/\n./\n /g;
2756                         ##print "stat<$stat> stat_next<$stat_next>\n";
2757
2758                         if ($stat_next =~ /^\s*while\b/) {
2759                                 # If the statement carries leading newlines,
2760                                 # then count those as offsets.
2761                                 my ($whitespace) =
2762                                         ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2763                                 my $offset =
2764                                         statement_rawlines($whitespace) - 1;
2765
2766                                 $suppress_whiletrailers{$line_nr_next +
2767                                                                 $offset} = 1;
2768                         }
2769                 }
2770                 if (!defined $suppress_whiletrailers{$linenr} &&
2771                     $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2772                         my ($s, $c) = ($stat, $cond);
2773
2774                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2775                                 ERROR("ASSIGN_IN_IF",
2776                                       "do not use assignment in if condition\n" . $herecurr);
2777                         }
2778
2779                         # Find out what is on the end of the line after the
2780                         # conditional.
2781                         substr($s, 0, length($c), '');
2782                         $s =~ s/\n.*//g;
2783                         $s =~ s/$;//g;  # Remove any comments
2784                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2785                             $c !~ /}\s*while\s*/)
2786                         {
2787                                 # Find out how long the conditional actually is.
2788                                 my @newlines = ($c =~ /\n/gs);
2789                                 my $cond_lines = 1 + $#newlines;
2790                                 my $stat_real = '';
2791
2792                                 $stat_real = raw_line($linenr, $cond_lines)
2793                                                         . "\n" if ($cond_lines);
2794                                 if (defined($stat_real) && $cond_lines > 1) {
2795                                         $stat_real = "[...]\n$stat_real";
2796                                 }
2797
2798                                 ERROR("TRAILING_STATEMENTS",
2799                                       "trailing statements should be on next line\n" . $herecurr . $stat_real);
2800                         }
2801                 }
2802
2803 # Check for bitwise tests written as boolean
2804                 if ($line =~ /
2805                         (?:
2806                                 (?:\[|\(|\&\&|\|\|)
2807                                 \s*0[xX][0-9]+\s*
2808                                 (?:\&\&|\|\|)
2809                         |
2810                                 (?:\&\&|\|\|)
2811                                 \s*0[xX][0-9]+\s*
2812                                 (?:\&\&|\|\||\)|\])
2813                         )/x)
2814                 {
2815                         WARN("HEXADECIMAL_BOOLEAN_TEST",
2816                              "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2817                 }
2818
2819 # if and else should not have general statements after it
2820                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2821                         my $s = $1;
2822                         $s =~ s/$;//g;  # Remove any comments
2823                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2824                                 ERROR("TRAILING_STATEMENTS",
2825                                       "trailing statements should be on next line\n" . $herecurr);
2826                         }
2827                 }
2828 # if should not continue a brace
2829                 if ($line =~ /}\s*if\b/) {
2830                         ERROR("TRAILING_STATEMENTS",
2831                               "trailing statements should be on next line\n" .
2832                                 $herecurr);
2833                 }
2834 # case and default should not have general statements after them
2835                 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2836                     $line !~ /\G(?:
2837                         (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2838                         \s*return\s+
2839                     )/xg)
2840                 {
2841                         ERROR("TRAILING_STATEMENTS",
2842                               "trailing statements should be on next line\n" . $herecurr);
2843                 }
2844
2845                 # Check for }<nl>else {, these must be at the same
2846                 # indent level to be relevant to each other.
2847                 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2848                                                 $previndent == $indent) {
2849                         ERROR("ELSE_AFTER_BRACE",
2850                               "else should follow close brace '}'\n" . $hereprev);
2851                 }
2852
2853                 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2854                                                 $previndent == $indent) {
2855                         my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2856
2857                         # Find out what is on the end of the line after the
2858                         # conditional.
2859                         substr($s, 0, length($c), '');
2860                         $s =~ s/\n.*//g;
2861
2862                         if ($s =~ /^\s*;/) {
2863                                 ERROR("WHILE_AFTER_BRACE",
2864                                       "while should follow close brace '}'\n" . $hereprev);
2865                         }
2866                 }
2867
2868 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2869 #               if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2870 #                   print "No studly caps, use _\n";
2871 #                   print "$herecurr";
2872 #                   $clean = 0;
2873 #               }
2874
2875 #no spaces allowed after \ in define
2876                 if ($line=~/\#\s*define.*\\\s$/) {
2877                         WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2878                              "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2879                 }
2880
2881 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2882                 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2883                         my $file = "$1.h";
2884                         my $checkfile = "include/linux/$file";
2885                         if (-f "$root/$checkfile" &&
2886                             $realfile ne $checkfile &&
2887                             $1 !~ /$allowed_asm_includes/)
2888                         {
2889                                 if ($realfile =~ m{^arch/}) {
2890                                         CHK("ARCH_INCLUDE_LINUX",
2891                                             "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2892                                 } else {
2893                                         WARN("INCLUDE_LINUX",
2894                                              "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2895                                 }
2896                         }
2897                 }
2898
2899 # multi-statement macros should be enclosed in a do while loop, grab the
2900 # first statement and ensure its the whole macro if its not enclosed
2901 # in a known good container
2902                 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2903                     $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2904                         my $ln = $linenr;
2905                         my $cnt = $realcnt;
2906                         my ($off, $dstat, $dcond, $rest);
2907                         my $ctx = '';
2908                         ($dstat, $dcond, $ln, $cnt, $off) =
2909                                 ctx_statement_block($linenr, $realcnt, 0);
2910                         $ctx = $dstat;
2911                         #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2912                         #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2913
2914                         $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2915                         $dstat =~ s/$;//g;
2916                         $dstat =~ s/\\\n.//g;
2917                         $dstat =~ s/^\s*//s;
2918                         $dstat =~ s/\s*$//s;
2919
2920                         # Flatten any parentheses and braces
2921                         while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2922                                $dstat =~ s/\{[^\{\}]*\}/1/ ||
2923                                $dstat =~ s/\[[^\[\]]*\]/1/)
2924                         {
2925                         }
2926
2927                         my $exceptions = qr{
2928                                 $Declare|
2929                                 module_param_named|
2930                                 MODULE_PARAM_DESC|
2931                                 DECLARE_PER_CPU|
2932                                 DEFINE_PER_CPU|
2933                                 __typeof__\(|
2934                                 union|
2935                                 struct|
2936                                 \.$Ident\s*=\s*|
2937                                 ^\"|\"$
2938                         }x;
2939                         #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2940                         if ($dstat ne '' &&
2941                             $dstat !~ /^(?:$Ident|-?$Constant),$/ &&                    # 10, // foo(),
2942                             $dstat !~ /^(?:$Ident|-?$Constant);$/ &&                    # foo();
2943                             $dstat !~ /^(?:$Ident|-?$Constant)$/ &&                     # 10 // foo()
2944                             $dstat !~ /$exceptions/ &&
2945                             $dstat !~ /^\.$Ident\s*=/ &&                                # .foo =
2946                             $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&       # do {...} while (...); // do {...} while (...)
2947                             $dstat !~ /^for\s*$Constant$/ &&                            # for (...)
2948                             $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&   # for (...) bar()
2949                             $dstat !~ /^do\s*{/ &&                                      # do {...
2950                             $dstat !~ /^\({/)                                           # ({...
2951                         {
2952                                 $ctx =~ s/\n*$//;
2953                                 my $herectx = $here . "\n";
2954                                 my $cnt = statement_rawlines($ctx);
2955
2956                                 for (my $n = 0; $n < $cnt; $n++) {
2957                                         $herectx .= raw_line($linenr, $n) . "\n";
2958                                 }
2959
2960                                 if ($dstat =~ /;/) {
2961                                         ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2962                                               "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
2963                                 } else {
2964                                         ERROR("COMPLEX_MACRO",
2965                                               "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
2966                                 }
2967                         }
2968                 }
2969
2970 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2971 # all assignments may have only one of the following with an assignment:
2972 #       .
2973 #       ALIGN(...)
2974 #       VMLINUX_SYMBOL(...)
2975                 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2976                         WARN("MISSING_VMLINUX_SYMBOL",
2977                              "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2978                 }
2979
2980 # check for redundant bracing round if etc
2981                 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2982                         my ($level, $endln, @chunks) =
2983                                 ctx_statement_full($linenr, $realcnt, 1);
2984                         #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2985                         #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2986                         if ($#chunks > 0 && $level == 0) {
2987                                 my $allowed = 0;
2988                                 my $seen = 0;
2989                                 my $herectx = $here . "\n";
2990                                 my $ln = $linenr - 1;
2991                                 for my $chunk (@chunks) {
2992                                         my ($cond, $block) = @{$chunk};
2993
2994                                         # If the condition carries leading newlines, then count those as offsets.
2995                                         my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2996                                         my $offset = statement_rawlines($whitespace) - 1;
2997
2998                                         #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2999
3000                                         # We have looked at and allowed this specific line.
3001                                         $suppress_ifbraces{$ln + $offset} = 1;
3002
3003                                         $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3004                                         $ln += statement_rawlines($block) - 1;
3005
3006                                         substr($block, 0, length($cond), '');
3007
3008                                         $seen++ if ($block =~ /^\s*{/);
3009
3010                                         #print "cond<$cond> block<$block> allowed<$allowed>\n";
3011                                         if (statement_lines($cond) > 1) {
3012                                                 #print "APW: ALLOWED: cond<$cond>\n";
3013                                                 $allowed = 1;
3014                                         }
3015                                         if ($block =~/\b(?:if|for|while)\b/) {
3016                                                 #print "APW: ALLOWED: block<$block>\n";
3017                                                 $allowed = 1;
3018                                         }
3019                                         if (statement_block_size($block) > 1) {
3020                                                 #print "APW: ALLOWED: lines block<$block>\n";
3021                                                 $allowed = 1;
3022                                         }
3023                                 }
3024                                 if ($seen && !$allowed) {
3025                                         WARN("BRACES",
3026                                              "braces {} are not necessary for any arm of this statement\n" . $herectx);
3027                                 }
3028                         }
3029                 }
3030                 if (!defined $suppress_ifbraces{$linenr - 1} &&
3031                                         $line =~ /\b(if|while|for|else)\b/) {
3032                         my $allowed = 0;
3033
3034                         # Check the pre-context.
3035                         if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3036                                 #print "APW: ALLOWED: pre<$1>\n";
3037                                 $allowed = 1;
3038                         }
3039
3040                         my ($level, $endln, @chunks) =
3041                                 ctx_statement_full($linenr, $realcnt, $-[0]);
3042
3043                         # Check the condition.
3044                         my ($cond, $block) = @{$chunks[0]};
3045                         #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3046                         if (defined $cond) {
3047                                 substr($block, 0, length($cond), '');
3048                         }
3049                         if (statement_lines($cond) > 1) {
3050                                 #print "APW: ALLOWED: cond<$cond>\n";
3051                                 $allowed = 1;
3052                         }
3053                         if ($block =~/\b(?:if|for|while)\b/) {
3054                                 #print "APW: ALLOWED: block<$block>\n";
3055                                 $allowed = 1;
3056                         }
3057                         if (statement_block_size($block) > 1) {
3058                                 #print "APW: ALLOWED: lines block<$block>\n";
3059                                 $allowed = 1;
3060                         }
3061                         # Check the post-context.
3062                         if (defined $chunks[1]) {
3063                                 my ($cond, $block) = @{$chunks[1]};
3064                                 if (defined $cond) {
3065                                         substr($block, 0, length($cond), '');
3066                                 }
3067                                 if ($block =~ /^\s*\{/) {
3068                                         #print "APW: ALLOWED: chunk-1 block<$block>\n";
3069                                         $allowed = 1;
3070                                 }
3071                         }
3072                         if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3073                                 my $herectx = $here . "\n";
3074                                 my $cnt = statement_rawlines($block);
3075
3076                                 for (my $n = 0; $n < $cnt; $n++) {
3077                                         $herectx .= raw_line($linenr, $n) . "\n";
3078                                 }
3079
3080                                 WARN("BRACES",
3081                                      "braces {} are not necessary for single statement blocks\n" . $herectx);
3082                         }
3083                 }
3084
3085 # don't include deprecated include files (uses RAW line)
3086                 for my $inc (keys %dep_includes) {
3087                         if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
3088                                 ERROR("DEPRECATED_INCLUDE",
3089                                       "Don't use <$inc>, include " .
3090                                       "$dep_includes{$inc} instead\n" .
3091                                       $herecurr);
3092                         }
3093                 }
3094
3095 # don't use deprecated functions
3096                 for my $func (keys %dep_functions) {
3097                         if ($line =~ /\b$func\b/) {
3098                                 ERROR("DEPRECATED_FUNCTION",
3099                                       "$func is deprecated, " .
3100                                       "use $dep_functions{$func} instead\n" .
3101                                       $herecurr);
3102                         }
3103                 }
3104
3105 # try to replace assertions with error handling
3106                 if ($line =~ /\bLASSERTF?\s*\(/) {
3107                     WARN("LASSERT",
3108                          "try to replace assertions with error handling\n" .
3109                          $herecurr);
3110                 }
3111
3112 # avoid new console messages
3113                 if ($line =~ /\bLCONSOLE[A-Z_]*\s*\(/) {
3114                     WARN("LCONSOLE",
3115                          "avoid adding new console messages\n" .
3116                          $herecurr);
3117                 }
3118
3119 # minimize new CERROR messages
3120                 if ($line =~ /\bC(EMERG|ERROR|NETERR|WARN)\s*\(/) {
3121                     WARN("LCONSOLE",
3122                          "think hard before adding new CERROR messages\n" .
3123                          $herecurr);
3124                 }
3125
3126 # no volatiles please
3127                 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3128                 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3129                         WARN("VOLATILE",
3130                              "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3131                 }
3132
3133 # warn about #if 0
3134                 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3135                         CHK("REDUNDANT_CODE",
3136                             "if this code is redundant consider removing it\n" .
3137                                 $herecurr);
3138                 }
3139
3140 # check for needless kfree() checks
3141                 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3142                         my $expr = $1;
3143                         if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3144                                 WARN("NEEDLESS_KFREE",
3145                                      "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3146                         }
3147                 }
3148 # check for needless usb_free_urb() checks
3149                 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3150                         my $expr = $1;
3151                         if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3152                                 WARN("NEEDLESS_USB_FREE_URB",
3153                                      "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3154                         }
3155                 }
3156
3157 # prefer usleep_range over udelay
3158                 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3159                         # ignore udelay's < 10, however
3160                         if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3161                                 CHK("USLEEP_RANGE",
3162                                     "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3163                         }
3164                 }
3165
3166 # warn about unexpectedly long msleep's
3167                 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3168                         if ($1 < 20) {
3169                                 WARN("MSLEEP",
3170                                      "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3171                         }
3172                 }
3173
3174 # warn about #ifdefs in C files
3175 #               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3176 #                       print "#ifdef in C files should be avoided\n";
3177 #                       print "$herecurr";
3178 #                       $clean = 0;
3179 #               }
3180
3181 # warn about spacing in #ifdefs
3182                 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3183                         ERROR("SPACING",
3184                               "exactly one space required after that #$1\n" . $herecurr);
3185                 }
3186
3187 # check for spinlock_t definitions without a comment.
3188                 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3189                     $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3190                         my $which = $1;
3191                         if (!ctx_has_comment($first_line, $linenr)) {
3192                                 CHK("UNCOMMENTED_DEFINITION",
3193                                     "$1 definition without comment\n" . $herecurr);
3194                         }
3195                 }
3196 # check for memory barriers without a comment.
3197                 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3198                         if (!ctx_has_comment($first_line, $linenr)) {
3199                                 CHK("MEMORY_BARRIER",
3200                                     "memory barrier without comment\n" . $herecurr);
3201                         }
3202                 }
3203 # check of hardware specific defines
3204                 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3205                         CHK("ARCH_DEFINES",
3206                             "architecture specific defines should be avoided\n" .  $herecurr);
3207                 }
3208
3209 # Check that the storage class is at the beginning of a declaration
3210                 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3211                         WARN("STORAGE_CLASS",
3212                              "storage class should be at the beginning of the declaration\n" . $herecurr)
3213                 }
3214
3215 # check the location of the inline attribute, that it is between
3216 # storage class and type.
3217                 if ($line =~ /\b$Type\s+$Inline\b/ ||
3218                     $line =~ /\b$Inline\s+$Storage\b/) {
3219                         ERROR("INLINE_LOCATION",
3220                               "inline keyword should sit between storage class and type\n" . $herecurr);
3221                 }
3222
3223 # Check for __inline__ and __inline, prefer inline
3224                 if ($line =~ /\b(__inline__|__inline)\b/) {
3225                         WARN("INLINE",
3226                              "plain inline is preferred over $1\n" . $herecurr);
3227                 }
3228
3229 # Check for __attribute__ packed, prefer __packed
3230                 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3231                         WARN("PREFER_PACKED",
3232                              "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3233                 }
3234
3235 # Check for __attribute__ aligned, prefer __aligned
3236                 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3237                         WARN("PREFER_ALIGNED",
3238                              "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3239                 }
3240
3241 # Check for __attribute__ format(printf, prefer __printf
3242                 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3243                         WARN("PREFER_PRINTF",
3244                              "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3245                 }
3246
3247 # check for sizeof(&)
3248                 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3249                         WARN("SIZEOF_ADDRESS",
3250                              "sizeof(& should be avoided\n" . $herecurr);
3251                 }
3252
3253 # check for line continuations in quoted strings with odd counts of "
3254                 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3255                         WARN("LINE_CONTINUATIONS",
3256                              "Avoid line continuations in quoted strings\n" . $herecurr);
3257                 }
3258
3259 # Check for misused memsets
3260                 if (defined $stat &&
3261                     $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3262
3263                         my $ms_addr = $2;
3264                         my $ms_val = $8;
3265                         my $ms_size = $14;
3266
3267                         if ($ms_size =~ /^(0x|)0$/i) {
3268                                 ERROR("MEMSET",
3269                                       "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3270                         } elsif ($ms_size =~ /^(0x|)1$/i) {
3271                                 WARN("MEMSET",
3272                                      "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3273                         }
3274                 }
3275
3276 # typecasts on min/max could be min_t/max_t
3277                 if (defined $stat &&
3278                     $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3279                         if (defined $2 || defined $8) {
3280                                 my $call = $1;
3281                                 my $cast1 = deparenthesize($2);
3282                                 my $arg1 = $3;
3283                                 my $cast2 = deparenthesize($8);
3284                                 my $arg2 = $9;
3285                                 my $cast;
3286
3287                                 if ($cast1 ne "" && $cast2 ne "") {
3288                                         $cast = "$cast1 or $cast2";
3289                                 } elsif ($cast1 ne "") {
3290                                         $cast = $cast1;
3291                                 } else {
3292                                         $cast = $cast2;
3293                                 }
3294                                 WARN("MINMAX",
3295                                      "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3296                         }
3297                 }
3298
3299 # check for new externs in .c files.
3300                 if ($realfile =~ /\.c$/ && defined $stat &&
3301                     $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3302                 {
3303                         my $function_name = $1;
3304                         my $paren_space = $2;
3305
3306                         my $s = $stat;
3307                         if (defined $cond) {
3308                                 substr($s, 0, length($cond), '');
3309                         }
3310                         if ($s =~ /^\s*;/ &&
3311                             $function_name ne 'uninitialized_var')
3312                         {
3313                                 WARN("AVOID_EXTERNS",
3314                                      "externs should be avoided in .c files\n" .  $herecurr);
3315                         }
3316
3317                         if ($paren_space =~ /\n/) {
3318                                 WARN("FUNCTION_ARGUMENTS",
3319                                      "arguments for function declarations should follow identifier\n" . $herecurr);
3320                         }
3321
3322                 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3323                     $stat =~ /^.\s*extern\s+/)
3324                 {
3325                         WARN("AVOID_EXTERNS",
3326                              "externs should be avoided in .c files\n" .  $herecurr);
3327                 }
3328
3329 # checks for new __setup's
3330                 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3331                         my $name = $1;
3332
3333                         if (!grep(/$name/, @setup_docs)) {
3334                                 CHK("UNDOCUMENTED_SETUP",
3335                                     "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3336                         }
3337                 }
3338
3339 # check for pointless casting of kmalloc return
3340                 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3341                         WARN("UNNECESSARY_CASTS",
3342                              "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3343                 }
3344
3345 # check for multiple semicolons
3346                 if ($line =~ /;\s*;\s*$/) {
3347                     WARN("ONE_SEMICOLON",
3348                          "Statements terminations use 1 semicolon\n" . $herecurr);
3349                 }
3350
3351 # check for gcc specific __FUNCTION__
3352                 if ($line =~ /__FUNCTION__/) {
3353                         WARN("USE_FUNC",
3354                              "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
3355                 }
3356
3357 # check for semaphores initialized locked
3358                 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3359                         WARN("CONSIDER_COMPLETION",
3360                              "consider using a completion\n" . $herecurr);
3361
3362                 }
3363 # recommend kstrto* over simple_strto* and strict_strto*
3364                 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3365                         WARN("CONSIDER_KSTRTO",
3366                              "$1 is obsolete, use k$3 instead\n" . $herecurr);
3367                 }
3368 # check for __initcall(), use device_initcall() explicitly please
3369                 if ($line =~ /^.\s*__initcall\s*\(/) {
3370                         WARN("USE_DEVICE_INITCALL",
3371                              "please use device_initcall() instead of __initcall()\n" . $herecurr);
3372                 }
3373 # check for various ops structs, ensure they are const.
3374                 my $struct_ops = qr{acpi_dock_ops|
3375                                 address_space_operations|
3376                                 backlight_ops|
3377                                 block_device_operations|
3378                                 dentry_operations|
3379                                 dev_pm_ops|
3380                                 dma_map_ops|
3381                                 extent_io_ops|
3382                                 file_lock_operations|
3383                                 file_operations|
3384                                 hv_ops|
3385                                 ide_dma_ops|
3386                                 intel_dvo_dev_ops|
3387                                 item_operations|
3388                                 iwl_ops|
3389                                 kgdb_arch|
3390                                 kgdb_io|
3391                                 kset_uevent_ops|
3392                                 lock_manager_operations|
3393                                 microcode_ops|
3394                                 mtrr_ops|
3395                                 neigh_ops|
3396                                 nlmsvc_binding|
3397                                 pci_raw_ops|
3398                                 pipe_buf_operations|
3399                                 platform_hibernation_ops|
3400                                 platform_suspend_ops|
3401                                 proto_ops|
3402                                 rpc_pipe_ops|
3403                                 seq_operations|
3404                                 snd_ac97_build_ops|
3405                                 soc_pcmcia_socket_ops|
3406                                 stacktrace_ops|
3407                                 sysfs_ops|
3408                                 tty_operations|
3409                                 usb_mon_operations|
3410                                 wd_ops}x;
3411                 if ($line !~ /\bconst\b/ &&
3412                     $line =~ /\bstruct\s+($struct_ops)\b/) {
3413                         WARN("CONST_STRUCT",
3414                              "struct $1 should normally be const\n" .
3415                                 $herecurr);
3416                 }
3417
3418 # use of NR_CPUS is usually wrong
3419 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3420                 if ($line =~ /\bNR_CPUS\b/ &&
3421                     $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3422                     $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3423                     $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3424                     $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3425                     $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3426                 {
3427                         WARN("NR_CPUS",
3428                              "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3429                 }
3430
3431 # check for %L{u,d,i} in strings
3432                 my $string;
3433                 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3434                         $string = substr($rawline, $-[1], $+[1] - $-[1]);
3435                         $string =~ s/%%/__/g;
3436                         if ($string =~ /(?<!%)%L[udi]/) {
3437                                 WARN("PRINTF_L",
3438                                      "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3439                                 last;
3440                         }
3441                 }
3442
3443 # whine mightly about in_atomic
3444                 if ($line =~ /\bin_atomic\s*\(/) {
3445                         if ($realfile =~ m@^drivers/@) {
3446                                 ERROR("IN_ATOMIC",
3447                                       "do not use in_atomic in drivers\n" . $herecurr);
3448                         } elsif ($realfile !~ m@^kernel/@) {
3449                                 WARN("IN_ATOMIC",
3450                                      "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3451                         }
3452                 }
3453
3454 # check for lockdep_set_novalidate_class
3455                 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3456                     $line =~ /__lockdep_no_validate__\s*\)/ ) {
3457                         if ($realfile !~ m@^kernel/lockdep@ &&
3458                             $realfile !~ m@^include/linux/lockdep@ &&
3459                             $realfile !~ m@^drivers/base/core@) {
3460                                 ERROR("LOCKDEP",
3461                                       "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3462                         }
3463                 }
3464
3465                 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3466                     $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3467                         WARN("EXPORTED_WORLD_WRITABLE",
3468                              "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3469                 }
3470
3471                 if ($rawline =~ /version 3/) {
3472                         WARN("GPLV3",
3473                              "using GPLv3 is usually wrong\n" . $herecurr);
3474                 }
3475         }
3476
3477         # If we have no input at all, then there is nothing to report on
3478         # so just keep quiet.
3479         if ($#rawlines == -1) {
3480                 exit(0);
3481         }
3482
3483         # In mailback mode only produce a report in the negative, for
3484         # things that appear to be patches.
3485         if ($mailback && ($clean == 1 || !$is_patch)) {
3486                 exit(0);
3487         }
3488
3489         # This is not a patch, and we are are in 'no-patch' mode so
3490         # just keep quiet.
3491         if (!$chk_patch && !$is_patch) {
3492                 exit(0);
3493         }
3494
3495         if (!$is_patch) {
3496                 ERROR("NOT_UNIFIED_DIFF",
3497                       "Does not appear to be a unified-diff format patch\n");
3498         }
3499         if ($is_patch && $chk_signoff && $signoff == 0) {
3500                 ERROR("MISSING_SIGN_OFF",
3501                       "Missing Signed-off-by: line(s)\n");
3502         }
3503
3504         print report_dump();
3505         if ($summary && !($clean == 1 && $quiet == 1)) {
3506                 print "$filename " if ($summary_file);
3507                 print "total: $cnt_error errors, $cnt_warn warnings, " .
3508                         (($check)? "$cnt_chk checks, " : "") .
3509                         "$cnt_lines lines checked\n";
3510                 print "\n" if ($quiet == 0);
3511         }
3512
3513         if ($quiet == 0) {
3514                 # If there were whitespace errors which cleanpatch can fix
3515                 # then suggest that.
3516                 if ($rpt_cleaners) {
3517                         print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3518                         print "      scripts/cleanfile\n\n";
3519                         $rpt_cleaners = 0;
3520                 }
3521         }
3522
3523         if (keys %ignore_type) {
3524             print "NOTE: Ignored message types:";
3525             foreach my $ignore (sort keys %ignore_type) {
3526                 print " $ignore";
3527             }
3528             print "\n";
3529             print "\n" if ($quiet == 0);
3530         }
3531
3532         if ($clean == 1 && $quiet == 0) {
3533                 print "$vname has no obvious style problems and is ready for submission.\n"
3534         }
3535         if ($clean == 0 && $quiet == 0) {
3536                 print << "EOM";
3537 $vname has style problems, please review.
3538
3539 If any of these errors are false positives, please report
3540 them to the maintainer, see CHECKPATCH in MAINTAINERS.
3541 EOM
3542         }
3543
3544         return $clean;
3545 }