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