Whamcloud - gitweb
LU-8424 osd-zfs: ZFS macro DN_MAX_BONUSLEN is deprecated
[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_MASK',
436         'CFS_PAGE_SIZE',                'PAGE_SIZE',
437         'PAGE_CACHE_MASK',              'PAGE_MASK',
438         'PAGE_CACHE_SIZE',              'PAGE_SIZE',
439         'PAGE_CACHE_SHIFT',             'PAGE_SHIFT',
440
441         'page_cache_release',           'put_page',
442         'page_cache_get',               'get_page',
443
444         'cfs_proc_dir_entry_t',         'struct proc_dir_entry',
445
446         'cfs_rcu_head_t',               'struct rcu_head',
447
448         'cfs_hash_lock_t',              'union cfs_hash_lock',
449         'cfs_hash_bucket_t',            'struct cfs_hash_bucket',
450         'cfs_hash_bd_t',                'struct cfs_hash_bd',
451         'cfs_hash_t',                   'struct cfs_hash',
452         'cfs_hash_lock_ops_t',          'struct cfs_hash_lock_ops',
453         'cfs_hash_hlist_ops_t',         'struct cfs_hash_hlist_ops',
454         'cfs_hash_ops_t',               'struct cfs_hash_ops',
455         'cfs_hash_head_t',              'struct cfs_hash_head',
456         'cfs_hash_head_dep_t',          'struct cfs_hash_head_dep',
457         'cfs_hash_dhead_t',             'struct cfs_hash_dhead',
458         'cfs_hash_dhead_dep_t',         'struct cfs_hash_dhead_dep',
459         'cfs_hash_lookup_intent_t',     'enum cfs_hash_lookup_intent',
460         'cfs_hash_cond_arg_t',          'struct cfs_hash_cond_arg',
461
462         'lnet_ni_status_t',             'struct lnet_ni_status',
463         'lnet_ping_info_t',             'struct lnet_ping_info',
464         'lnet_process_id_packed_t',     'struct lnet_process_id_packed',
465         'lnet_handle_wire_t',           'struct lnet_handle_wire',
466         'lnet_hdr_t',                   'struct lnet_hdr',
467         'lnet_magicversion_t',          'struct lnet_magicversion',
468         'lnet_acceptor_connreq_t',      'struct lnet_acceptor_connreq',
469         'lnet_counters_t',              'struct lnet_counters',
470
471         'ldlm_appetite_t',              'enum ldlm_appetite',
472         'ldlm_cancel_flags_t',          'enum ldlm_cancel_flags',
473         'ldlm_error_t',                 'enum ldlm_error',
474         'ldlm_ns_hash_def_t',           'struct ldlm_ns_hash_def',
475         'ldlm_mode_t',                  'enum ldlm_mode',
476         'ldlm_ns_type_t',               'enum ldlm_ns_type',
477         'ldlm_policy_data_t',           'enum ldlm_policy_data',
478         'ldlm_policy_res_t',            'enum ldlm_policy_res',
479         'ldlm_side_t',                  'enum ldlm_side',
480         'ldlm_type_t',                  'enum ldlm_type',
481         'ldlm_wire_policy_data_t',      'union ldlm_wire_policy_data',
482
483         'LPU64',                        '%llu',
484         'LPD64',                        '%lld',
485         'LPX64',                        '%#llx',
486         'LPX64i',                       '%llx',
487         'LPO64',                        '%#llo',
488
489         'LPLU',                         '%lu',
490         'LPLD',                         '%ld',
491         'LPLX',                         '%#lx',
492         'LPPID',                        '%d',
493
494         'LPROCFS',                      'CONFIG_PROC_FS',
495         'mktemp',                       'mkstemp',
496         'sprintf',                      'snprintf',
497         'strcpy',                       'strncpy',
498         'strcat',                       'strncat',
499         'tempnam',                      'mkstemp',
500         'f_dentry',                     'f_path.dentry',
501         '= seq_printf',                 'seq_printf',
502         'return seq_printf',            'seq_printf',
503
504         'DN_MAX_BONUSLEN',              'DN_BONUS_SIZE(dnodesize)',
505         'DN_OLD_MAX_BONUSLEN',          'DN_BONUS_SIZE(DNODE_MIN_SIZE)',
506 );
507
508 my @rawlines = ();
509 my @lines = ();
510 my $vname;
511 for my $filename (@ARGV) {
512         my $FILE;
513         if ($file) {
514                 open($FILE, '-|', "diff -u /dev/null $filename") ||
515                         die "$P: $filename: diff failed - $!\n";
516         } elsif ($filename eq '-') {
517                 open($FILE, '<&STDIN');
518         } else {
519                 open($FILE, '<', "$filename") ||
520                         die "$P: $filename: open failed - $!\n";
521         }
522         if ($filename eq '-') {
523                 $vname = 'Your patch';
524         } else {
525                 $vname = $filename;
526         }
527         while (<$FILE>) {
528                 chomp;
529                 push(@rawlines, $_);
530         }
531         close($FILE);
532         if (!process($filename)) {
533                 $exit = 1;
534         }
535         @rawlines = ();
536         @lines = ();
537 }
538
539 exit($exit);
540
541 sub top_of_kernel_tree {
542         my ($root) = @_;
543
544         my @tree_check = (
545                 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
546                 "README", "Documentation", "arch", "include", "drivers",
547                 "fs", "init", "ipc", "kernel", "lib", "scripts",
548         );
549
550         foreach my $check (@tree_check) {
551                 if (! -e $root . '/' . $check) {
552                         return 0;
553                 }
554         }
555         return 1;
556     }
557
558 sub parse_email {
559         my ($formatted_email) = @_;
560
561         my $name = "";
562         my $address = "";
563         my $comment = "";
564
565         if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
566                 $name = $1;
567                 $address = $2;
568                 $comment = $3 if defined $3;
569         } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
570                 $address = $1;
571                 $comment = $2 if defined $2;
572         } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
573                 $address = $1;
574                 $comment = $2 if defined $2;
575                 $formatted_email =~ s/$address.*$//;
576                 $name = $formatted_email;
577                 $name =~ s/^\s+|\s+$//g;
578                 $name =~ s/^\"|\"$//g;
579                 # If there's a name left after stripping spaces and
580                 # leading quotes, and the address doesn't have both
581                 # leading and trailing angle brackets, the address
582                 # is invalid. ie:
583                 #   "joe smith joe@smith.com" bad
584                 #   "joe smith <joe@smith.com" bad
585                 if ($name ne "" && $address !~ /^<[^>]+>$/) {
586                         $name = "";
587                         $address = "";
588                         $comment = "";
589                 }
590         }
591
592         $name =~ s/^\s+|\s+$//g;
593         $name =~ s/^\"|\"$//g;
594         $address =~ s/^\s+|\s+$//g;
595         $address =~ s/^\<|\>$//g;
596
597         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
598                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
599                 $name = "\"$name\"";
600         }
601
602         return ($name, $address, $comment);
603 }
604
605 sub format_email {
606         my ($name, $address) = @_;
607
608         my $formatted_email;
609
610         $name =~ s/^\s+|\s+$//g;
611         $name =~ s/^\"|\"$//g;
612         $address =~ s/^\s+|\s+$//g;
613
614         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
615                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
616                 $name = "\"$name\"";
617         }
618
619         if ("$name" eq "") {
620                 $formatted_email = "$address";
621         } else {
622                 $formatted_email = "$name <$address>";
623         }
624
625         return $formatted_email;
626 }
627
628 sub which_conf {
629         my ($conf) = @_;
630
631         foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
632                 if (-e "$path/$conf") {
633                         return "$path/$conf";
634                 }
635         }
636
637         return "";
638 }
639
640 sub expand_tabs {
641         my ($str) = @_;
642
643         my $res = '';
644         my $n = 0;
645         for my $c (split(//, $str)) {
646                 if ($c eq "\t") {
647                         $res .= ' ';
648                         $n++;
649                         for (; ($n % 8) != 0; $n++) {
650                                 $res .= ' ';
651                         }
652                         next;
653                 }
654                 $res .= $c;
655                 $n++;
656         }
657
658         return $res;
659 }
660 sub copy_spacing {
661         (my $res = shift) =~ tr/\t/ /c;
662         return $res;
663 }
664
665 sub line_stats {
666         my ($line) = @_;
667
668         # Drop the diff line leader and expand tabs
669         $line =~ s/^.//;
670         $line = expand_tabs($line);
671
672         # Pick the indent from the front of the line.
673         my ($white) = ($line =~ /^(\s*)/);
674
675         return (length($line), length($white));
676 }
677
678 my $sanitise_quote = '';
679
680 sub sanitise_line_reset {
681         my ($in_comment) = @_;
682
683         if ($in_comment) {
684                 $sanitise_quote = '*/';
685         } else {
686                 $sanitise_quote = '';
687         }
688 }
689 sub sanitise_line {
690         my ($line) = @_;
691
692         my $res = '';
693         my $l = '';
694
695         my $qlen = 0;
696         my $off = 0;
697         my $c;
698
699         # Always copy over the diff marker.
700         $res = substr($line, 0, 1);
701
702         for ($off = 1; $off < length($line); $off++) {
703                 $c = substr($line, $off, 1);
704
705                 # Comments we are wacking completly including the begin
706                 # and end, all to $;.
707                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
708                         $sanitise_quote = '*/';
709
710                         substr($res, $off, 2, "$;$;");
711                         $off++;
712                         next;
713                 }
714                 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
715                         $sanitise_quote = '';
716                         substr($res, $off, 2, "$;$;");
717                         $off++;
718                         next;
719                 }
720                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
721                         $sanitise_quote = '//';
722
723                         substr($res, $off, 2, $sanitise_quote);
724                         $off++;
725                         next;
726                 }
727
728                 # A \ in a string means ignore the next character.
729                 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
730                     $c eq "\\") {
731                         substr($res, $off, 2, 'XX');
732                         $off++;
733                         next;
734                 }
735                 # Regular quotes.
736                 if ($c eq "'" || $c eq '"') {
737                         if ($sanitise_quote eq '') {
738                                 $sanitise_quote = $c;
739
740                                 substr($res, $off, 1, $c);
741                                 next;
742                         } elsif ($sanitise_quote eq $c) {
743                                 $sanitise_quote = '';
744                         }
745                 }
746
747                 #print "c<$c> SQ<$sanitise_quote>\n";
748                 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
749                         substr($res, $off, 1, $;);
750                 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
751                         substr($res, $off, 1, $;);
752                 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
753                         substr($res, $off, 1, 'X');
754                 } else {
755                         substr($res, $off, 1, $c);
756                 }
757         }
758
759         if ($sanitise_quote eq '//') {
760                 $sanitise_quote = '';
761         }
762
763         # The pathname on a #include may be surrounded by '<' and '>'.
764         if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
765                 my $clean = 'X' x length($1);
766                 $res =~ s@\<.*\>@<$clean>@;
767
768         # The whole of a #error is a string.
769         } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
770                 my $clean = 'X' x length($1);
771                 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
772         }
773
774         return $res;
775 }
776
777 sub ctx_statement_block {
778         my ($linenr, $remain, $off) = @_;
779         my $line = $linenr - 1;
780         my $blk = '';
781         my $soff = $off;
782         my $coff = $off - 1;
783         my $coff_set = 0;
784
785         my $loff = 0;
786
787         my $type = '';
788         my $level = 0;
789         my @stack = ();
790         my $p;
791         my $c;
792         my $len = 0;
793
794         my $remainder;
795         while (1) {
796                 @stack = (['', 0]) if ($#stack == -1);
797
798                 #warn "CSB: blk<$blk> remain<$remain>\n";
799                 # If we are about to drop off the end, pull in more
800                 # context.
801                 if ($off >= $len) {
802                         for (; $remain > 0; $line++) {
803                                 last if (!defined $lines[$line]);
804                                 next if ($lines[$line] =~ /^-/);
805                                 $remain--;
806                                 $loff = $len;
807                                 $blk .= $lines[$line] . "\n";
808                                 $len = length($blk);
809                                 $line++;
810                                 last;
811                         }
812                         # Bail if there is no further context.
813                         #warn "CSB: blk<$blk> off<$off> len<$len>\n";
814                         if ($off >= $len) {
815                                 last;
816                         }
817                         if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
818                                 $level++;
819                                 $type = '#';
820                         }
821                 }
822                 $p = $c;
823                 $c = substr($blk, $off, 1);
824                 $remainder = substr($blk, $off);
825
826                 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
827
828                 # Handle nested #if/#else.
829                 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
830                         push(@stack, [ $type, $level ]);
831                 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
832                         ($type, $level) = @{$stack[$#stack - 1]};
833                 } elsif ($remainder =~ /^#\s*endif\b/) {
834                         ($type, $level) = @{pop(@stack)};
835                 }
836
837                 # Statement ends at the ';' or a close '}' at the
838                 # outermost level.
839                 if ($level == 0 && $c eq ';') {
840                         last;
841                 }
842
843                 # An else is really a conditional as long as its not else if
844                 if ($level == 0 && $coff_set == 0 &&
845                                 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
846                                 $remainder =~ /^(else)(?:\s|{)/ &&
847                                 $remainder !~ /^else\s+if\b/) {
848                         $coff = $off + length($1) - 1;
849                         $coff_set = 1;
850                         #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
851                         #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
852                 }
853
854                 if (($type eq '' || $type eq '(') && $c eq '(') {
855                         $level++;
856                         $type = '(';
857                 }
858                 if ($type eq '(' && $c eq ')') {
859                         $level--;
860                         $type = ($level != 0)? '(' : '';
861
862                         if ($level == 0 && $coff < $soff) {
863                                 $coff = $off;
864                                 $coff_set = 1;
865                                 #warn "CSB: mark coff<$coff>\n";
866                         }
867                 }
868                 if (($type eq '' || $type eq '{') && $c eq '{') {
869                         $level++;
870                         $type = '{';
871                 }
872                 if ($type eq '{' && $c eq '}') {
873                         $level--;
874                         $type = ($level != 0)? '{' : '';
875
876                         if ($level == 0) {
877                                 if (substr($blk, $off + 1, 1) eq ';') {
878                                         $off++;
879                                 }
880                                 last;
881                         }
882                 }
883                 # Preprocessor commands end at the newline unless escaped.
884                 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
885                         $level--;
886                         $type = '';
887                         $off++;
888                         last;
889                 }
890                 $off++;
891         }
892         # We are truly at the end, so shuffle to the next line.
893         if ($off == $len) {
894                 $loff = $len + 1;
895                 $line++;
896                 $remain--;
897         }
898
899         my $statement = substr($blk, $soff, $off - $soff + 1);
900         my $condition = substr($blk, $soff, $coff - $soff + 1);
901
902         #warn "STATEMENT<$statement>\n";
903         #warn "CONDITION<$condition>\n";
904
905         #print "coff<$coff> soff<$off> loff<$loff>\n";
906
907         return ($statement, $condition,
908                         $line, $remain + 1, $off - $loff + 1, $level);
909 }
910
911 sub statement_lines {
912         my ($stmt) = @_;
913
914         # Strip the diff line prefixes and rip blank lines at start and end.
915         $stmt =~ s/(^|\n)./$1/g;
916         $stmt =~ s/^\s*//;
917         $stmt =~ s/\s*$//;
918
919         my @stmt_lines = ($stmt =~ /\n/g);
920
921         return $#stmt_lines + 2;
922 }
923
924 sub statement_rawlines {
925         my ($stmt) = @_;
926
927         my @stmt_lines = ($stmt =~ /\n/g);
928
929         return $#stmt_lines + 2;
930 }
931
932 sub statement_block_size {
933         my ($stmt) = @_;
934
935         $stmt =~ s/(^|\n)./$1/g;
936         $stmt =~ s/^\s*{//;
937         $stmt =~ s/}\s*$//;
938         $stmt =~ s/^\s*//;
939         $stmt =~ s/\s*$//;
940
941         my @stmt_lines = ($stmt =~ /\n/g);
942         my @stmt_statements = ($stmt =~ /;/g);
943
944         my $stmt_lines = $#stmt_lines + 2;
945         my $stmt_statements = $#stmt_statements + 1;
946
947         if ($stmt_lines > $stmt_statements) {
948                 return $stmt_lines;
949         } else {
950                 return $stmt_statements;
951         }
952 }
953
954 sub ctx_statement_full {
955         my ($linenr, $remain, $off) = @_;
956         my ($statement, $condition, $level);
957
958         my (@chunks);
959
960         # Grab the first conditional/block pair.
961         ($statement, $condition, $linenr, $remain, $off, $level) =
962                                 ctx_statement_block($linenr, $remain, $off);
963         #print "F: c<$condition> s<$statement> remain<$remain>\n";
964         push(@chunks, [ $condition, $statement ]);
965         if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
966                 return ($level, $linenr, @chunks);
967         }
968
969         # Pull in the following conditional/block pairs and see if they
970         # could continue the statement.
971         for (;;) {
972                 ($statement, $condition, $linenr, $remain, $off, $level) =
973                                 ctx_statement_block($linenr, $remain, $off);
974                 #print "C: c<$condition> s<$statement> remain<$remain>\n";
975                 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
976                 #print "C: push\n";
977                 push(@chunks, [ $condition, $statement ]);
978         }
979
980         return ($level, $linenr, @chunks);
981 }
982
983 sub ctx_block_get {
984         my ($linenr, $remain, $outer, $open, $close, $off) = @_;
985         my $line;
986         my $start = $linenr - 1;
987         my $blk = '';
988         my @o;
989         my @c;
990         my @res = ();
991
992         my $level = 0;
993         my @stack = ($level);
994         for ($line = $start; $remain > 0; $line++) {
995                 next if ($rawlines[$line] =~ /^-/);
996                 $remain--;
997
998                 $blk .= $rawlines[$line];
999
1000                 # Handle nested #if/#else.
1001                 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1002                         push(@stack, $level);
1003                 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1004                         $level = $stack[$#stack - 1];
1005                 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1006                         $level = pop(@stack);
1007                 }
1008
1009                 foreach my $c (split(//, $lines[$line])) {
1010                         ##print "C<$c>L<$level><$open$close>O<$off>\n";
1011                         if ($off > 0) {
1012                                 $off--;
1013                                 next;
1014                         }
1015
1016                         if ($c eq $close && $level > 0) {
1017                                 $level--;
1018                                 last if ($level == 0);
1019                         } elsif ($c eq $open) {
1020                                 $level++;
1021                         }
1022                 }
1023
1024                 if (!$outer || $level <= 1) {
1025                         push(@res, $rawlines[$line]);
1026                 }
1027
1028                 last if ($level == 0);
1029         }
1030
1031         return ($level, @res);
1032 }
1033 sub ctx_block_outer {
1034         my ($linenr, $remain) = @_;
1035
1036         my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1037         return @r;
1038 }
1039 sub ctx_block {
1040         my ($linenr, $remain) = @_;
1041
1042         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1043         return @r;
1044 }
1045 sub ctx_statement {
1046         my ($linenr, $remain, $off) = @_;
1047
1048         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1049         return @r;
1050 }
1051 sub ctx_block_level {
1052         my ($linenr, $remain) = @_;
1053
1054         return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1055 }
1056 sub ctx_statement_level {
1057         my ($linenr, $remain, $off) = @_;
1058
1059         return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1060 }
1061
1062 sub ctx_locate_comment {
1063         my ($first_line, $end_line) = @_;
1064
1065         # Catch a comment on the end of the line itself.
1066         my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1067         return $current_comment if (defined $current_comment);
1068
1069         # Look through the context and try and figure out if there is a
1070         # comment.
1071         my $in_comment = 0;
1072         $current_comment = '';
1073         for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1074                 my $line = $rawlines[$linenr - 1];
1075                 #warn "           $line\n";
1076                 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1077                         $in_comment = 1;
1078                 }
1079                 if ($line =~ m@/\*@) {
1080                         $in_comment = 1;
1081                 }
1082                 if (!$in_comment && $current_comment ne '') {
1083                         $current_comment = '';
1084                 }
1085                 $current_comment .= $line . "\n" if ($in_comment);
1086                 if ($line =~ m@\*/@) {
1087                         $in_comment = 0;
1088                 }
1089         }
1090
1091         chomp($current_comment);
1092         return($current_comment);
1093 }
1094 sub ctx_has_comment {
1095         my ($first_line, $end_line) = @_;
1096         my $cmt = ctx_locate_comment($first_line, $end_line);
1097
1098         ##print "LINE: $rawlines[$end_line - 1 ]\n";
1099         ##print "CMMT: $cmt\n";
1100
1101         return ($cmt ne '');
1102 }
1103
1104 sub raw_line {
1105         my ($linenr, $cnt) = @_;
1106
1107         my $offset = $linenr - 1;
1108         $cnt++;
1109
1110         my $line;
1111         while ($cnt) {
1112                 $line = $rawlines[$offset++];
1113                 next if (defined($line) && $line =~ /^-/);
1114                 $cnt--;
1115         }
1116
1117         return $line;
1118 }
1119
1120 sub cat_vet {
1121         my ($vet) = @_;
1122         my ($res, $coded);
1123
1124         $res = '';
1125         while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1126                 $res .= $1;
1127                 if ($2 ne '') {
1128                         $coded = sprintf("^%c", unpack('C', $2) + 64);
1129                         $res .= $coded;
1130                 }
1131         }
1132         $res =~ s/$/\$/;
1133
1134         return $res;
1135 }
1136
1137 my $av_preprocessor = 0;
1138 my $av_pending;
1139 my @av_paren_type;
1140 my $av_pend_colon;
1141
1142 sub annotate_reset {
1143         $av_preprocessor = 0;
1144         $av_pending = '_';
1145         @av_paren_type = ('E');
1146         $av_pend_colon = 'O';
1147 }
1148
1149 sub annotate_values {
1150         my ($stream, $type) = @_;
1151
1152         my $res;
1153         my $var = '_' x length($stream);
1154         my $cur = $stream;
1155
1156         print "$stream\n" if ($dbg_values > 1);
1157
1158         while (length($cur)) {
1159                 @av_paren_type = ('E') if ($#av_paren_type < 0);
1160                 print " <" . join('', @av_paren_type) .
1161                                 "> <$type> <$av_pending>" if ($dbg_values > 1);
1162                 if ($cur =~ /^(\s+)/o) {
1163                         print "WS($1)\n" if ($dbg_values > 1);
1164                         if ($1 =~ /\n/ && $av_preprocessor) {
1165                                 $type = pop(@av_paren_type);
1166                                 $av_preprocessor = 0;
1167                         }
1168
1169                 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1170                         print "CAST($1)\n" if ($dbg_values > 1);
1171                         push(@av_paren_type, $type);
1172                         $type = 'c';
1173
1174                 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1175                         print "DECLARE($1)\n" if ($dbg_values > 1);
1176                         $type = 'T';
1177
1178                 } elsif ($cur =~ /^($Modifier)\s*/) {
1179                         print "MODIFIER($1)\n" if ($dbg_values > 1);
1180                         $type = 'T';
1181
1182                 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1183                         print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1184                         $av_preprocessor = 1;
1185                         push(@av_paren_type, $type);
1186                         if ($2 ne '') {
1187                                 $av_pending = 'N';
1188                         }
1189                         $type = 'E';
1190
1191                 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1192                         print "UNDEF($1)\n" if ($dbg_values > 1);
1193                         $av_preprocessor = 1;
1194                         push(@av_paren_type, $type);
1195
1196                 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1197                         print "PRE_START($1)\n" if ($dbg_values > 1);
1198                         $av_preprocessor = 1;
1199
1200                         push(@av_paren_type, $type);
1201                         push(@av_paren_type, $type);
1202                         $type = 'E';
1203
1204                 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1205                         print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1206                         $av_preprocessor = 1;
1207
1208                         push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1209
1210                         $type = 'E';
1211
1212                 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1213                         print "PRE_END($1)\n" if ($dbg_values > 1);
1214
1215                         $av_preprocessor = 1;
1216
1217                         # Assume all arms of the conditional end as this
1218                         # one does, and continue as if the #endif was not here.
1219                         pop(@av_paren_type);
1220                         push(@av_paren_type, $type);
1221                         $type = 'E';
1222
1223                 } elsif ($cur =~ /^(\\\n)/o) {
1224                         print "PRECONT($1)\n" if ($dbg_values > 1);
1225
1226                 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1227                         print "ATTR($1)\n" if ($dbg_values > 1);
1228                         $av_pending = $type;
1229                         $type = 'N';
1230
1231                 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1232                         print "SIZEOF($1)\n" if ($dbg_values > 1);
1233                         if (defined $2) {
1234                                 $av_pending = 'V';
1235                         }
1236                         $type = 'N';
1237
1238                 } elsif ($cur =~ /^(if|while|for)\b/o) {
1239                         print "COND($1)\n" if ($dbg_values > 1);
1240                         $av_pending = 'E';
1241                         $type = 'N';
1242
1243                 } elsif ($cur =~/^(case)/o) {
1244                         print "CASE($1)\n" if ($dbg_values > 1);
1245                         $av_pend_colon = 'C';
1246                         $type = 'N';
1247
1248                 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1249                         print "KEYWORD($1)\n" if ($dbg_values > 1);
1250                         $type = 'N';
1251
1252                 } elsif ($cur =~ /^(\()/o) {
1253                         print "PAREN('$1')\n" if ($dbg_values > 1);
1254                         push(@av_paren_type, $av_pending);
1255                         $av_pending = '_';
1256                         $type = 'N';
1257
1258                 } elsif ($cur =~ /^(\))/o) {
1259                         my $new_type = pop(@av_paren_type);
1260                         if ($new_type ne '_') {
1261                                 $type = $new_type;
1262                                 print "PAREN('$1') -> $type\n"
1263                                                         if ($dbg_values > 1);
1264                         } else {
1265                                 print "PAREN('$1')\n" if ($dbg_values > 1);
1266                         }
1267
1268                 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1269                         print "FUNC($1)\n" if ($dbg_values > 1);
1270                         $type = 'V';
1271                         $av_pending = 'V';
1272
1273                 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1274                         if (defined $2 && $type eq 'C' || $type eq 'T') {
1275                                 $av_pend_colon = 'B';
1276                         } elsif ($type eq 'E') {
1277                                 $av_pend_colon = 'L';
1278                         }
1279                         print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1280                         $type = 'V';
1281
1282                 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1283                         print "IDENT($1)\n" if ($dbg_values > 1);
1284                         $type = 'V';
1285
1286                 } elsif ($cur =~ /^($Assignment)/o) {
1287                         print "ASSIGN($1)\n" if ($dbg_values > 1);
1288                         $type = 'N';
1289
1290                 } elsif ($cur =~/^(;|{|})/) {
1291                         print "END($1)\n" if ($dbg_values > 1);
1292                         $type = 'E';
1293                         $av_pend_colon = 'O';
1294
1295                 } elsif ($cur =~/^(,)/) {
1296                         print "COMMA($1)\n" if ($dbg_values > 1);
1297                         $type = 'C';
1298
1299                 } elsif ($cur =~ /^(\?)/o) {
1300                         print "QUESTION($1)\n" if ($dbg_values > 1);
1301                         $type = 'N';
1302
1303                 } elsif ($cur =~ /^(:)/o) {
1304                         print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1305
1306                         substr($var, length($res), 1, $av_pend_colon);
1307                         if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1308                                 $type = 'E';
1309                         } else {
1310                                 $type = 'N';
1311                         }
1312                         $av_pend_colon = 'O';
1313
1314                 } elsif ($cur =~ /^(\[)/o) {
1315                         print "CLOSE($1)\n" if ($dbg_values > 1);
1316                         $type = 'N';
1317
1318                 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1319                         my $variant;
1320
1321                         print "OPV($1)\n" if ($dbg_values > 1);
1322                         if ($type eq 'V') {
1323                                 $variant = 'B';
1324                         } else {
1325                                 $variant = 'U';
1326                         }
1327
1328                         substr($var, length($res), 1, $variant);
1329                         $type = 'N';
1330
1331                 } elsif ($cur =~ /^($Operators)/o) {
1332                         print "OP($1)\n" if ($dbg_values > 1);
1333                         if ($1 ne '++' && $1 ne '--') {
1334                                 $type = 'N';
1335                         }
1336
1337                 } elsif ($cur =~ /(^.)/o) {
1338                         print "C($1)\n" if ($dbg_values > 1);
1339                 }
1340                 if (defined $1) {
1341                         $cur = substr($cur, length($1));
1342                         $res .= $type x length($1);
1343                 }
1344         }
1345
1346         return ($res, $var);
1347 }
1348
1349 sub possible {
1350         my ($possible, $line) = @_;
1351         my $notPermitted = qr{(?:
1352                 ^(?:
1353                         $Modifier|
1354                         $Storage|
1355                         $Type|
1356                         DEFINE_\S+
1357                 )$|
1358                 ^(?:
1359                         goto|
1360                         return|
1361                         case|
1362                         else|
1363                         asm|__asm__|
1364                         do|
1365                         \#|
1366                         \#\#|
1367                 )(?:\s|$)|
1368                 ^(?:typedef|struct|enum)\b
1369             )}x;
1370         warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1371         if ($possible !~ $notPermitted) {
1372                 # Check for modifiers.
1373                 $possible =~ s/\s*$Storage\s*//g;
1374                 $possible =~ s/\s*$Sparse\s*//g;
1375                 if ($possible =~ /^\s*$/) {
1376
1377                 } elsif ($possible =~ /\s/) {
1378                         $possible =~ s/\s*$Type\s*//g;
1379                         for my $modifier (split(' ', $possible)) {
1380                                 if ($modifier !~ $notPermitted) {
1381                                         warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1382                                         push(@modifierList, $modifier);
1383                                 }
1384                         }
1385
1386                 } else {
1387                         warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1388                         push(@typeList, $possible);
1389                 }
1390                 build_types();
1391         } else {
1392                 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1393         }
1394 }
1395
1396 my $prefix = '';
1397
1398 sub show_type {
1399        return !defined $ignore_type{$_[0]};
1400 }
1401
1402 sub report {
1403         if (!show_type($_[1]) ||
1404             (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1405                 return 0;
1406         }
1407         my $line;
1408         if ($show_types) {
1409                 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1410         } else {
1411                 $line = "$prefix$_[0]: $_[2]\n";
1412         }
1413         $line = (split('\n', $line))[0] . "\n" if ($terse);
1414
1415         push(our @report, $line);
1416
1417         return 1;
1418 }
1419 sub report_dump {
1420         our @report;
1421 }
1422
1423 sub ERROR {
1424         if (report("ERROR", $_[0], $_[1])) {
1425                 our $clean = 0;
1426                 our $cnt_error++;
1427         }
1428 }
1429 sub WARN {
1430         if (report("WARNING", $_[0], $_[1])) {
1431                 our $clean = 0;
1432                 our $cnt_warn++;
1433         }
1434 }
1435 sub CHK {
1436         if ($check && report("CHECK", $_[0], $_[1])) {
1437                 our $clean = 0;
1438                 our $cnt_chk++;
1439         }
1440 }
1441
1442 sub check_absolute_file {
1443         my ($absolute, $herecurr) = @_;
1444         my $file = $absolute;
1445
1446         ##print "absolute<$absolute>\n";
1447
1448         # See if any suffix of this path is a path within the tree.
1449         while ($file =~ s@^[^/]*/@@) {
1450                 if (-f "$root/$file") {
1451                         ##print "file<$file>\n";
1452                         last;
1453                 }
1454         }
1455         if (! -f _)  {
1456                 return 0;
1457         }
1458
1459         # It is, so see if the prefix is acceptable.
1460         my $prefix = $absolute;
1461         substr($prefix, -length($file)) = '';
1462
1463         ##print "prefix<$prefix>\n";
1464         if ($prefix ne ".../") {
1465                 WARN("USE_RELATIVE_PATH",
1466                      "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1467         }
1468 }
1469
1470 sub process {
1471         my $filename = shift;
1472
1473         my $linenr=0;
1474         my $prevline="";
1475         my $prevrawline="";
1476         my $stashline="";
1477         my $stashrawline="";
1478
1479         my $length;
1480         my $indent;
1481         my $previndent=0;
1482         my $stashindent=0;
1483
1484         our $clean = 1;
1485         my $signoff = 0;
1486         my $is_patch = 0;
1487
1488         my $in_header_lines = 1;
1489         my $in_commit_log = 0;          #Scanning lines before patch
1490
1491         our @report = ();
1492         our $cnt_lines = 0;
1493         our $cnt_error = 0;
1494         our $cnt_warn = 0;
1495         our $cnt_chk = 0;
1496
1497         # Trace the real file/line as we go.
1498         my $realfile = '';
1499         my $realline = 0;
1500         my $realcnt = 0;
1501         my $here = '';
1502         my $in_comment = 0;
1503         my $comment_edge = 0;
1504         my $first_line = 0;
1505         my $p1_prefix = '';
1506
1507         my $prev_values = 'E';
1508
1509         # suppression flags
1510         my %suppress_ifbraces;
1511         my %suppress_whiletrailers;
1512         my %suppress_export;
1513         my $suppress_statement = 0;
1514
1515         # Pre-scan the patch sanitizing the lines.
1516         # Pre-scan the patch looking for any __setup documentation.
1517         #
1518         my @setup_docs = ();
1519         my $setup_docs = 0;
1520
1521         sanitise_line_reset();
1522         my $line;
1523         foreach my $rawline (@rawlines) {
1524                 $linenr++;
1525                 $line = $rawline;
1526
1527                 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1528                         $setup_docs = 0;
1529                         if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1530                                 $setup_docs = 1;
1531                         }
1532                         #next;
1533                 }
1534                 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1535                         $realline=$1-1;
1536                         if (defined $2) {
1537                                 $realcnt=$3+1;
1538                         } else {
1539                                 $realcnt=1+1;
1540                         }
1541                         $in_comment = 0;
1542
1543                         # Guestimate if this is a continuing comment.  Run
1544                         # the context looking for a comment "edge".  If this
1545                         # edge is a close comment then we must be in a comment
1546                         # at context start.
1547                         my $edge;
1548                         my $cnt = $realcnt;
1549                         for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1550                                 next if (defined $rawlines[$ln - 1] &&
1551                                          $rawlines[$ln - 1] =~ /^-/);
1552                                 $cnt--;
1553                                 #print "RAW<$rawlines[$ln - 1]>\n";
1554                                 last if (!defined $rawlines[$ln - 1]);
1555                                 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1556                                     $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1557                                         ($edge) = $1;
1558                                         last;
1559                                 }
1560                         }
1561                         if (defined $edge && $edge eq '*/') {
1562                                 $in_comment = 1;
1563                         }
1564
1565                         # Guestimate if this is a continuing comment.  If this
1566                         # is the start of a diff block and this line starts
1567                         # ' *' then it is very likely a comment.
1568                         if (!defined $edge &&
1569                             $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1570                         {
1571                                 $in_comment = 1;
1572                         }
1573
1574                         ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1575                         sanitise_line_reset($in_comment);
1576
1577                 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1578                         # Standardise the strings and chars within the input to
1579                         # simplify matching -- only bother with positive lines.
1580                         $line = sanitise_line($rawline);
1581                 }
1582                 push(@lines, $line);
1583
1584                 if ($realcnt > 1) {
1585                         $realcnt-- if ($line =~ /^(?:\+| |$)/);
1586                 } else {
1587                         $realcnt = 0;
1588                 }
1589
1590                 #print "==>$rawline\n";
1591                 #print "-->$line\n";
1592
1593                 if ($setup_docs && $line =~ /^\+/) {
1594                         push(@setup_docs, $line);
1595                 }
1596         }
1597
1598         $prefix = '';
1599
1600         $realcnt = 0;
1601         $linenr = 0;
1602         foreach my $line (@lines) {
1603                 $linenr++;
1604
1605                 my $rawline = $rawlines[$linenr - 1];
1606
1607 #extract the line range in the file after the patch is applied
1608                 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1609                         $is_patch = 1;
1610                         $first_line = $linenr + 1;
1611                         $realline=$1-1;
1612                         if (defined $2) {
1613                                 $realcnt=$3+1;
1614                         } else {
1615                                 $realcnt=1+1;
1616                         }
1617                         annotate_reset();
1618                         $prev_values = 'E';
1619
1620                         %suppress_ifbraces = ();
1621                         %suppress_whiletrailers = ();
1622                         %suppress_export = ();
1623                         $suppress_statement = 0;
1624                         next;
1625
1626 # track the line number as we move through the hunk, note that
1627 # new versions of GNU diff omit the leading space on completely
1628 # blank context lines so we need to count that too.
1629                 } elsif ($line =~ /^( |\+|$)/) {
1630                         $realline++;
1631                         $realcnt-- if ($realcnt != 0);
1632
1633                         # Measure the line length and indent.
1634                         ($length, $indent) = line_stats($rawline);
1635
1636                         # Track the previous line.
1637                         ($prevline, $stashline) = ($stashline, $line);
1638                         ($previndent, $stashindent) = ($stashindent, $indent);
1639                         ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1640
1641                         #warn "line<$line>\n";
1642
1643                 } elsif ($realcnt == 1) {
1644                         $realcnt--;
1645                 }
1646
1647                 my $hunk_line = ($realcnt != 0);
1648
1649 #make up the handle for any error we report on this line
1650                 $prefix = "$filename:$realline: " if ($emacs && $file);
1651                 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1652
1653                 $here = "#$linenr: " if (!$file);
1654                 $here = "#$realline: " if ($file);
1655
1656                 # extract the filename as it passes
1657                 if ($line =~ /^diff --git.*?(\S+)$/) {
1658                         $realfile = $1;
1659                         $realfile =~ s@^([^/]*)/@@;
1660                         $in_commit_log = 0;
1661                 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1662                         $realfile = $1;
1663                         $realfile =~ s@^([^/]*)/@@;
1664                         $in_commit_log = 0;
1665
1666                         $p1_prefix = $1;
1667                         if (!$file && $tree && $p1_prefix ne '' &&
1668                             -e "$root/$p1_prefix") {
1669                                 WARN("PATCH_PREFIX",
1670                                      "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1671                         }
1672
1673                         if ($realfile =~ m@^include/asm/@) {
1674                                 ERROR("MODIFIED_INCLUDE_ASM",
1675                                       "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1676                         }
1677                         next;
1678                 }
1679
1680                 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1681
1682                 my $hereline = "$here\n$rawline\n";
1683                 my $herecurr = "$here\n$rawline\n";
1684                 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1685
1686                 $cnt_lines++ if ($realcnt != 0);
1687
1688 # Check for incorrect file permissions
1689                 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1690                         my $permhere = $here . "FILE: $realfile\n";
1691                         if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1692                                 ERROR("EXECUTE_PERMISSIONS",
1693                                       "do not set execute permissions for source files\n" . $permhere);
1694                         }
1695                 }
1696
1697 # Check the patch for a signoff:
1698                 if ($line =~ /^\s*signed-off-by:/i) {
1699                         $signoff++;
1700                         $in_commit_log = 0;
1701                 }
1702
1703 # Check signature styles
1704                 if (!$in_header_lines &&
1705                     $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1706                         my $space_before = $1;
1707                         my $sign_off = $2;
1708                         my $space_after = $3;
1709                         my $email = $4;
1710                         my $ucfirst_sign_off = ucfirst(lc($sign_off));
1711
1712                         if (defined $space_before && $space_before ne "") {
1713                                 WARN("BAD_SIGN_OFF",
1714                                      "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1715                         }
1716                         if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1717                                 WARN("BAD_SIGN_OFF",
1718                                      "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1719                         }
1720                         if (!defined $space_after || $space_after ne " ") {
1721                                 WARN("BAD_SIGN_OFF",
1722                                      "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1723                         }
1724
1725                         my ($email_name, $email_address, $comment) = parse_email($email);
1726                         my $suggested_email = format_email(($email_name, $email_address));
1727                         if ($suggested_email eq "") {
1728                                 ERROR("BAD_SIGN_OFF",
1729                                       "Unrecognized email address: '$email'\n" . $herecurr);
1730                         } else {
1731                                 my $dequoted = $suggested_email;
1732                                 $dequoted =~ s/^"//;
1733                                 $dequoted =~ s/" </ </;
1734                                 # Don't force email to have quotes
1735                                 # Allow just an angle bracketed address
1736                                 if ("$dequoted$comment" ne $email &&
1737                                     "<$email_address>$comment" ne $email &&
1738                                     "$suggested_email$comment" ne $email) {
1739                                         WARN("BAD_SIGN_OFF",
1740                                              "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1741                                 }
1742                         }
1743                 }
1744
1745 # Check for wrappage within a valid hunk of the file
1746                 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1747                         ERROR("CORRUPTED_PATCH",
1748                               "patch seems to be corrupt (line wrapped?)\n" .
1749                                 $herecurr) if (!$emitted_corrupt++);
1750                 }
1751
1752 # Check for absolute kernel paths.
1753                 if ($tree) {
1754                         while ($line =~ m{(?:^|\s)(/\S*)}g) {
1755                                 my $file = $1;
1756
1757                                 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1758                                     check_absolute_file($1, $herecurr)) {
1759                                         #
1760                                 } else {
1761                                         check_absolute_file($file, $herecurr);
1762                                 }
1763                         }
1764                 }
1765
1766 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1767                 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1768                     $rawline !~ m/^$UTF8*$/) {
1769                         my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1770
1771                         my $blank = copy_spacing($rawline);
1772                         my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1773                         my $hereptr = "$hereline$ptr\n";
1774
1775                         CHK("INVALID_UTF8",
1776                             "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1777                 }
1778
1779 # Check if it's the start of a commit log
1780 # (not a header line and we haven't seen the patch filename)
1781                 if ($in_header_lines && $realfile =~ /^$/ &&
1782                     $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1783                         $in_header_lines = 0;
1784                         $in_commit_log = 1;
1785                 }
1786
1787 # Still not yet in a patch, check for any UTF-8
1788                 if ($in_commit_log && $realfile =~ /^$/ &&
1789                     $rawline =~ /$NON_ASCII_UTF8/) {
1790                         CHK("UTF8_BEFORE_PATCH",
1791                             "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1792                 }
1793
1794 # ignore non-hunk lines and lines being removed
1795                 next if (!$hunk_line || $line =~ /^-/);
1796
1797 #trailing whitespace
1798                 if ($line =~ /^\+.*\015/) {
1799                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1800                         ERROR("DOS_LINE_ENDINGS",
1801                               "DOS line endings\n" . $herevet);
1802
1803                 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1804                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1805                         ERROR("TRAILING_WHITESPACE",
1806                               "trailing whitespace\n" . $herevet);
1807                         $rpt_cleaners = 1;
1808                 }
1809
1810 # check for Kconfig help text having a real description
1811 # Only applies when adding the entry originally, after that we do not have
1812 # sufficient context to determine whether it is indeed long enough.
1813                 if ($realfile =~ /Kconfig/ &&
1814                     $line =~ /.\s*config\s+/) {
1815                         my $length = 0;
1816                         my $cnt = $realcnt;
1817                         my $ln = $linenr + 1;
1818                         my $f;
1819                         my $is_start = 0;
1820                         my $is_end = 0;
1821                         for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1822                                 $f = $lines[$ln - 1];
1823                                 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1824                                 $is_end = $lines[$ln - 1] =~ /^\+/;
1825
1826                                 next if ($f =~ /^-/);
1827
1828                                 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1829                                         $is_start = 1;
1830                                 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1831                                         $length = -1;
1832                                 }
1833
1834                                 $f =~ s/^.//;
1835                                 $f =~ s/#.*//;
1836                                 $f =~ s/^\s+//;
1837                                 next if ($f =~ /^$/);
1838                                 if ($f =~ /^\s*config\s/) {
1839                                         $is_end = 1;
1840                                         last;
1841                                 }
1842                                 $length++;
1843                         }
1844                         WARN("CONFIG_DESCRIPTION",
1845                              "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1846                         #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1847                 }
1848
1849                 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1850                     ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1851                         my $flag = $1;
1852                         my $replacement = {
1853                                 'EXTRA_AFLAGS' =>   'asflags-y',
1854                                 'EXTRA_CFLAGS' =>   'ccflags-y',
1855                                 'EXTRA_CPPFLAGS' => 'cppflags-y',
1856                                 'EXTRA_LDFLAGS' =>  'ldflags-y',
1857                         };
1858
1859                         WARN("DEPRECATED_VARIABLE",
1860                              "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1861                 }
1862
1863 # check we are in a valid source file if not then ignore this hunk
1864                 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1865
1866 #80 column limit
1867                 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1868                     $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1869                     !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1870                     $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1871                     $length > 80)
1872                 {
1873                         WARN("LONG_LINE",
1874                              "line over 80 characters\n" . $herecurr);
1875                 }
1876
1877 # check for spaces before a quoted newline
1878                 if ($rawline =~ /^.*\".*\s\\n/) {
1879                         WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1880                              "unnecessary whitespace before a quoted newline\n" . $herecurr);
1881                 }
1882
1883 # check for adding lines without a newline.
1884                 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1885                         WARN("MISSING_EOF_NEWLINE",
1886                              "adding a line without newline at end of file\n" . $herecurr);
1887                 }
1888
1889 # Blackfin: use hi/lo macros
1890                 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1891                         if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1892                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1893                                 ERROR("LO_MACRO",
1894                                       "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1895                         }
1896                         if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1897                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1898                                 ERROR("HI_MACRO",
1899                                       "use the HI() macro, not (... >> 16)\n" . $herevet);
1900                         }
1901                 }
1902
1903 # check we are in a valid source file C, perl or bash script
1904 # if not then ignore this hunk
1905                 next if ($realfile !~ /\.(h|c|pl|sh)$/);
1906
1907 # at the beginning of a line any tabs must come first and anything
1908 # more than 8 must use tabs.
1909                 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1910                     $rawline =~ /^\+\s*        \s*/) {
1911                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1912                         ERROR("CODE_INDENT",
1913                               "code indent should use tabs where possible\n" . $herevet);
1914                         $rpt_cleaners = 1;
1915                 }
1916
1917 # check for space before tabs.
1918                 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1919                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1920                         WARN("SPACE_BEFORE_TAB",
1921                              "please, no space before tabs\n" . $herevet);
1922                 }
1923
1924 # check for spaces at the beginning of a line.
1925 # Exceptions:
1926 #  1) within comments
1927 #  2) indented preprocessor commands
1928 #  3) hanging labels
1929                 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1930                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1931                         WARN("LEADING_SPACE",
1932                              "please, no spaces at the start of a line\n" . $herevet);
1933                 }
1934
1935 # check we are in a valid C source file if not then ignore this hunk
1936                 next if ($realfile !~ /\.(h|c)$/);
1937
1938 # check for RCS/CVS revision markers
1939                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1940                         WARN("CVS_KEYWORD",
1941                              "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1942                 }
1943
1944 # Blackfin: don't use __builtin_bfin_[cs]sync
1945                 if ($line =~ /__builtin_bfin_csync/) {
1946                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1947                         ERROR("CSYNC",
1948                               "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1949                 }
1950                 if ($line =~ /__builtin_bfin_ssync/) {
1951                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1952                         ERROR("SSYNC",
1953                               "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1954                 }
1955
1956 # Check for potential 'bare' types
1957                 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1958                     $realline_next);
1959 #print "LINE<$line>\n";
1960                 if ($linenr >= $suppress_statement &&
1961                     $realcnt && $line =~ /.\s*\S/) {
1962                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1963                                 ctx_statement_block($linenr, $realcnt, 0);
1964                         $stat =~ s/\n./\n /g;
1965                         $cond =~ s/\n./\n /g;
1966
1967 #print "linenr<$linenr> <$stat>\n";
1968                         # If this statement has no statement boundaries within
1969                         # it there is no point in retrying a statement scan
1970                         # until we hit end of it.
1971                         my $frag = $stat; $frag =~ s/;+\s*$//;
1972                         if ($frag !~ /(?:{|;)/) {
1973 #print "skip<$line_nr_next>\n";
1974                                 $suppress_statement = $line_nr_next;
1975                         }
1976
1977                         # Find the real next line.
1978                         $realline_next = $line_nr_next;
1979                         if (defined $realline_next &&
1980                             (!defined $lines[$realline_next - 1] ||
1981                              substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1982                                 $realline_next++;
1983                         }
1984
1985                         my $s = $stat;
1986                         $s =~ s/{.*$//s;
1987
1988                         # Ignore goto labels.
1989                         if ($s =~ /$Ident:\*$/s) {
1990
1991                         # Ignore functions being called
1992                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1993
1994                         } elsif ($s =~ /^.\s*else\b/s) {
1995
1996                         # declarations always start with types
1997                         } 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) {
1998                                 my $type = $1;
1999                                 $type =~ s/\s+/ /g;
2000                                 possible($type, "A:" . $s);
2001
2002                         # definitions in global scope can only start with types
2003                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2004                                 possible($1, "B:" . $s);
2005                         }
2006
2007                         # any (foo ... *) is a pointer cast, and foo is a type
2008                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2009                                 possible($1, "C:" . $s);
2010                         }
2011
2012                         # Check for any sort of function declaration.
2013                         # int foo(something bar, other baz);
2014                         # void (*store_gdt)(x86_descr_ptr *);
2015                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2016                                 my ($name_len) = length($1);
2017
2018                                 my $ctx = $s;
2019                                 substr($ctx, 0, $name_len + 1, '');
2020                                 $ctx =~ s/\)[^\)]*$//;
2021
2022                                 for my $arg (split(/\s*,\s*/, $ctx)) {
2023                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2024
2025                                                 possible($1, "D:" . $s);
2026                                         }
2027                                 }
2028                         }
2029
2030                 }
2031
2032 #
2033 # Checks which may be anchored in the context.
2034 #
2035
2036 # Check for switch () and associated case and default
2037 # statements should be at the same indent.
2038                 if ($line=~/\bswitch\s*\(.*\)/) {
2039                         my $err = '';
2040                         my $sep = '';
2041                         my @ctx = ctx_block_outer($linenr, $realcnt);
2042                         shift(@ctx);
2043                         for my $ctx (@ctx) {
2044                                 my ($clen, $cindent) = line_stats($ctx);
2045                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2046                                                         $indent != $cindent) {
2047                                         $err .= "$sep$ctx\n";
2048                                         $sep = '';
2049                                 } else {
2050                                         $sep = "[...]\n";
2051                                 }
2052                         }
2053                         if ($err ne '') {
2054                                 ERROR("SWITCH_CASE_INDENT_LEVEL",
2055                                       "switch and case should be at the same indent\n$hereline$err");
2056                         }
2057                 }
2058
2059 # if/while/etc brace do not go on next line, unless defining a do while loop,
2060 # or if that brace on the next line is for something else
2061                 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2062                         my $pre_ctx = "$1$2";
2063
2064                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2065
2066                         if ($line =~ /^\+\t{6,}/) {
2067                                 WARN("DEEP_INDENTATION",
2068                                      "Too many leading tabs - consider code refactoring\n" . $herecurr);
2069                         }
2070
2071                         my $ctx_cnt = $realcnt - $#ctx - 1;
2072                         my $ctx = join("\n", @ctx);
2073
2074                         my $ctx_ln = $linenr;
2075                         my $ctx_skip = $realcnt;
2076
2077                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2078                                         defined $lines[$ctx_ln - 1] &&
2079                                         $lines[$ctx_ln - 1] =~ /^-/)) {
2080                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2081                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2082                                 $ctx_ln++;
2083                         }
2084
2085                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2086                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2087
2088                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2089                                 ERROR("OPEN_BRACE",
2090                                       "that open brace { should be on the previous line\n" .
2091                                         "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2092                         }
2093                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2094                             $ctx =~ /\)\s*\;\s*$/ &&
2095                             defined $lines[$ctx_ln - 1])
2096                         {
2097                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2098                                 if ($nindent > $indent) {
2099                                         WARN("TRAILING_SEMICOLON",
2100                                              "trailing semicolon indicates no statements, indent implies otherwise\n" .
2101                                                 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2102                                 }
2103                         }
2104                 }
2105
2106 # Check relative indent for conditionals and blocks.
2107                 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2108                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2109                                 ctx_statement_block($linenr, $realcnt, 0)
2110                                         if (!defined $stat);
2111                         my ($s, $c) = ($stat, $cond);
2112
2113                         substr($s, 0, length($c), '');
2114
2115                         # Make sure we remove the line prefixes as we have
2116                         # none on the first line, and are going to readd them
2117                         # where necessary.
2118                         $s =~ s/\n./\n/gs;
2119
2120                         # Find out how long the conditional actually is.
2121                         my @newlines = ($c =~ /\n/gs);
2122                         my $cond_lines = 1 + $#newlines;
2123
2124                         # We want to check the first line inside the block
2125                         # starting at the end of the conditional, so remove:
2126                         #  1) any blank line termination
2127                         #  2) any opening brace { on end of the line
2128                         #  3) any do (...) {
2129                         my $continuation = 0;
2130                         my $check = 0;
2131                         $s =~ s/^.*\bdo\b//;
2132                         $s =~ s/^\s*{//;
2133                         if ($s =~ s/^\s*\\//) {
2134                                 $continuation = 1;
2135                         }
2136                         if ($s =~ s/^\s*?\n//) {
2137                                 $check = 1;
2138                                 $cond_lines++;
2139                         }
2140
2141                         # Also ignore a loop construct at the end of a
2142                         # preprocessor statement.
2143                         if (($prevline =~ /^.\s*#\s*define\s/ ||
2144                             $prevline =~ /\\\s*$/) && $continuation == 0) {
2145                                 $check = 0;
2146                         }
2147
2148                         my $cond_ptr = -1;
2149                         $continuation = 0;
2150                         while ($cond_ptr != $cond_lines) {
2151                                 $cond_ptr = $cond_lines;
2152
2153                                 # If we see an #else/#elif then the code
2154                                 # is not linear.
2155                                 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2156                                         $check = 0;
2157                                 }
2158
2159                                 # Ignore:
2160                                 #  1) blank lines, they should be at 0,
2161                                 #  2) preprocessor lines, and
2162                                 #  3) labels.
2163                                 if ($continuation ||
2164                                     $s =~ /^\s*?\n/ ||
2165                                     $s =~ /^\s*#\s*?/ ||
2166                                     $s =~ /^\s*$Ident\s*:/) {
2167                                         $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2168                                         if ($s =~ s/^.*?\n//) {
2169                                                 $cond_lines++;
2170                                         }
2171                                 }
2172                         }
2173
2174                         my (undef, $sindent) = line_stats("+" . $s);
2175                         my $stat_real = raw_line($linenr, $cond_lines);
2176
2177                         # Check if either of these lines are modified, else
2178                         # this is not this patch's fault.
2179                         if (!defined($stat_real) ||
2180                             $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2181                                 $check = 0;
2182                         }
2183                         if (defined($stat_real) && $cond_lines > 1) {
2184                                 $stat_real = "[...]\n$stat_real";
2185                         }
2186
2187                         #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";
2188
2189                         if ($check && (($sindent % 8) != 0 ||
2190                             ($sindent <= $indent && $s ne ''))) {
2191                                 WARN("SUSPECT_CODE_INDENT",
2192                                      "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2193                         }
2194                 }
2195
2196                 # Track the 'values' across context and added lines.
2197                 my $opline = $line; $opline =~ s/^./ /;
2198                 my ($curr_values, $curr_vars) =
2199                                 annotate_values($opline . "\n", $prev_values);
2200                 $curr_values = $prev_values . $curr_values;
2201                 if ($dbg_values) {
2202                         my $outline = $opline; $outline =~ s/\t/ /g;
2203                         print "$linenr > .$outline\n";
2204                         print "$linenr > $curr_values\n";
2205                         print "$linenr >  $curr_vars\n";
2206                 }
2207                 $prev_values = substr($curr_values, -1);
2208
2209 #ignore lines not being added
2210                 if ($line=~/^[^\+]/) {next;}
2211
2212 # TEST: allow direct testing of the type matcher.
2213                 if ($dbg_type) {
2214                         if ($line =~ /^.\s*$Declare\s*$/) {
2215                                 ERROR("TEST_TYPE",
2216                                       "TEST: is type\n" . $herecurr);
2217                         } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2218                                 ERROR("TEST_NOT_TYPE",
2219                                       "TEST: is not type ($1 is)\n". $herecurr);
2220                         }
2221                         next;
2222                 }
2223 # TEST: allow direct testing of the attribute matcher.
2224                 if ($dbg_attr) {
2225                         if ($line =~ /^.\s*$Modifier\s*$/) {
2226                                 ERROR("TEST_ATTR",
2227                                       "TEST: is attr\n" . $herecurr);
2228                         } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2229                                 ERROR("TEST_NOT_ATTR",
2230                                       "TEST: is not attr ($1 is)\n". $herecurr);
2231                         }
2232                         next;
2233                 }
2234
2235 # check for initialisation to aggregates open brace on the next line
2236                 if ($line =~ /^.\s*{/ &&
2237                     $prevline =~ /(?:^|[^=])=\s*$/) {
2238                         ERROR("OPEN_BRACE",
2239                               "that open brace { should be on the previous line\n" . $hereprev);
2240                 }
2241
2242 #
2243 # Checks which are anchored on the added line.
2244 #
2245
2246 # check for malformed paths in #include statements (uses RAW line)
2247                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2248                         my $path = $1;
2249                         if ($path =~ m{//}) {
2250                                 ERROR("MALFORMED_INCLUDE",
2251                                       "malformed #include filename\n" .
2252                                         $herecurr);
2253                         }
2254                 }
2255
2256 # no C99 // comments
2257                 if ($line =~ m{//}) {
2258                         ERROR("C99_COMMENTS",
2259                               "do not use C99 // comments\n" . $herecurr);
2260                 }
2261                 # Remove C99 comments.
2262                 $line =~ s@//.*@@;
2263                 $opline =~ s@//.*@@;
2264
2265 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2266 # the whole statement.
2267 #print "APW <$lines[$realline_next - 1]>\n";
2268                 if (defined $realline_next &&
2269                     exists $lines[$realline_next - 1] &&
2270                     !defined $suppress_export{$realline_next} &&
2271                     ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2272                      $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2273                         # Handle definitions which produce identifiers with
2274                         # a prefix:
2275                         #   XXX(foo);
2276                         #   EXPORT_SYMBOL(something_foo);
2277                         my $name = $1;
2278                         if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2279                             $name =~ /^${Ident}_$2/) {
2280 #print "FOO C name<$name>\n";
2281                                 $suppress_export{$realline_next} = 1;
2282
2283                         } elsif ($stat !~ /(?:
2284                                 \n.}\s*$|
2285                                 ^.DEFINE_$Ident\(\Q$name\E\)|
2286                                 ^.DECLARE_$Ident\(\Q$name\E\)|
2287                                 ^.LIST_HEAD\(\Q$name\E\)|
2288                                 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2289                                 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2290                             )/x) {
2291 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2292                                 $suppress_export{$realline_next} = 2;
2293                         } else {
2294                                 $suppress_export{$realline_next} = 1;
2295                         }
2296                 }
2297                 if (!defined $suppress_export{$linenr} &&
2298                     $prevline =~ /^.\s*$/ &&
2299                     ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2300                      $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2301 #print "FOO B <$lines[$linenr - 1]>\n";
2302                         $suppress_export{$linenr} = 2;
2303                 }
2304                 if (defined $suppress_export{$linenr} &&
2305                     $suppress_export{$linenr} == 2) {
2306                         WARN("EXPORT_SYMBOL",
2307                              "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2308                 }
2309
2310 # check for global initialisers.
2311                 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2312                         ERROR("GLOBAL_INITIALISERS",
2313                               "do not initialise globals to 0 or NULL\n" .
2314                                 $herecurr);
2315                 }
2316 # check for static initialisers.
2317                 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2318                         ERROR("INITIALISED_STATIC",
2319                               "do not initialise statics to 0 or NULL\n" .
2320                                 $herecurr);
2321                 }
2322
2323 # check for static const char * arrays.
2324                 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2325                         WARN("STATIC_CONST_CHAR_ARRAY",
2326                              "static const char * array should probably be static const char * const\n" .
2327                                 $herecurr);
2328                }
2329
2330 # check for static char foo[] = "bar" declarations.
2331                 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2332                         WARN("STATIC_CONST_CHAR_ARRAY",
2333                              "static char array declaration should probably be static const char\n" .
2334                                 $herecurr);
2335                }
2336
2337 # check for declarations of struct pci_device_id
2338                 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2339                         WARN("DEFINE_PCI_DEVICE_TABLE",
2340                              "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2341                 }
2342
2343 # check for new typedefs, only function parameters and sparse annotations
2344 # make sense.
2345                 if ($line =~ /\btypedef\s/ &&
2346                     $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2347                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2348                     $line !~ /\b$typeTypedefs\b/ &&
2349                     $line !~ /\b__bitwise(?:__|)\b/) {
2350                         WARN("NEW_TYPEDEFS",
2351                              "do not add new typedefs\n" . $herecurr);
2352                 }
2353
2354 # * goes on variable not on type
2355                 # (char*[ const])
2356                 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2357                         #print "AA<$1>\n";
2358                         my ($from, $to) = ($2, $2);
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
2368                         #print "from<$from> to<$to>\n";
2369                         if ($from ne $to) {
2370                                 ERROR("POINTER_LOCATION",
2371                                       "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2372                         }
2373                 }
2374                 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2375                         #print "BB<$1>\n";
2376                         my ($from, $to, $ident) = ($2, $2, $3);
2377
2378                         # Should start with a space.
2379                         $to =~ s/^(\S)/ $1/;
2380                         # Should not end with a space.
2381                         $to =~ s/\s+$//;
2382                         # '*'s should not have spaces between.
2383                         while ($to =~ s/\*\s+\*/\*\*/) {
2384                         }
2385                         # Modifiers should have spaces.
2386                         $to =~ s/(\b$Modifier$)/$1 /;
2387
2388                         #print "from<$from> to<$to> ident<$ident>\n";
2389                         if ($from ne $to && $ident !~ /^$Modifier$/) {
2390                                 ERROR("POINTER_LOCATION",
2391                                       "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2392                         }
2393                 }
2394
2395 # # no BUG() or BUG_ON()
2396 #               if ($line =~ /\b(BUG|BUG_ON)\b/) {
2397 #                       print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2398 #                       print "$herecurr";
2399 #                       $clean = 0;
2400 #               }
2401
2402                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2403                         WARN("LINUX_VERSION_CODE",
2404                              "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2405                 }
2406
2407 # check for uses of printk_ratelimit
2408                 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2409                         WARN("PRINTK_RATELIMITED",
2410 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2411                 }
2412
2413 # printk should use KERN_* levels.  Note that follow on printk's on the
2414 # same line do not need a level, so we use the current block context
2415 # to try and find and validate the current printk.  In summary the current
2416 # printk includes all preceding printk's which have no newline on the end.
2417 # we assume the first bad printk is the one to report.
2418                 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2419                         my $ok = 0;
2420                         for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2421                                 #print "CHECK<$lines[$ln - 1]\n";
2422                                 # we have a preceding printk if it ends
2423                                 # with "\n" ignore it, else it is to blame
2424                                 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2425                                         if ($rawlines[$ln - 1] !~ m{\\n"}) {
2426                                                 $ok = 1;
2427                                         }
2428                                         last;
2429                                 }
2430                         }
2431                         if ($ok == 0) {
2432                                 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2433                                      "printk() should include KERN_ facility level\n" . $herecurr);
2434                         }
2435                 }
2436
2437 # function brace can't be on same line, except for #defines of do while,
2438 # or if closed on same line
2439                 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2440                     !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2441                         ERROR("OPEN_BRACE",
2442                               "open brace '{' following function declarations go on the next line\n" . $herecurr);
2443                 }
2444
2445 # open braces for enum, union and struct go on the same line.
2446                 if ($line =~ /^.\s*{/ &&
2447                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2448                         ERROR("OPEN_BRACE",
2449                               "open brace '{' following $1 go on the same line\n" . $hereprev);
2450                 }
2451
2452 # missing space after union, struct or enum definition
2453                 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2454                     WARN("SPACING",
2455                          "missing space after $1 definition\n" . $herecurr);
2456                 }
2457
2458 # check for spacing round square brackets; allowed:
2459 #  1. with a type on the left -- int [] a;
2460 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2461 #  3. inside a curly brace -- = { [0...10] = 5 }
2462                 while ($line =~ /(.*?\s)\[/g) {
2463                         my ($where, $prefix) = ($-[1], $1);
2464                         if ($prefix !~ /$Type\s+$/ &&
2465                             ($where != 0 || $prefix !~ /^.\s+$/) &&
2466                             $prefix !~ /{\s+$/) {
2467                                 ERROR("BRACKET_SPACE",
2468                                       "space prohibited before open square bracket '['\n" . $herecurr);
2469                         }
2470                 }
2471
2472 # check for spaces between functions and their parentheses.
2473                 while ($line =~ /($Ident)\s+\(/g) {
2474                         my $name = $1;
2475                         my $ctx_before = substr($line, 0, $-[1]);
2476                         my $ctx = "$ctx_before$name";
2477
2478                         # Ignore those directives where spaces _are_ permitted.
2479                         if ($name =~ /^(?:
2480                                 if|for|while|switch|return|case|
2481                                 volatile|__volatile__|
2482                                 __attribute__|format|__extension__|
2483                                 asm|__asm__)$/x)
2484                         {
2485
2486                         # cpp #define statements have non-optional spaces, ie
2487                         # if there is a space between the name and the open
2488                         # parenthesis it is simply not a parameter group.
2489                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2490
2491                         # cpp #elif statement condition may start with a (
2492                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2493
2494                         # If this whole things ends with a type its most
2495                         # likely a typedef for a function.
2496                         } elsif ($ctx =~ /$Type$/) {
2497
2498                         } else {
2499                                 WARN("SPACING",
2500                                      "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2501                         }
2502                 }
2503 # Check operator spacing.
2504                 if (!($line=~/\#\s*include/)) {
2505                         my $ops = qr{
2506                                 <<=|>>=|<=|>=|==|!=|
2507                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2508                                 =>|->|<<|>>|<|>|=|!|~|
2509                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2510                                 \?|:
2511                         }x;
2512                         my @elements = split(/($ops|;)/, $opline);
2513                         my $off = 0;
2514
2515                         my $blank = copy_spacing($opline);
2516
2517                         for (my $n = 0; $n < $#elements; $n += 2) {
2518                                 $off += length($elements[$n]);
2519
2520                                 # Pick up the preceding and succeeding characters.
2521                                 my $ca = substr($opline, 0, $off);
2522                                 my $cc = '';
2523                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2524                                         $cc = substr($opline, $off + length($elements[$n + 1]));
2525                                 }
2526                                 my $cb = "$ca$;$cc";
2527
2528                                 my $a = '';
2529                                 $a = 'V' if ($elements[$n] ne '');
2530                                 $a = 'W' if ($elements[$n] =~ /\s$/);
2531                                 $a = 'C' if ($elements[$n] =~ /$;$/);
2532                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2533                                 $a = 'O' if ($elements[$n] eq '');
2534                                 $a = 'E' if ($ca =~ /^\s*$/);
2535
2536                                 my $op = $elements[$n + 1];
2537
2538                                 my $c = '';
2539                                 if (defined $elements[$n + 2]) {
2540                                         $c = 'V' if ($elements[$n + 2] ne '');
2541                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2542                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2543                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2544                                         $c = 'O' if ($elements[$n + 2] eq '');
2545                                         $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2546                                 } else {
2547                                         $c = 'E';
2548                                 }
2549
2550                                 my $ctx = "${a}x${c}";
2551
2552                                 my $at = "(ctx:$ctx)";
2553
2554                                 my $ptr = substr($blank, 0, $off) . "^";
2555                                 my $hereptr = "$hereline$ptr\n";
2556
2557                                 # Pull out the value of this operator.
2558                                 my $op_type = substr($curr_values, $off + 1, 1);
2559
2560                                 # Get the full operator variant.
2561                                 my $opv = $op . substr($curr_vars, $off, 1);
2562
2563                                 # Ignore operators passed as parameters.
2564                                 if ($op_type ne 'V' &&
2565                                     $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2566
2567 #                               # Ignore comments
2568 #                               } elsif ($op =~ /^$;+$/) {
2569
2570                                 # ; should have either the end of line or a space or \ after it
2571                                 } elsif ($op eq ';') {
2572                                         if ($ctx !~ /.x[WEBC]/ &&
2573                                             $cc !~ /^\\/ && $cc !~ /^;/) {
2574                                                 ERROR("SPACING",
2575                                                       "space required after that '$op' $at\n" . $hereptr);
2576                                         }
2577
2578                                 # // is a comment
2579                                 } elsif ($op eq '//') {
2580
2581                                 # No spaces for:
2582                                 #   ->
2583                                 #   :   when part of a bitfield
2584                                 } elsif ($op eq '->' || $opv eq ':B') {
2585                                         if ($ctx =~ /Wx.|.xW/) {
2586                                                 ERROR("SPACING",
2587                                                       "spaces prohibited around that '$op' $at\n" . $hereptr);
2588                                         }
2589
2590                                 # , must have a space on the right.
2591                                 } elsif ($op eq ',') {
2592                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2593                                                 ERROR("SPACING",
2594                                                       "space required after that '$op' $at\n" . $hereptr);
2595                                         }
2596
2597                                 # '*' as part of a type definition -- reported already.
2598                                 } elsif ($opv eq '*_') {
2599                                         #warn "'*' is part of type\n";
2600
2601                                 # unary operators should have a space before and
2602                                 # none after.  May be left adjacent to another
2603                                 # unary operator, or a cast
2604                                 } elsif ($op eq '!' || $op eq '~' ||
2605                                          $opv eq '*U' || $opv eq '-U' ||
2606                                          $opv eq '&U' || $opv eq '&&U') {
2607                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2608                                                 ERROR("SPACING",
2609                                                       "space required before that '$op' $at\n" . $hereptr);
2610                                         }
2611                                         if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2612                                                 # A unary '*' may be const
2613
2614                                         } elsif ($ctx =~ /.xW/) {
2615                                                 ERROR("SPACING",
2616                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2617                                         }
2618
2619                                 # unary ++ and unary -- are allowed no space on one side.
2620                                 } elsif ($op eq '++' or $op eq '--') {
2621                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2622                                                 ERROR("SPACING",
2623                                                       "space required one side of that '$op' $at\n" . $hereptr);
2624                                         }
2625                                         if ($ctx =~ /Wx[BE]/ ||
2626                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2627                                                 ERROR("SPACING",
2628                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2629                                         }
2630                                         if ($ctx =~ /ExW/) {
2631                                                 ERROR("SPACING",
2632                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2633                                         }
2634
2635
2636                                 # << and >> may either have or not have spaces both sides
2637                                 } elsif ($op eq '<<' or $op eq '>>' or
2638                                          $op eq '&' or $op eq '^' or $op eq '|' or
2639                                          $op eq '+' or $op eq '-' or
2640                                          $op eq '*' or $op eq '/' or
2641                                          $op eq '%')
2642                                 {
2643                                         if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2644                                                 ERROR("SPACING",
2645                                                       "need consistent spacing around '$op' $at\n" .
2646                                                         $hereptr);
2647                                         }
2648
2649                                 # A colon needs no spaces before when it is
2650                                 # terminating a case value or a label.
2651                                 } elsif ($opv eq ':C' || $opv eq ':L') {
2652                                         if ($ctx =~ /Wx./) {
2653                                                 ERROR("SPACING",
2654                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2655                                         }
2656
2657                                 # All the others need spaces both sides.
2658                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2659                                         my $ok = 0;
2660
2661                                         # Ignore email addresses <foo@bar>
2662                                         if (($op eq '<' &&
2663                                              $cc =~ /^\S+\@\S+>/) ||
2664                                             ($op eq '>' &&
2665                                              $ca =~ /<\S+\@\S+$/))
2666                                         {
2667                                                 $ok = 1;
2668                                         }
2669
2670                                         # Ignore ?:
2671                                         if (($opv eq ':O' && $ca =~ /\?$/) ||
2672                                             ($op eq '?' && $cc =~ /^:/)) {
2673                                                 $ok = 1;
2674                                         }
2675
2676                                         if ($ok == 0) {
2677                                                 ERROR("SPACING",
2678                                                       "spaces required around that '$op' $at\n" . $hereptr);
2679                                         }
2680                                 }
2681                                 $off += length($elements[$n + 1]);
2682                         }
2683                 }
2684
2685 # check for multiple assignments
2686                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2687                         CHK("MULTIPLE_ASSIGNMENTS",
2688                             "multiple assignments should be avoided\n" . $herecurr);
2689                 }
2690
2691 ## # check for multiple declarations, allowing for a function declaration
2692 ## # continuation.
2693 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2694 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2695 ##
2696 ##                      # Remove any bracketed sections to ensure we do not
2697 ##                      # falsly report the parameters of functions.
2698 ##                      my $ln = $line;
2699 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
2700 ##                      }
2701 ##                      if ($ln =~ /,/) {
2702 ##                              WARN("MULTIPLE_DECLARATION",
2703 ##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
2704 ##                      }
2705 ##              }
2706
2707 #need space before brace following if, while, etc
2708                 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2709                     $line =~ /do{/) {
2710                         ERROR("SPACING",
2711                               "space required before the open brace '{'\n" . $herecurr);
2712                 }
2713
2714 # closing brace should have a space following it when it has anything
2715 # on the line
2716                 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2717                         ERROR("SPACING",
2718                               "space required after that close brace '}'\n" . $herecurr);
2719                 }
2720
2721 # check spacing on square brackets
2722                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2723                         ERROR("SPACING",
2724                               "space prohibited after that open square bracket '['\n" . $herecurr);
2725                 }
2726                 if ($line =~ /\s\]/) {
2727                         ERROR("SPACING",
2728                               "space prohibited before that close square bracket ']'\n" . $herecurr);
2729                 }
2730
2731 # check spacing on parentheses
2732                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2733                     $line !~ /for\s*\(\s+;/) {
2734                         ERROR("SPACING",
2735                               "space prohibited after that open parenthesis '('\n" . $herecurr);
2736                 }
2737                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2738                     $line !~ /for\s*\(.*;\s+\)/ &&
2739                     $line !~ /:\s+\)/) {
2740                         ERROR("SPACING",
2741                               "space prohibited before that close parenthesis ')'\n" . $herecurr);
2742                 }
2743
2744 #goto labels aren't indented, allow a single space however
2745                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2746                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2747                         WARN("INDENTED_LABEL",
2748                              "labels should not be indented\n" . $herecurr);
2749                 }
2750
2751 # Return is not a function.
2752                 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2753                         my $spacing = $1;
2754                         my $value = $2;
2755
2756                         # Flatten any parentheses
2757                         $value =~ s/\(/ \(/g;
2758                         $value =~ s/\)/\) /g;
2759                         while ($value =~ s/\[[^\[\]]*\]/1/ ||
2760                                $value !~ /(?:$Ident|-?$Constant)\s*
2761                                              $Compare\s*
2762                                              (?:$Ident|-?$Constant)/x &&
2763                                $value =~ s/\([^\(\)]*\)/1/) {
2764                         }
2765 #print "value<$value>\n";
2766                         if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2767                                 ERROR("RETURN_PARENTHESES",
2768                                       "return is not a function, parentheses are not required\n" . $herecurr);
2769
2770                         } elsif ($spacing !~ /\s+/) {
2771                                 ERROR("SPACING",
2772                                       "space required before the open parenthesis '('\n" . $herecurr);
2773                         }
2774                 }
2775 # Return of what appears to be an errno should normally be -'ve
2776                 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2777                         my $name = $1;
2778                         if ($name ne 'EOF' && $name ne 'ERROR') {
2779                                 WARN("USE_NEGATIVE_ERRNO",
2780                                      "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2781                         }
2782                 }
2783
2784 # Need a space before open parenthesis after if, while etc
2785                 if ($line=~/\b(if|while|for|switch)\(/) {
2786                         ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2787                 }
2788
2789 # Check for illegal assignment in if conditional -- and check for trailing
2790 # statements after the conditional.
2791                 if ($line =~ /do\s*(?!{)/) {
2792                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2793                                 ctx_statement_block($linenr, $realcnt, 0)
2794                                         if (!defined $stat);
2795                         my ($stat_next) = ctx_statement_block($line_nr_next,
2796                                                 $remain_next, $off_next);
2797                         $stat_next =~ s/\n./\n /g;
2798                         ##print "stat<$stat> stat_next<$stat_next>\n";
2799
2800                         if ($stat_next =~ /^\s*while\b/) {
2801                                 # If the statement carries leading newlines,
2802                                 # then count those as offsets.
2803                                 my ($whitespace) =
2804                                         ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2805                                 my $offset =
2806                                         statement_rawlines($whitespace) - 1;
2807
2808                                 $suppress_whiletrailers{$line_nr_next +
2809                                                                 $offset} = 1;
2810                         }
2811                 }
2812                 if (!defined $suppress_whiletrailers{$linenr} &&
2813                     $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2814                         my ($s, $c) = ($stat, $cond);
2815
2816                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2817                                 ERROR("ASSIGN_IN_IF",
2818                                       "do not use assignment in if condition\n" . $herecurr);
2819                         }
2820
2821                         # Find out what is on the end of the line after the
2822                         # conditional.
2823                         substr($s, 0, length($c), '');
2824                         $s =~ s/\n.*//g;
2825                         $s =~ s/$;//g;  # Remove any comments
2826                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2827                             $c !~ /}\s*while\s*/)
2828                         {
2829                                 # Find out how long the conditional actually is.
2830                                 my @newlines = ($c =~ /\n/gs);
2831                                 my $cond_lines = 1 + $#newlines;
2832                                 my $stat_real = '';
2833
2834                                 $stat_real = raw_line($linenr, $cond_lines)
2835                                                         . "\n" if ($cond_lines);
2836                                 if (defined($stat_real) && $cond_lines > 1) {
2837                                         $stat_real = "[...]\n$stat_real";
2838                                 }
2839
2840                                 ERROR("TRAILING_STATEMENTS",
2841                                       "trailing statements should be on next line\n" . $herecurr . $stat_real);
2842                         }
2843                 }
2844
2845 # Check for bitwise tests written as boolean
2846                 if ($line =~ /
2847                         (?:
2848                                 (?:\[|\(|\&\&|\|\|)
2849                                 \s*0[xX][0-9]+\s*
2850                                 (?:\&\&|\|\|)
2851                         |
2852                                 (?:\&\&|\|\|)
2853                                 \s*0[xX][0-9]+\s*
2854                                 (?:\&\&|\|\||\)|\])
2855                         )/x)
2856                 {
2857                         WARN("HEXADECIMAL_BOOLEAN_TEST",
2858                              "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2859                 }
2860
2861 # if and else should not have general statements after it
2862                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2863                         my $s = $1;
2864                         $s =~ s/$;//g;  # Remove any comments
2865                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2866                                 ERROR("TRAILING_STATEMENTS",
2867                                       "trailing statements should be on next line\n" . $herecurr);
2868                         }
2869                 }
2870 # if should not continue a brace
2871                 if ($line =~ /}\s*if\b/) {
2872                         ERROR("TRAILING_STATEMENTS",
2873                               "trailing statements should be o