blob: 8fda3b3f7be87c01958c80823aea23cc22c790bf [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
Joe Perches000d1cc2011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Joe Perches000d1cc2011-07-25 17:13:25 -070029my $show_types = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080031my %debug;
Joe Perches000d1cc2011-07-25 17:13:25 -070032my %ignore_type = ();
33my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070034my $help = 0;
Joe Perches000d1cc2011-07-25 17:13:25 -070035my $configuration_file = ".checkpatch.conf";
Hannes Eder77f5b102009-09-21 17:04:37 -070036
37sub help {
38 my ($exitcode) = @_;
39
40 print << "EOM";
41Usage: $P [OPTION]... [FILE]...
42Version: $V
43
44Options:
45 -q, --quiet quiet
46 --no-tree run without a kernel tree
47 --no-signoff do not check for 'Signed-off-by' line
48 --patch treat FILE as patchfile (default)
49 --emacs emacs compile window format
50 --terse one line per report
51 -f, --file treat FILE as regular source file
52 --subjective, --strict enable more subjective tests
Joe Perches000d1cc2011-07-25 17:13:25 -070053 --ignore TYPE(,TYPE2...) ignore various comma separated message types
54 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070055 --root=PATH PATH to the kernel tree root
56 --no-summary suppress the per-file summary
57 --mailback only produce a report in case of warnings/errors
58 --summary-file include the filename in summary
59 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
60 'values', 'possible', 'type', and 'attr' (default
61 is all off)
62 --test-only=WORD report only warnings/errors containing WORD
63 literally
64 -h, --help, --version display this help and exit
65
66When FILE is - read standard input.
67EOM
68
69 exit($exitcode);
70}
71
Joe Perches000d1cc2011-07-25 17:13:25 -070072my $conf = which_conf($configuration_file);
73if (-f $conf) {
74 my @conf_args;
75 open(my $conffile, '<', "$conf")
76 or warn "$P: Can't find a readable $configuration_file file $!\n";
77
78 while (<$conffile>) {
79 my $line = $_;
80
81 $line =~ s/\s*\n?$//g;
82 $line =~ s/^\s*//g;
83 $line =~ s/\s+/ /g;
84
85 next if ($line =~ m/^\s*#/);
86 next if ($line =~ m/^\s*$/);
87
88 my @words = split(" ", $line);
89 foreach my $word (@words) {
90 last if ($word =~ m/^#/);
91 push (@conf_args, $word);
92 }
93 }
94 close($conffile);
95 unshift(@ARGV, @conf_args) if @conf_args;
96}
97
Andy Whitcroft0a920b52007-06-01 00:46:48 -070098GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700100 'tree!' => \$tree,
101 'signoff!' => \$chk_signoff,
102 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700103 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800104 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700105 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700106 'subjective!' => \$check,
107 'strict!' => \$check,
Joe Perches000d1cc2011-07-25 17:13:25 -0700108 'ignore=s' => \@ignore,
109 'show-types!' => \$show_types,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700110 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800111 'summary!' => \$summary,
112 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800113 'summary-file!' => \$summary_file,
114
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800115 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700116 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700117 'h|help' => \$help,
118 'version' => \$help
119) or help(1);
120
121help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700122
123my $exit = 0;
124
125if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700126 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700127 exit(1);
128}
129
Joe Perches000d1cc2011-07-25 17:13:25 -0700130@ignore = split(/,/, join(',',@ignore));
131foreach my $word (@ignore) {
132 $word =~ s/\s*\n?$//g;
133 $word =~ s/^\s*//g;
134 $word =~ s/\s+/ /g;
135 $word =~ tr/[a-z]/[A-Z]/;
136
137 next if ($word =~ m/^\s*#/);
138 next if ($word =~ m/^\s*$/);
139
140 $ignore_type{$word}++;
141}
142
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800143my $dbg_values = 0;
144my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700145my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700146my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800147for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800148 ## no critic
149 eval "\${dbg_$key} = '$debug{$key}';";
150 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800151}
152
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700153my $rpt_cleaners = 0;
154
Andy Whitcroft8905a672007-11-28 16:21:06 -0800155if ($terse) {
156 $emacs = 1;
157 $quiet++;
158}
159
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700160if ($tree) {
161 if (defined $root) {
162 if (!top_of_kernel_tree($root)) {
163 die "$P: $root: --root does not point at a valid tree\n";
164 }
165 } else {
166 if (top_of_kernel_tree('.')) {
167 $root = '.';
168 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
169 top_of_kernel_tree($1)) {
170 $root = $1;
171 }
172 }
173
174 if (!defined $root) {
175 print "Must be run from the top-level dir. of a kernel tree\n";
176 exit(2);
177 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700178}
179
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700180my $emitted_corrupt = 0;
181
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700182our $Ident = qr{
183 [A-Za-z_][A-Za-z\d_]*
184 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
185 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700186our $Storage = qr{extern|static|asmlinkage};
187our $Sparse = qr{
188 __user|
189 __kernel|
190 __force|
191 __iomem|
192 __must_check|
193 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800194 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700195 __ref|
196 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700197 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800198
199# Notes to $Attribute:
200# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700201our $Attribute = qr{
202 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700203 __percpu|
204 __nocast|
205 __safe|
206 __bitwise__|
207 __packed__|
208 __packed2__|
209 __naked|
210 __maybe_unused|
211 __always_unused|
212 __noreturn|
213 __used|
214 __cold|
215 __noclone|
216 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700217 __read_mostly|
218 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800219 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700220 ____cacheline_aligned|
221 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800222 ____cacheline_internodealigned_in_smp|
223 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700224 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700225our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700227our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
228our $Lval = qr{$Ident(?:$Member)*};
229
230our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
231our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800232our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233our $Operators = qr{
234 <=|>=|==|!=|
235 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800236 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700237 }x;
238
Andy Whitcroft8905a672007-11-28 16:21:06 -0800239our $NonptrType;
240our $Type;
241our $Declare;
242
Joe Perches15662b32011-10-31 17:13:12 -0700243our $NON_ASCII_UTF8 = qr{
244 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700245 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
246 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
247 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
248 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
249 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
250 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
251}x;
252
Joe Perches15662b32011-10-31 17:13:12 -0700253our $UTF8 = qr{
254 [\x09\x0A\x0D\x20-\x7E] # ASCII
255 | $NON_ASCII_UTF8
256}x;
257
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700258our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700259 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700260 atomic_t
261)};
262
Joe Perches691e6692010-03-05 13:43:51 -0800263our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700264 printk(?:_ratelimited|_once|)|
265 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
266 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700267 panic|
268 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800269)};
270
Joe Perches20112472011-07-25 17:13:23 -0700271our $signature_tags = qr{(?xi:
272 Signed-off-by:|
273 Acked-by:|
274 Tested-by:|
275 Reviewed-by:|
276 Reported-by:|
277 To:|
278 Cc:
279)};
280
Andy Whitcroft8905a672007-11-28 16:21:06 -0800281our @typeList = (
282 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700283 qr{(?:unsigned\s+)?char},
284 qr{(?:unsigned\s+)?short},
285 qr{(?:unsigned\s+)?int},
286 qr{(?:unsigned\s+)?long},
287 qr{(?:unsigned\s+)?long\s+int},
288 qr{(?:unsigned\s+)?long\s+long},
289 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800290 qr{unsigned},
291 qr{float},
292 qr{double},
293 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800294 qr{struct\s+$Ident},
295 qr{union\s+$Ident},
296 qr{enum\s+$Ident},
297 qr{${Ident}_t},
298 qr{${Ident}_handler},
299 qr{${Ident}_handler_fn},
300);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700301our @modifierList = (
302 qr{fastcall},
303);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800304
Wolfram Sang7840a942010-08-09 17:20:57 -0700305our $allowed_asm_includes = qr{(?x:
306 irq|
307 memory
308)};
309# memory.h: ARM has a custom one
310
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700312 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
313 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700314 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800315 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700316 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800317 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700318 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700319 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700320 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800321 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700322 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800323 }x;
324 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700325 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800326 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700327 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800328 }x;
329 $Declare = qr{(?:$Storage\s+)?$Type};
330}
331build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700332
Joe Perches7d2367a2011-07-25 17:13:22 -0700333our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
334
335our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
336our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
337
338sub deparenthesize {
339 my ($string) = @_;
340 return "" if (!defined($string));
341 $string =~ s@^\s*\(\s*@@g;
342 $string =~ s@\s*\)\s*$@@g;
343 $string =~ s@\s+@ @g;
344 return $string;
345}
346
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700347$chk_signoff = 0 if ($file);
348
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700349my @dep_includes = ();
350my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700351my $removal = "Documentation/feature-removal-schedule.txt";
352if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800353 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700354 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800355 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700356 if (/^Check:\s+(.*\S)/) {
357 for my $entry (split(/[, ]+/, $1)) {
358 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700359 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700360
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700361 } elsif ($entry !~ m@/@) {
362 push(@dep_functions, $entry);
363 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700364 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700365 }
366 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800367 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700368}
369
Andy Whitcroft00df3442007-06-08 13:47:06 -0700370my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800371my @lines = ();
372my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700373for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800374 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700375 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800376 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700377 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800378 } elsif ($filename eq '-') {
379 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700380 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800381 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700382 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700383 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800384 if ($filename eq '-') {
385 $vname = 'Your patch';
386 } else {
387 $vname = $filename;
388 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800389 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700390 chomp;
391 push(@rawlines, $_);
392 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800393 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800394 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700395 $exit = 1;
396 }
397 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800398 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700399}
400
401exit($exit);
402
403sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700404 my ($root) = @_;
405
406 my @tree_check = (
407 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
408 "README", "Documentation", "arch", "include", "drivers",
409 "fs", "init", "ipc", "kernel", "lib", "scripts",
410 );
411
412 foreach my $check (@tree_check) {
413 if (! -e $root . '/' . $check) {
414 return 0;
415 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700416 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700417 return 1;
Joe Perches000d1cc2011-07-25 17:13:25 -0700418 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700419
Joe Perches20112472011-07-25 17:13:23 -0700420sub parse_email {
421 my ($formatted_email) = @_;
422
423 my $name = "";
424 my $address = "";
425 my $comment = "";
426
427 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
428 $name = $1;
429 $address = $2;
430 $comment = $3 if defined $3;
431 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
432 $address = $1;
433 $comment = $2 if defined $2;
434 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
435 $address = $1;
436 $comment = $2 if defined $2;
437 $formatted_email =~ s/$address.*$//;
438 $name = $formatted_email;
439 $name =~ s/^\s+|\s+$//g;
440 $name =~ s/^\"|\"$//g;
441 # If there's a name left after stripping spaces and
442 # leading quotes, and the address doesn't have both
443 # leading and trailing angle brackets, the address
444 # is invalid. ie:
445 # "joe smith joe@smith.com" bad
446 # "joe smith <joe@smith.com" bad
447 if ($name ne "" && $address !~ /^<[^>]+>$/) {
448 $name = "";
449 $address = "";
450 $comment = "";
451 }
452 }
453
454 $name =~ s/^\s+|\s+$//g;
455 $name =~ s/^\"|\"$//g;
456 $address =~ s/^\s+|\s+$//g;
457 $address =~ s/^\<|\>$//g;
458
459 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
460 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
461 $name = "\"$name\"";
462 }
463
464 return ($name, $address, $comment);
465}
466
467sub format_email {
468 my ($name, $address) = @_;
469
470 my $formatted_email;
471
472 $name =~ s/^\s+|\s+$//g;
473 $name =~ s/^\"|\"$//g;
474 $address =~ s/^\s+|\s+$//g;
475
476 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
477 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
478 $name = "\"$name\"";
479 }
480
481 if ("$name" eq "") {
482 $formatted_email = "$address";
483 } else {
484 $formatted_email = "$name <$address>";
485 }
486
487 return $formatted_email;
488}
489
Joe Perches000d1cc2011-07-25 17:13:25 -0700490sub which_conf {
491 my ($conf) = @_;
492
493 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
494 if (-e "$path/$conf") {
495 return "$path/$conf";
496 }
497 }
498
499 return "";
500}
501
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700502sub expand_tabs {
503 my ($str) = @_;
504
505 my $res = '';
506 my $n = 0;
507 for my $c (split(//, $str)) {
508 if ($c eq "\t") {
509 $res .= ' ';
510 $n++;
511 for (; ($n % 8) != 0; $n++) {
512 $res .= ' ';
513 }
514 next;
515 }
516 $res .= $c;
517 $n++;
518 }
519
520 return $res;
521}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700522sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700523 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700524 return $res;
525}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700526
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700527sub line_stats {
528 my ($line) = @_;
529
530 # Drop the diff line leader and expand tabs
531 $line =~ s/^.//;
532 $line = expand_tabs($line);
533
534 # Pick the indent from the front of the line.
535 my ($white) = ($line =~ /^(\s*)/);
536
537 return (length($line), length($white));
538}
539
Andy Whitcroft773647a2008-03-28 14:15:58 -0700540my $sanitise_quote = '';
541
542sub sanitise_line_reset {
543 my ($in_comment) = @_;
544
545 if ($in_comment) {
546 $sanitise_quote = '*/';
547 } else {
548 $sanitise_quote = '';
549 }
550}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700551sub sanitise_line {
552 my ($line) = @_;
553
554 my $res = '';
555 my $l = '';
556
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800557 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700558 my $off = 0;
559 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700560
Andy Whitcroft773647a2008-03-28 14:15:58 -0700561 # Always copy over the diff marker.
562 $res = substr($line, 0, 1);
563
564 for ($off = 1; $off < length($line); $off++) {
565 $c = substr($line, $off, 1);
566
567 # Comments we are wacking completly including the begin
568 # and end, all to $;.
569 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
570 $sanitise_quote = '*/';
571
572 substr($res, $off, 2, "$;$;");
573 $off++;
574 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800575 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700576 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700577 $sanitise_quote = '';
578 substr($res, $off, 2, "$;$;");
579 $off++;
580 next;
581 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700582 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
583 $sanitise_quote = '//';
584
585 substr($res, $off, 2, $sanitise_quote);
586 $off++;
587 next;
588 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700589
590 # A \ in a string means ignore the next character.
591 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
592 $c eq "\\") {
593 substr($res, $off, 2, 'XX');
594 $off++;
595 next;
596 }
597 # Regular quotes.
598 if ($c eq "'" || $c eq '"') {
599 if ($sanitise_quote eq '') {
600 $sanitise_quote = $c;
601
602 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700603 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700604 } elsif ($sanitise_quote eq $c) {
605 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700606 }
607 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700608
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800609 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700610 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
611 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700612 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
613 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700614 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
615 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700616 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700617 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700618 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800619 }
620
Daniel Walker113f04a2009-09-21 17:04:35 -0700621 if ($sanitise_quote eq '//') {
622 $sanitise_quote = '';
623 }
624
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800625 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700626 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800627 my $clean = 'X' x length($1);
628 $res =~ s@\<.*\>@<$clean>@;
629
630 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700631 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800632 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700633 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800634 }
635
Andy Whitcroft00df3442007-06-08 13:47:06 -0700636 return $res;
637}
638
Andy Whitcroft8905a672007-11-28 16:21:06 -0800639sub ctx_statement_block {
640 my ($linenr, $remain, $off) = @_;
641 my $line = $linenr - 1;
642 my $blk = '';
643 my $soff = $off;
644 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700645 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800646
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800647 my $loff = 0;
648
Andy Whitcroft8905a672007-11-28 16:21:06 -0800649 my $type = '';
650 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800651 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800652 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800653 my $c;
654 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800655
656 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800657 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800658 @stack = (['', 0]) if ($#stack == -1);
659
Andy Whitcroft773647a2008-03-28 14:15:58 -0700660 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800661 # If we are about to drop off the end, pull in more
662 # context.
663 if ($off >= $len) {
664 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700665 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800666 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800667 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800668 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800669 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800670 $len = length($blk);
671 $line++;
672 last;
673 }
674 # Bail if there is no further context.
675 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800676 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800677 last;
678 }
679 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800680 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800681 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800682 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800683
Andy Whitcroft773647a2008-03-28 14:15:58 -0700684 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800685
686 # Handle nested #if/#else.
687 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
688 push(@stack, [ $type, $level ]);
689 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
690 ($type, $level) = @{$stack[$#stack - 1]};
691 } elsif ($remainder =~ /^#\s*endif\b/) {
692 ($type, $level) = @{pop(@stack)};
693 }
694
Andy Whitcroft8905a672007-11-28 16:21:06 -0800695 # Statement ends at the ';' or a close '}' at the
696 # outermost level.
697 if ($level == 0 && $c eq ';') {
698 last;
699 }
700
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800701 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700702 if ($level == 0 && $coff_set == 0 &&
703 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
704 $remainder =~ /^(else)(?:\s|{)/ &&
705 $remainder !~ /^else\s+if\b/) {
706 $coff = $off + length($1) - 1;
707 $coff_set = 1;
708 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
709 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800710 }
711
Andy Whitcroft8905a672007-11-28 16:21:06 -0800712 if (($type eq '' || $type eq '(') && $c eq '(') {
713 $level++;
714 $type = '(';
715 }
716 if ($type eq '(' && $c eq ')') {
717 $level--;
718 $type = ($level != 0)? '(' : '';
719
720 if ($level == 0 && $coff < $soff) {
721 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700722 $coff_set = 1;
723 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800724 }
725 }
726 if (($type eq '' || $type eq '{') && $c eq '{') {
727 $level++;
728 $type = '{';
729 }
730 if ($type eq '{' && $c eq '}') {
731 $level--;
732 $type = ($level != 0)? '{' : '';
733
734 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700735 if (substr($blk, $off + 1, 1) eq ';') {
736 $off++;
737 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800738 last;
739 }
740 }
741 $off++;
742 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700743 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800744 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700745 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800746 $line++;
747 $remain--;
748 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800749
750 my $statement = substr($blk, $soff, $off - $soff + 1);
751 my $condition = substr($blk, $soff, $coff - $soff + 1);
752
753 #warn "STATEMENT<$statement>\n";
754 #warn "CONDITION<$condition>\n";
755
Andy Whitcroft773647a2008-03-28 14:15:58 -0700756 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800757
758 return ($statement, $condition,
759 $line, $remain + 1, $off - $loff + 1, $level);
760}
761
Andy Whitcroftcf655042008-03-04 14:28:20 -0800762sub statement_lines {
763 my ($stmt) = @_;
764
765 # Strip the diff line prefixes and rip blank lines at start and end.
766 $stmt =~ s/(^|\n)./$1/g;
767 $stmt =~ s/^\s*//;
768 $stmt =~ s/\s*$//;
769
770 my @stmt_lines = ($stmt =~ /\n/g);
771
772 return $#stmt_lines + 2;
773}
774
775sub statement_rawlines {
776 my ($stmt) = @_;
777
778 my @stmt_lines = ($stmt =~ /\n/g);
779
780 return $#stmt_lines + 2;
781}
782
783sub statement_block_size {
784 my ($stmt) = @_;
785
786 $stmt =~ s/(^|\n)./$1/g;
787 $stmt =~ s/^\s*{//;
788 $stmt =~ s/}\s*$//;
789 $stmt =~ s/^\s*//;
790 $stmt =~ s/\s*$//;
791
792 my @stmt_lines = ($stmt =~ /\n/g);
793 my @stmt_statements = ($stmt =~ /;/g);
794
795 my $stmt_lines = $#stmt_lines + 2;
796 my $stmt_statements = $#stmt_statements + 1;
797
798 if ($stmt_lines > $stmt_statements) {
799 return $stmt_lines;
800 } else {
801 return $stmt_statements;
802 }
803}
804
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800805sub ctx_statement_full {
806 my ($linenr, $remain, $off) = @_;
807 my ($statement, $condition, $level);
808
809 my (@chunks);
810
Andy Whitcroftcf655042008-03-04 14:28:20 -0800811 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800812 ($statement, $condition, $linenr, $remain, $off, $level) =
813 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700814 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800815 push(@chunks, [ $condition, $statement ]);
816 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
817 return ($level, $linenr, @chunks);
818 }
819
820 # Pull in the following conditional/block pairs and see if they
821 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800822 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800823 ($statement, $condition, $linenr, $remain, $off, $level) =
824 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800825 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700826 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800827 #print "C: push\n";
828 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800829 }
830
831 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800832}
833
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700834sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700835 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700836 my $line;
837 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700838 my $blk = '';
839 my @o;
840 my @c;
841 my @res = ();
842
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700843 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800844 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700845 for ($line = $start; $remain > 0; $line++) {
846 next if ($rawlines[$line] =~ /^-/);
847 $remain--;
848
849 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800850
851 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700852 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800853 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700854 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800855 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700856 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800857 $level = pop(@stack);
858 }
859
Andy Whitcroft01464f32010-10-26 14:23:19 -0700860 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700861 ##print "C<$c>L<$level><$open$close>O<$off>\n";
862 if ($off > 0) {
863 $off--;
864 next;
865 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700866
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700867 if ($c eq $close && $level > 0) {
868 $level--;
869 last if ($level == 0);
870 } elsif ($c eq $open) {
871 $level++;
872 }
873 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700874
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700875 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700876 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700877 }
878
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700879 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700880 }
881
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700882 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700883}
884sub ctx_block_outer {
885 my ($linenr, $remain) = @_;
886
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700887 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
888 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700889}
890sub ctx_block {
891 my ($linenr, $remain) = @_;
892
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700893 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
894 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700895}
896sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700897 my ($linenr, $remain, $off) = @_;
898
899 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
900 return @r;
901}
902sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700903 my ($linenr, $remain) = @_;
904
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700905 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700906}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700907sub ctx_statement_level {
908 my ($linenr, $remain, $off) = @_;
909
910 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
911}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700912
913sub ctx_locate_comment {
914 my ($first_line, $end_line) = @_;
915
916 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700917 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700918 return $current_comment if (defined $current_comment);
919
920 # Look through the context and try and figure out if there is a
921 # comment.
922 my $in_comment = 0;
923 $current_comment = '';
924 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700925 my $line = $rawlines[$linenr - 1];
926 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700927 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
928 $in_comment = 1;
929 }
930 if ($line =~ m@/\*@) {
931 $in_comment = 1;
932 }
933 if (!$in_comment && $current_comment ne '') {
934 $current_comment = '';
935 }
936 $current_comment .= $line . "\n" if ($in_comment);
937 if ($line =~ m@\*/@) {
938 $in_comment = 0;
939 }
940 }
941
942 chomp($current_comment);
943 return($current_comment);
944}
945sub ctx_has_comment {
946 my ($first_line, $end_line) = @_;
947 my $cmt = ctx_locate_comment($first_line, $end_line);
948
Andy Whitcroft00df3442007-06-08 13:47:06 -0700949 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700950 ##print "CMMT: $cmt\n";
951
952 return ($cmt ne '');
953}
954
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700955sub raw_line {
956 my ($linenr, $cnt) = @_;
957
958 my $offset = $linenr - 1;
959 $cnt++;
960
961 my $line;
962 while ($cnt) {
963 $line = $rawlines[$offset++];
964 next if (defined($line) && $line =~ /^-/);
965 $cnt--;
966 }
967
968 return $line;
969}
970
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700971sub cat_vet {
972 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700973 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700974
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700975 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700976 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
977 $res .= $1;
978 if ($2 ne '') {
979 $coded = sprintf("^%c", unpack('C', $2) + 64);
980 $res .= $coded;
981 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700982 }
983 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700984
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700985 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700986}
987
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800988my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800989my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800990my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700991my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800992
993sub annotate_reset {
994 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800995 $av_pending = '_';
996 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700997 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800998}
999
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001000sub annotate_values {
1001 my ($stream, $type) = @_;
1002
1003 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001004 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001005 my $cur = $stream;
1006
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001007 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001008
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001009 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001010 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001011 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001012 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001013 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001014 print "WS($1)\n" if ($dbg_values > 1);
1015 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001016 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001017 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001018 }
1019
Florian Micklerc023e4732011-01-12 16:59:58 -08001020 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001021 print "CAST($1)\n" if ($dbg_values > 1);
1022 push(@av_paren_type, $type);
1023 $type = 'C';
1024
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001025 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001026 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001027 $type = 'T';
1028
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001029 } elsif ($cur =~ /^($Modifier)\s*/) {
1030 print "MODIFIER($1)\n" if ($dbg_values > 1);
1031 $type = 'T';
1032
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001033 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001034 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001035 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001036 push(@av_paren_type, $type);
1037 if ($2 ne '') {
1038 $av_pending = 'N';
1039 }
1040 $type = 'E';
1041
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001042 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001043 print "UNDEF($1)\n" if ($dbg_values > 1);
1044 $av_preprocessor = 1;
1045 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001046
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001047 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001048 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001049 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001050
1051 push(@av_paren_type, $type);
1052 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001053 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001054
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001055 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001056 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1057 $av_preprocessor = 1;
1058
1059 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1060
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001061 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001062
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001063 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001064 print "PRE_END($1)\n" if ($dbg_values > 1);
1065
1066 $av_preprocessor = 1;
1067
1068 # Assume all arms of the conditional end as this
1069 # one does, and continue as if the #endif was not here.
1070 pop(@av_paren_type);
1071 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001072 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001073
1074 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001075 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001076
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001077 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1078 print "ATTR($1)\n" if ($dbg_values > 1);
1079 $av_pending = $type;
1080 $type = 'N';
1081
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001082 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001083 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001084 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001085 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001086 }
1087 $type = 'N';
1088
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001089 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001090 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001091 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001092 $type = 'N';
1093
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001094 } elsif ($cur =~/^(case)/o) {
1095 print "CASE($1)\n" if ($dbg_values > 1);
1096 $av_pend_colon = 'C';
1097 $type = 'N';
1098
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001099 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001100 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001101 $type = 'N';
1102
1103 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001104 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001105 push(@av_paren_type, $av_pending);
1106 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001107 $type = 'N';
1108
1109 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001110 my $new_type = pop(@av_paren_type);
1111 if ($new_type ne '_') {
1112 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001113 print "PAREN('$1') -> $type\n"
1114 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001115 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001116 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001117 }
1118
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001119 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001120 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001121 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001122 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001123
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001124 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1125 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001126 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001127 } elsif ($type eq 'E') {
1128 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001129 }
1130 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1131 $type = 'V';
1132
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001133 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001134 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001135 $type = 'V';
1136
1137 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001138 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001139 $type = 'N';
1140
Andy Whitcroftcf655042008-03-04 14:28:20 -08001141 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001142 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001143 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001144 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001145
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001146 } elsif ($cur =~/^(,)/) {
1147 print "COMMA($1)\n" if ($dbg_values > 1);
1148 $type = 'C';
1149
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001150 } elsif ($cur =~ /^(\?)/o) {
1151 print "QUESTION($1)\n" if ($dbg_values > 1);
1152 $type = 'N';
1153
1154 } elsif ($cur =~ /^(:)/o) {
1155 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1156
1157 substr($var, length($res), 1, $av_pend_colon);
1158 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1159 $type = 'E';
1160 } else {
1161 $type = 'N';
1162 }
1163 $av_pend_colon = 'O';
1164
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001165 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001166 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001167 $type = 'N';
1168
Andy Whitcroft0d413862008-10-15 22:02:16 -07001169 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001170 my $variant;
1171
1172 print "OPV($1)\n" if ($dbg_values > 1);
1173 if ($type eq 'V') {
1174 $variant = 'B';
1175 } else {
1176 $variant = 'U';
1177 }
1178
1179 substr($var, length($res), 1, $variant);
1180 $type = 'N';
1181
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001182 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001183 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001184 if ($1 ne '++' && $1 ne '--') {
1185 $type = 'N';
1186 }
1187
1188 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001189 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001190 }
1191 if (defined $1) {
1192 $cur = substr($cur, length($1));
1193 $res .= $type x length($1);
1194 }
1195 }
1196
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001197 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001198}
1199
Andy Whitcroft8905a672007-11-28 16:21:06 -08001200sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001201 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001202 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001203 ^(?:
1204 $Modifier|
1205 $Storage|
1206 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001207 DEFINE_\S+
1208 )$|
1209 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001210 goto|
1211 return|
1212 case|
1213 else|
1214 asm|__asm__|
1215 do
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001216 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001217 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001218 )}x;
1219 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1220 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001221 # Check for modifiers.
1222 $possible =~ s/\s*$Storage\s*//g;
1223 $possible =~ s/\s*$Sparse\s*//g;
1224 if ($possible =~ /^\s*$/) {
1225
1226 } elsif ($possible =~ /\s/) {
1227 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001228 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001229 if ($modifier !~ $notPermitted) {
1230 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1231 push(@modifierList, $modifier);
1232 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001233 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001234
1235 } else {
1236 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1237 push(@typeList, $possible);
1238 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001239 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001240 } else {
1241 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001242 }
1243}
1244
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001245my $prefix = '';
1246
Joe Perches000d1cc2011-07-25 17:13:25 -07001247sub show_type {
1248 return !defined $ignore_type{$_[0]};
1249}
1250
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001251sub report {
Joe Perches000d1cc2011-07-25 17:13:25 -07001252 if (!show_type($_[1]) ||
1253 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001254 return 0;
1255 }
Joe Perches000d1cc2011-07-25 17:13:25 -07001256 my $line;
1257 if ($show_types) {
1258 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1259 } else {
1260 $line = "$prefix$_[0]: $_[2]\n";
1261 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001262 $line = (split('\n', $line))[0] . "\n" if ($terse);
1263
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001264 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001265
1266 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001267}
1268sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001269 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001270}
Joe Perches000d1cc2011-07-25 17:13:25 -07001271
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001272sub ERROR {
Joe Perches000d1cc2011-07-25 17:13:25 -07001273 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001274 our $clean = 0;
1275 our $cnt_error++;
1276 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001277}
1278sub WARN {
Joe Perches000d1cc2011-07-25 17:13:25 -07001279 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001280 our $clean = 0;
1281 our $cnt_warn++;
1282 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001283}
1284sub CHK {
Joe Perches000d1cc2011-07-25 17:13:25 -07001285 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001286 our $clean = 0;
1287 our $cnt_chk++;
1288 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001289}
1290
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001291sub check_absolute_file {
1292 my ($absolute, $herecurr) = @_;
1293 my $file = $absolute;
1294
1295 ##print "absolute<$absolute>\n";
1296
1297 # See if any suffix of this path is a path within the tree.
1298 while ($file =~ s@^[^/]*/@@) {
1299 if (-f "$root/$file") {
1300 ##print "file<$file>\n";
1301 last;
1302 }
1303 }
1304 if (! -f _) {
1305 return 0;
1306 }
1307
1308 # It is, so see if the prefix is acceptable.
1309 my $prefix = $absolute;
1310 substr($prefix, -length($file)) = '';
1311
1312 ##print "prefix<$prefix>\n";
1313 if ($prefix ne ".../") {
Joe Perches000d1cc2011-07-25 17:13:25 -07001314 WARN("USE_RELATIVE_PATH",
1315 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001316 }
1317}
1318
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001319sub process {
1320 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001321
1322 my $linenr=0;
1323 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001324 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001325 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001326 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001327
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001328 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001329 my $indent;
1330 my $previndent=0;
1331 my $stashindent=0;
1332
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001333 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001334 my $signoff = 0;
1335 my $is_patch = 0;
1336
Joe Perches15662b32011-10-31 17:13:12 -07001337 my $in_header_lines = 1;
1338 my $in_commit_log = 0; #Scanning lines before patch
1339
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001340 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001341 our $cnt_lines = 0;
1342 our $cnt_error = 0;
1343 our $cnt_warn = 0;
1344 our $cnt_chk = 0;
1345
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001346 # Trace the real file/line as we go.
1347 my $realfile = '';
1348 my $realline = 0;
1349 my $realcnt = 0;
1350 my $here = '';
1351 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001352 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001353 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001354 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001355
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001356 my $prev_values = 'E';
1357
1358 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001359 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001360 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001361 my %suppress_export;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001362
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001363 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001364 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001365 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001366 my @setup_docs = ();
1367 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001368
1369 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001370 my $line;
1371 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001372 $linenr++;
1373 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001374
Andy Whitcroft773647a2008-03-28 14:15:58 -07001375 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001376 $setup_docs = 0;
1377 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1378 $setup_docs = 1;
1379 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001380 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001381 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001382 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1383 $realline=$1-1;
1384 if (defined $2) {
1385 $realcnt=$3+1;
1386 } else {
1387 $realcnt=1+1;
1388 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001389 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001390
1391 # Guestimate if this is a continuing comment. Run
1392 # the context looking for a comment "edge". If this
1393 # edge is a close comment then we must be in a comment
1394 # at context start.
1395 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001396 my $cnt = $realcnt;
1397 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1398 next if (defined $rawlines[$ln - 1] &&
1399 $rawlines[$ln - 1] =~ /^-/);
1400 $cnt--;
1401 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001402 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001403 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1404 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1405 ($edge) = $1;
1406 last;
1407 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001408 }
1409 if (defined $edge && $edge eq '*/') {
1410 $in_comment = 1;
1411 }
1412
1413 # Guestimate if this is a continuing comment. If this
1414 # is the start of a diff block and this line starts
1415 # ' *' then it is very likely a comment.
1416 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001417 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001418 {
1419 $in_comment = 1;
1420 }
1421
1422 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1423 sanitise_line_reset($in_comment);
1424
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001425 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001426 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001427 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001428 $line = sanitise_line($rawline);
1429 }
1430 push(@lines, $line);
1431
1432 if ($realcnt > 1) {
1433 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1434 } else {
1435 $realcnt = 0;
1436 }
1437
1438 #print "==>$rawline\n";
1439 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001440
1441 if ($setup_docs && $line =~ /^\+/) {
1442 push(@setup_docs, $line);
1443 }
1444 }
1445
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001446 $prefix = '';
1447
Andy Whitcroft773647a2008-03-28 14:15:58 -07001448 $realcnt = 0;
1449 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001450 foreach my $line (@lines) {
1451 $linenr++;
1452
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001453 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001454
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001455#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001456 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001457 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001458 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001459 $realline=$1-1;
1460 if (defined $2) {
1461 $realcnt=$3+1;
1462 } else {
1463 $realcnt=1+1;
1464 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001465 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001466 $prev_values = 'E';
1467
Andy Whitcroft773647a2008-03-28 14:15:58 -07001468 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001469 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001470 %suppress_export = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001471 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001472
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001473# track the line number as we move through the hunk, note that
1474# new versions of GNU diff omit the leading space on completely
1475# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001476 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001477 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001478 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001479
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001480 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001481 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001482
1483 # Track the previous line.
1484 ($prevline, $stashline) = ($stashline, $line);
1485 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001486 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1487
Andy Whitcroft773647a2008-03-28 14:15:58 -07001488 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001489
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001490 } elsif ($realcnt == 1) {
1491 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001492 }
1493
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001494 my $hunk_line = ($realcnt != 0);
1495
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001496#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001497 $prefix = "$filename:$realline: " if ($emacs && $file);
1498 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1499
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001500 $here = "#$linenr: " if (!$file);
1501 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001502
1503 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001504 if ($line =~ /^diff --git.*?(\S+)$/) {
1505 $realfile = $1;
1506 $realfile =~ s@^([^/]*)/@@;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001507 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001508 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001509 $realfile =~ s@^([^/]*)/@@;
1510
1511 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001512 if (!$file && $tree && $p1_prefix ne '' &&
1513 -e "$root/$p1_prefix") {
Joe Perches000d1cc2011-07-25 17:13:25 -07001514 WARN("PATCH_PREFIX",
1515 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001516 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001517
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001518 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001519 ERROR("MODIFIED_INCLUDE_ASM",
1520 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
Andy Whitcroft773647a2008-03-28 14:15:58 -07001521 }
1522 next;
1523 }
1524
Randy Dunlap389834b2007-06-08 13:47:03 -07001525 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001526
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001527 my $hereline = "$here\n$rawline\n";
1528 my $herecurr = "$here\n$rawline\n";
1529 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001530
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001531 $cnt_lines++ if ($realcnt != 0);
1532
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001533# Check for incorrect file permissions
1534 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1535 my $permhere = $here . "FILE: $realfile\n";
1536 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001537 ERROR("EXECUTE_PERMISSIONS",
1538 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001539 }
1540 }
1541
Joe Perches20112472011-07-25 17:13:23 -07001542# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001543 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001544 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001545 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001546 }
1547
1548# Check signature styles
1549 if ($line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1550 my $space_before = $1;
1551 my $sign_off = $2;
1552 my $space_after = $3;
1553 my $email = $4;
1554 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1555
1556 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc2011-07-25 17:13:25 -07001557 WARN("BAD_SIGN_OFF",
1558 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001559 }
Joe Perches20112472011-07-25 17:13:23 -07001560 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001561 WARN("BAD_SIGN_OFF",
1562 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001563 }
1564 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc2011-07-25 17:13:25 -07001565 WARN("BAD_SIGN_OFF",
1566 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001567 }
1568
1569 my ($email_name, $email_address, $comment) = parse_email($email);
1570 my $suggested_email = format_email(($email_name, $email_address));
1571 if ($suggested_email eq "") {
Joe Perches000d1cc2011-07-25 17:13:25 -07001572 ERROR("BAD_SIGN_OFF",
1573 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001574 } else {
1575 my $dequoted = $suggested_email;
1576 $dequoted =~ s/^"//;
1577 $dequoted =~ s/" </ </;
1578 # Don't force email to have quotes
1579 # Allow just an angle bracketed address
1580 if ("$dequoted$comment" ne $email &&
1581 "<$email_address>$comment" ne $email &&
1582 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001583 WARN("BAD_SIGN_OFF",
1584 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001585 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001586 }
1587 }
1588
Andy Whitcroft00df3442007-06-08 13:47:06 -07001589# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001590 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001591 ERROR("CORRUPTED_PATCH",
1592 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001593 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001594 }
1595
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001596# Check for absolute kernel paths.
1597 if ($tree) {
1598 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1599 my $file = $1;
1600
1601 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1602 check_absolute_file($1, $herecurr)) {
1603 #
1604 } else {
1605 check_absolute_file($file, $herecurr);
1606 }
1607 }
1608 }
1609
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001610# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1611 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001612 $rawline !~ m/^$UTF8*$/) {
1613 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1614
1615 my $blank = copy_spacing($rawline);
1616 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1617 my $hereptr = "$hereline$ptr\n";
1618
Joe Perches34d99212011-07-25 17:13:26 -07001619 CHK("INVALID_UTF8",
1620 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001621 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001622
Joe Perches15662b32011-10-31 17:13:12 -07001623# Check if it's the start of a commit log
1624# (not a header line and we haven't seen the patch filename)
1625 if ($in_header_lines && $realfile =~ /^$/ &&
1626 $rawline !~ /^(commit\b|from\b|\w+:).+$/i) {
1627 $in_header_lines = 0;
1628 $in_commit_log = 1;
1629 }
1630
1631# Still not yet in a patch, check for any UTF-8
1632 if ($in_commit_log && $realfile =~ /^$/ &&
1633 $rawline =~ /$NON_ASCII_UTF8/) {
1634 CHK("UTF8_BEFORE_PATCH",
1635 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1636 }
1637
Andy Whitcroft306708542008-10-15 22:02:28 -07001638# ignore non-hunk lines and lines being removed
1639 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001640
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001641#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001642 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001643 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001644 ERROR("DOS_LINE_ENDINGS",
1645 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001646
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001647 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1648 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001649 ERROR("TRAILING_WHITESPACE",
1650 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001651 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001652 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001653
Andi Kleen33549572010-05-24 14:33:29 -07001654# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001655# Only applies when adding the entry originally, after that we do not have
1656# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001657 if ($realfile =~ /Kconfig/ &&
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001658 $line =~ /\+\s*(?:---)?help(?:---)?$/) {
Andi Kleen33549572010-05-24 14:33:29 -07001659 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001660 my $cnt = $realcnt;
1661 my $ln = $linenr + 1;
1662 my $f;
1663 my $is_end = 0;
1664 while ($cnt > 0 && defined $lines[$ln - 1]) {
1665 $f = $lines[$ln - 1];
1666 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1667 $is_end = $lines[$ln - 1] =~ /^\+/;
1668 $ln++;
1669
1670 next if ($f =~ /^-/);
1671 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001672 $f =~ s/#.*//;
1673 $f =~ s/^\s+//;
1674 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001675 if ($f =~ /^\s*config\s/) {
1676 $is_end = 1;
1677 last;
1678 }
Andi Kleen33549572010-05-24 14:33:29 -07001679 $length++;
1680 }
Joe Perches000d1cc2011-07-25 17:13:25 -07001681 WARN("CONFIG_DESCRIPTION",
1682 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001683 #print "is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001684 }
1685
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001686 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1687 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1688 my $flag = $1;
1689 my $replacement = {
1690 'EXTRA_AFLAGS' => 'asflags-y',
1691 'EXTRA_CFLAGS' => 'ccflags-y',
1692 'EXTRA_CPPFLAGS' => 'cppflags-y',
1693 'EXTRA_LDFLAGS' => 'ldflags-y',
1694 };
1695
1696 WARN("DEPRECATED_VARIABLE",
1697 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1698 }
1699
Andy Whitcroft5368df22008-10-15 22:02:27 -07001700# check we are in a valid source file if not then ignore this hunk
1701 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1702
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001703#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001704 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001705 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001706 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001707 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001708 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001709 {
Joe Perches000d1cc2011-07-25 17:13:25 -07001710 WARN("LONG_LINE",
1711 "line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001712 }
1713
Joe Perches5e79d962010-03-05 13:43:55 -08001714# check for spaces before a quoted newline
1715 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001716 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1717 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001718 }
1719
Andy Whitcroft8905a672007-11-28 16:21:06 -08001720# check for adding lines without a newline.
1721 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001722 WARN("MISSING_EOF_NEWLINE",
1723 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001724 }
1725
Mike Frysinger42e41c52009-09-21 17:04:40 -07001726# Blackfin: use hi/lo macros
1727 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1728 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1729 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001730 ERROR("LO_MACRO",
1731 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001732 }
1733 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1734 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001735 ERROR("HI_MACRO",
1736 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001737 }
1738 }
1739
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001740# check we are in a valid source file C or perl if not then ignore this hunk
1741 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001742
1743# at the beginning of a line any tabs must come first and anything
1744# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001745 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1746 $rawline =~ /^\+\s* \s*/) {
1747 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001748 ERROR("CODE_INDENT",
1749 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001750 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001751 }
1752
Alberto Panizzo08e44362010-03-05 13:43:54 -08001753# check for space before tabs.
1754 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1755 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001756 WARN("SPACE_BEFORE_TAB",
1757 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001758 }
1759
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001760# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001761# Exceptions:
1762# 1) within comments
1763# 2) indented preprocessor commands
1764# 3) hanging labels
1765 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001766 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001767 WARN("LEADING_SPACE",
1768 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001769 }
1770
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001771# check we are in a valid C source file if not then ignore this hunk
1772 next if ($realfile !~ /\.(h|c)$/);
1773
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001774# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001775 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001776 WARN("CVS_KEYWORD",
1777 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001778 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001779
Mike Frysinger42e41c52009-09-21 17:04:40 -07001780# Blackfin: don't use __builtin_bfin_[cs]sync
1781 if ($line =~ /__builtin_bfin_csync/) {
1782 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001783 ERROR("CSYNC",
1784 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001785 }
1786 if ($line =~ /__builtin_bfin_ssync/) {
1787 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc2011-07-25 17:13:25 -07001788 ERROR("SSYNC",
1789 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001790 }
1791
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001792# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001793 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1794 $realline_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001795 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001796 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001797 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001798 $stat =~ s/\n./\n /g;
1799 $cond =~ s/\n./\n /g;
1800
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001801 # Find the real next line.
1802 $realline_next = $line_nr_next;
1803 if (defined $realline_next &&
1804 (!defined $lines[$realline_next - 1] ||
1805 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1806 $realline_next++;
1807 }
1808
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001809 my $s = $stat;
1810 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001811
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001812 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001813 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001814
1815 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001816 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001817
Andy Whitcroft463f2862009-09-21 17:04:34 -07001818 } elsif ($s =~ /^.\s*else\b/s) {
1819
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001820 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001821 } 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) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001822 my $type = $1;
1823 $type =~ s/\s+/ /g;
1824 possible($type, "A:" . $s);
1825
Andy Whitcroft8905a672007-11-28 16:21:06 -08001826 # definitions in global scope can only start with types
Andy Whitcrofta6a84062008-10-15 22:02:30 -07001827 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001828 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001829 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001830
1831 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001832 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001833 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001834 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001835
1836 # Check for any sort of function declaration.
1837 # int foo(something bar, other baz);
1838 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001839 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001840 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001841
Andy Whitcroftcf655042008-03-04 14:28:20 -08001842 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001843 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001844 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001845
Andy Whitcroft8905a672007-11-28 16:21:06 -08001846 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001847 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001848
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001849 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001850 }
1851 }
1852 }
1853
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001854 }
1855
Andy Whitcroft653d4872007-06-23 17:16:34 -07001856#
1857# Checks which may be anchored in the context.
1858#
1859
1860# Check for switch () and associated case and default
1861# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001862 if ($line=~/\bswitch\s*\(.*\)/) {
1863 my $err = '';
1864 my $sep = '';
1865 my @ctx = ctx_block_outer($linenr, $realcnt);
1866 shift(@ctx);
1867 for my $ctx (@ctx) {
1868 my ($clen, $cindent) = line_stats($ctx);
1869 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1870 $indent != $cindent) {
1871 $err .= "$sep$ctx\n";
1872 $sep = '';
1873 } else {
1874 $sep = "[...]\n";
1875 }
1876 }
1877 if ($err ne '') {
Joe Perches000d1cc2011-07-25 17:13:25 -07001878 ERROR("SWITCH_CASE_INDENT_LEVEL",
1879 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001880 }
1881 }
1882
1883# if/while/etc brace do not go on next line, unless defining a do while loop,
1884# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001885 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001886 my $pre_ctx = "$1$2";
1887
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001888 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001889 my $ctx_cnt = $realcnt - $#ctx - 1;
1890 my $ctx = join("\n", @ctx);
1891
Andy Whitcroft548596d2008-07-23 21:29:01 -07001892 my $ctx_ln = $linenr;
1893 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001894
Andy Whitcroft548596d2008-07-23 21:29:01 -07001895 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1896 defined $lines[$ctx_ln - 1] &&
1897 $lines[$ctx_ln - 1] =~ /^-/)) {
1898 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1899 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001900 $ctx_ln++;
1901 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001902
Andy Whitcroft53210162008-07-23 21:29:03 -07001903 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1904 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001905
1906 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001907 ERROR("OPEN_BRACE",
1908 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001909 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001910 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001911 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1912 $ctx =~ /\)\s*\;\s*$/ &&
1913 defined $lines[$ctx_ln - 1])
1914 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001915 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1916 if ($nindent > $indent) {
Joe Perches000d1cc2011-07-25 17:13:25 -07001917 WARN("TRAILING_SEMICOLON",
1918 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001919 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001920 }
1921 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001922 }
1923
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001924# Check relative indent for conditionals and blocks.
1925 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1926 my ($s, $c) = ($stat, $cond);
1927
1928 substr($s, 0, length($c), '');
1929
1930 # Make sure we remove the line prefixes as we have
1931 # none on the first line, and are going to readd them
1932 # where necessary.
1933 $s =~ s/\n./\n/gs;
1934
1935 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001936 my @newlines = ($c =~ /\n/gs);
1937 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001938
1939 # We want to check the first line inside the block
1940 # starting at the end of the conditional, so remove:
1941 # 1) any blank line termination
1942 # 2) any opening brace { on end of the line
1943 # 3) any do (...) {
1944 my $continuation = 0;
1945 my $check = 0;
1946 $s =~ s/^.*\bdo\b//;
1947 $s =~ s/^\s*{//;
1948 if ($s =~ s/^\s*\\//) {
1949 $continuation = 1;
1950 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001951 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001952 $check = 1;
1953 $cond_lines++;
1954 }
1955
1956 # Also ignore a loop construct at the end of a
1957 # preprocessor statement.
1958 if (($prevline =~ /^.\s*#\s*define\s/ ||
1959 $prevline =~ /\\\s*$/) && $continuation == 0) {
1960 $check = 0;
1961 }
1962
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001963 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001964 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001965 while ($cond_ptr != $cond_lines) {
1966 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001967
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001968 # If we see an #else/#elif then the code
1969 # is not linear.
1970 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1971 $check = 0;
1972 }
1973
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001974 # Ignore:
1975 # 1) blank lines, they should be at 0,
1976 # 2) preprocessor lines, and
1977 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001978 if ($continuation ||
1979 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001980 $s =~ /^\s*#\s*?/ ||
1981 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001982 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001983 if ($s =~ s/^.*?\n//) {
1984 $cond_lines++;
1985 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001986 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001987 }
1988
1989 my (undef, $sindent) = line_stats("+" . $s);
1990 my $stat_real = raw_line($linenr, $cond_lines);
1991
1992 # Check if either of these lines are modified, else
1993 # this is not this patch's fault.
1994 if (!defined($stat_real) ||
1995 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1996 $check = 0;
1997 }
1998 if (defined($stat_real) && $cond_lines > 1) {
1999 $stat_real = "[...]\n$stat_real";
2000 }
2001
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002002 #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";
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002003
2004 if ($check && (($sindent % 8) != 0 ||
2005 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002006 WARN("SUSPECT_CODE_INDENT",
2007 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002008 }
2009 }
2010
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002011 # Track the 'values' across context and added lines.
2012 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002013 my ($curr_values, $curr_vars) =
2014 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002015 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002016 if ($dbg_values) {
2017 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002018 print "$linenr > .$outline\n";
2019 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002020 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002021 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002022 $prev_values = substr($curr_values, -1);
2023
Andy Whitcroft00df3442007-06-08 13:47:06 -07002024#ignore lines not being added
2025 if ($line=~/^[^\+]/) {next;}
2026
Andy Whitcroft653d4872007-06-23 17:16:34 -07002027# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002028 if ($dbg_type) {
2029 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002030 ERROR("TEST_TYPE",
2031 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002032 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002033 ERROR("TEST_NOT_TYPE",
2034 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002035 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002036 next;
2037 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002038# TEST: allow direct testing of the attribute matcher.
2039 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002040 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002041 ERROR("TEST_ATTR",
2042 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002043 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002044 ERROR("TEST_NOT_ATTR",
2045 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002046 }
2047 next;
2048 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002049
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002050# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002051 if ($line =~ /^.\s*{/ &&
2052 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002053 ERROR("OPEN_BRACE",
2054 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002055 }
2056
Andy Whitcroft653d4872007-06-23 17:16:34 -07002057#
2058# Checks which are anchored on the added line.
2059#
2060
2061# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002062 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002063 my $path = $1;
2064 if ($path =~ m{//}) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002065 ERROR("MALFORMED_INCLUDE",
2066 "malformed #include filename\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002067 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002068 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002069 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002070
2071# no C99 // comments
2072 if ($line =~ m{//}) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002073 ERROR("C99_COMMENTS",
2074 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002075 }
2076 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002077 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002078 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002079
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002080# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2081# the whole statement.
2082#print "APW <$lines[$realline_next - 1]>\n";
2083 if (defined $realline_next &&
2084 exists $lines[$realline_next - 1] &&
2085 !defined $suppress_export{$realline_next} &&
2086 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2087 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002088 # Handle definitions which produce identifiers with
2089 # a prefix:
2090 # XXX(foo);
2091 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002092 my $name = $1;
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002093 if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ &&
2094 $name =~ /^${Ident}_$2/) {
2095#print "FOO C name<$name>\n";
2096 $suppress_export{$realline_next} = 1;
2097
2098 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002099 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002100 ^.DEFINE_$Ident\(\Q$name\E\)|
2101 ^.DECLARE_$Ident\(\Q$name\E\)|
2102 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002103 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2104 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002105 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002106#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2107 $suppress_export{$realline_next} = 2;
2108 } else {
2109 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002110 }
2111 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002112 if (!defined $suppress_export{$linenr} &&
2113 $prevline =~ /^.\s*$/ &&
2114 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2115 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2116#print "FOO B <$lines[$linenr - 1]>\n";
2117 $suppress_export{$linenr} = 2;
2118 }
2119 if (defined $suppress_export{$linenr} &&
2120 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002121 WARN("EXPORT_SYMBOL",
2122 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002123 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002124
Joe Eloff5150bda2010-08-09 17:21:00 -07002125# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002126 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002127 ERROR("GLOBAL_INITIALISERS",
2128 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002129 $herecurr);
2130 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002131# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002132 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002133 ERROR("INITIALISED_STATIC",
2134 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002135 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002136 }
2137
Joe Perchescb710ec2010-10-26 14:23:20 -07002138# check for static const char * arrays.
2139 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002140 WARN("STATIC_CONST_CHAR_ARRAY",
2141 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002142 $herecurr);
2143 }
2144
2145# check for static char foo[] = "bar" declarations.
2146 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002147 WARN("STATIC_CONST_CHAR_ARRAY",
2148 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002149 $herecurr);
2150 }
2151
Joe Perches93ed0e22010-10-26 14:23:21 -07002152# check for declarations of struct pci_device_id
2153 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002154 WARN("DEFINE_PCI_DEVICE_TABLE",
2155 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002156 }
2157
Andy Whitcroft653d4872007-06-23 17:16:34 -07002158# check for new typedefs, only function parameters and sparse annotations
2159# make sense.
2160 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002161 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002162 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002163 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002164 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002165 WARN("NEW_TYPEDEFS",
2166 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002167 }
2168
2169# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002170 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08002171 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002172 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002173
Andy Whitcroft65863862009-01-06 14:41:21 -08002174 # Should start with a space.
2175 $to =~ s/^(\S)/ $1/;
2176 # Should not end with a space.
2177 $to =~ s/\s+$//;
2178 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002179 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002180 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002181
Andy Whitcroft65863862009-01-06 14:41:21 -08002182 #print "from<$from> to<$to>\n";
2183 if ($from ne $to) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002184 ERROR("POINTER_LOCATION",
2185 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002186 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08002187 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002188 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002189
Andy Whitcroft65863862009-01-06 14:41:21 -08002190 # Should start with a space.
2191 $to =~ s/^(\S)/ $1/;
2192 # Should not end with a space.
2193 $to =~ s/\s+$//;
2194 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002195 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002196 }
2197 # Modifiers should have spaces.
2198 $to =~ s/(\b$Modifier$)/$1 /;
2199
Andy Whitcroft667026e2009-02-27 14:03:08 -08002200 #print "from<$from> to<$to> ident<$ident>\n";
2201 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002202 ERROR("POINTER_LOCATION",
2203 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002204 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002205 }
2206
2207# # no BUG() or BUG_ON()
2208# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2209# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2210# print "$herecurr";
2211# $clean = 0;
2212# }
2213
Andy Whitcroft8905a672007-11-28 16:21:06 -08002214 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002215 WARN("LINUX_VERSION_CODE",
2216 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002217 }
2218
Joe Perches17441222011-06-15 15:08:17 -07002219# check for uses of printk_ratelimit
2220 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002221 WARN("PRINTK_RATELIMITED",
2222"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002223 }
2224
Andy Whitcroft00df3442007-06-08 13:47:06 -07002225# printk should use KERN_* levels. Note that follow on printk's on the
2226# same line do not need a level, so we use the current block context
2227# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002228# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002229# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002230 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002231 my $ok = 0;
2232 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2233 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002234 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002235 # with "\n" ignore it, else it is to blame
2236 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2237 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2238 $ok = 1;
2239 }
2240 last;
2241 }
2242 }
2243 if ($ok == 0) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002244 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2245 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002246 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002247 }
2248
Andy Whitcroft653d4872007-06-23 17:16:34 -07002249# function brace can't be on same line, except for #defines of do while,
2250# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002251 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2252 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002253 ERROR("OPEN_BRACE",
2254 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002255 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002256
Andy Whitcroft8905a672007-11-28 16:21:06 -08002257# open braces for enum, union and struct go on the same line.
2258 if ($line =~ /^.\s*{/ &&
2259 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002260 ERROR("OPEN_BRACE",
2261 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002262 }
2263
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002264# missing space after union, struct or enum definition
2265 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002266 WARN("SPACING",
2267 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002268 }
2269
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002270# check for spacing round square brackets; allowed:
2271# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002272# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2273# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002274 while ($line =~ /(.*?\s)\[/g) {
2275 my ($where, $prefix) = ($-[1], $1);
2276 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002277 ($where != 0 || $prefix !~ /^.\s+$/) &&
2278 $prefix !~ /{\s+$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002279 ERROR("BRACKET_SPACE",
2280 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002281 }
2282 }
2283
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002284# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002285 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002286 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002287 my $ctx_before = substr($line, 0, $-[1]);
2288 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002289
2290 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 if ($name =~ /^(?:
2292 if|for|while|switch|return|case|
2293 volatile|__volatile__|
2294 __attribute__|format|__extension__|
2295 asm|__asm__)$/x)
2296 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002297
2298 # cpp #define statements have non-optional spaces, ie
2299 # if there is a space between the name and the open
2300 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002301 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002302
2303 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002304 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002305
2306 # If this whole things ends with a type its most
2307 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002308 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002309
2310 } else {
Joe Perches000d1cc2011-07-25 17:13:25 -07002311 WARN("SPACING",
2312 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002313 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002314 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002315# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002316 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002317 my $ops = qr{
2318 <<=|>>=|<=|>=|==|!=|
2319 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2320 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002321 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2322 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002323 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002324 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002325 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002326
2327 my $blank = copy_spacing($opline);
2328
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002329 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002330 $off += length($elements[$n]);
2331
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002332 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002333 my $ca = substr($opline, 0, $off);
2334 my $cc = '';
2335 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2336 $cc = substr($opline, $off + length($elements[$n + 1]));
2337 }
2338 my $cb = "$ca$;$cc";
2339
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002340 my $a = '';
2341 $a = 'V' if ($elements[$n] ne '');
2342 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002343 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002344 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2345 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002346 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002347
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002348 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002349
2350 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002351 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002352 $c = 'V' if ($elements[$n + 2] ne '');
2353 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002354 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002355 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2356 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002357 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002358 } else {
2359 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002360 }
2361
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002362 my $ctx = "${a}x${c}";
2363
2364 my $at = "(ctx:$ctx)";
2365
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002366 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002367 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002368
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002369 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002370 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002371
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002372 # Get the full operator variant.
2373 my $opv = $op . substr($curr_vars, $off, 1);
2374
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002375 # Ignore operators passed as parameters.
2376 if ($op_type ne 'V' &&
2377 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2378
Andy Whitcroftcf655042008-03-04 14:28:20 -08002379# # Ignore comments
2380# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002381
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002382 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002383 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002384 if ($ctx !~ /.x[WEBC]/ &&
2385 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002386 ERROR("SPACING",
2387 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002388 }
2389
2390 # // is a comment
2391 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002392
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002393 # No spaces for:
2394 # ->
2395 # : when part of a bitfield
2396 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002397 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002398 ERROR("SPACING",
2399 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002400 }
2401
2402 # , must have a space on the right.
2403 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002404 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002405 ERROR("SPACING",
2406 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002407 }
2408
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002409 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002410 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002411 #warn "'*' is part of type\n";
2412
2413 # unary operators should have a space before and
2414 # none after. May be left adjacent to another
2415 # unary operator, or a cast
2416 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002417 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002418 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002419 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002420 ERROR("SPACING",
2421 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002422 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002423 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002424 # A unary '*' may be const
2425
2426 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002427 ERROR("SPACING",
2428 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002429 }
2430
2431 # unary ++ and unary -- are allowed no space on one side.
2432 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002433 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002434 ERROR("SPACING",
2435 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002436 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002437 if ($ctx =~ /Wx[BE]/ ||
2438 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002439 ERROR("SPACING",
2440 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002441 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002442 if ($ctx =~ /ExW/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002443 ERROR("SPACING",
2444 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002445 }
2446
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002447
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002448 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002449 } elsif ($op eq '<<' or $op eq '>>' or
2450 $op eq '&' or $op eq '^' or $op eq '|' or
2451 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002452 $op eq '*' or $op eq '/' or
2453 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002454 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002455 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002456 ERROR("SPACING",
2457 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002458 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002459 }
2460
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002461 # A colon needs no spaces before when it is
2462 # terminating a case value or a label.
2463 } elsif ($opv eq ':C' || $opv eq ':L') {
2464 if ($ctx =~ /Wx./) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002465 ERROR("SPACING",
2466 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002467 }
2468
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002469 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002470 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002471 my $ok = 0;
2472
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002473 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002474 if (($op eq '<' &&
2475 $cc =~ /^\S+\@\S+>/) ||
2476 ($op eq '>' &&
2477 $ca =~ /<\S+\@\S+$/))
2478 {
2479 $ok = 1;
2480 }
2481
2482 # Ignore ?:
2483 if (($opv eq ':O' && $ca =~ /\?$/) ||
2484 ($op eq '?' && $cc =~ /^:/)) {
2485 $ok = 1;
2486 }
2487
2488 if ($ok == 0) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002489 ERROR("SPACING",
2490 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002491 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002492 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002493 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002494 }
2495 }
2496
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002497# check for multiple assignments
2498 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002499 CHK("MULTIPLE_ASSIGNMENTS",
2500 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002501 }
2502
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002503## # check for multiple declarations, allowing for a function declaration
2504## # continuation.
2505## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2506## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2507##
2508## # Remove any bracketed sections to ensure we do not
2509## # falsly report the parameters of functions.
2510## my $ln = $line;
2511## while ($ln =~ s/\([^\(\)]*\)//g) {
2512## }
2513## if ($ln =~ /,/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002514## WARN("MULTIPLE_DECLARATION",
2515## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002516## }
2517## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002518
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002519#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002520 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2521 $line =~ /do{/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002522 ERROR("SPACING",
2523 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002524 }
2525
2526# closing brace should have a space following it when it has anything
2527# on the line
2528 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002529 ERROR("SPACING",
2530 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002531 }
2532
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002533# check spacing on square brackets
2534 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002535 ERROR("SPACING",
2536 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002537 }
2538 if ($line =~ /\s\]/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002539 ERROR("SPACING",
2540 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002541 }
2542
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002543# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002544 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2545 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002546 ERROR("SPACING",
2547 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002548 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002549 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002550 $line !~ /for\s*\(.*;\s+\)/ &&
2551 $line !~ /:\s+\)/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002552 ERROR("SPACING",
2553 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002554 }
2555
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002556#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002557 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002558 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002559 WARN("INDENTED_LABEL",
2560 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002561 }
2562
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002563# Return is not a function.
2564 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2565 my $spacing = $1;
2566 my $value = $2;
2567
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002568 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002569 $value =~ s/\(/ \(/g;
2570 $value =~ s/\)/\) /g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002571 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2572 $value !~ /(?:$Ident|-?$Constant)\s*
2573 $Compare\s*
2574 (?:$Ident|-?$Constant)/x &&
2575 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002576 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002577#print "value<$value>\n";
2578 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002579 ERROR("RETURN_PARENTHESES",
2580 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002581
2582 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002583 ERROR("SPACING",
2584 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002585 }
2586 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002587# Return of what appears to be an errno should normally be -'ve
2588 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2589 my $name = $1;
2590 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc2011-07-25 17:13:25 -07002591 WARN("USE_NEGATIVE_ERRNO",
2592 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002593 }
2594 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002595
Joe Perches7d2367a2011-07-25 17:13:22 -07002596# typecasts on min/max could be min_t/max_t
2597 if ($line =~ /^\+(?:.*?)\b(min|max)\s*\($Typecast{0,1}($LvalOrFunc)\s*,\s*$Typecast{0,1}($LvalOrFunc)\s*\)/) {
2598 if (defined $2 || defined $8) {
2599 my $call = $1;
2600 my $cast1 = deparenthesize($2);
2601 my $arg1 = $3;
2602 my $cast2 = deparenthesize($8);
2603 my $arg2 = $9;
2604 my $cast;
2605
2606 if ($cast1 ne "" && $cast2 ne "") {
2607 $cast = "$cast1 or $cast2";
2608 } elsif ($cast1 ne "") {
2609 $cast = $cast1;
2610 } else {
2611 $cast = $cast2;
2612 }
Hui Zhu30ecad52011-08-25 15:59:08 -07002613 WARN("MINMAX",
2614 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . $herecurr);
Joe Perches7d2367a2011-07-25 17:13:22 -07002615 }
2616 }
2617
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002618# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002619 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002620 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002621 }
2622
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002623# Check for illegal assignment in if conditional -- and check for trailing
2624# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002625 if ($line =~ /do\s*(?!{)/) {
2626 my ($stat_next) = ctx_statement_block($line_nr_next,
2627 $remain_next, $off_next);
2628 $stat_next =~ s/\n./\n /g;
2629 ##print "stat<$stat> stat_next<$stat_next>\n";
2630
2631 if ($stat_next =~ /^\s*while\b/) {
2632 # If the statement carries leading newlines,
2633 # then count those as offsets.
2634 my ($whitespace) =
2635 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2636 my $offset =
2637 statement_rawlines($whitespace) - 1;
2638
2639 $suppress_whiletrailers{$line_nr_next +
2640 $offset} = 1;
2641 }
2642 }
2643 if (!defined $suppress_whiletrailers{$linenr} &&
2644 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002645 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002646
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002647 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002648 ERROR("ASSIGN_IN_IF",
2649 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002650 }
2651
2652 # Find out what is on the end of the line after the
2653 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002654 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002655 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002656 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002657 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2658 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002659 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002660 # Find out how long the conditional actually is.
2661 my @newlines = ($c =~ /\n/gs);
2662 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002663 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002664
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002665 $stat_real = raw_line($linenr, $cond_lines)
2666 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002667 if (defined($stat_real) && $cond_lines > 1) {
2668 $stat_real = "[...]\n$stat_real";
2669 }
2670
Joe Perches000d1cc2011-07-25 17:13:25 -07002671 ERROR("TRAILING_STATEMENTS",
2672 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002673 }
2674 }
2675
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002676# Check for bitwise tests written as boolean
2677 if ($line =~ /
2678 (?:
2679 (?:\[|\(|\&\&|\|\|)
2680 \s*0[xX][0-9]+\s*
2681 (?:\&\&|\|\|)
2682 |
2683 (?:\&\&|\|\|)
2684 \s*0[xX][0-9]+\s*
2685 (?:\&\&|\|\||\)|\])
2686 )/x)
2687 {
Joe Perches000d1cc2011-07-25 17:13:25 -07002688 WARN("HEXADECIMAL_BOOLEAN_TEST",
2689 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002690 }
2691
Andy Whitcroft8905a672007-11-28 16:21:06 -08002692# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002693 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2694 my $s = $1;
2695 $s =~ s/$;//g; # Remove any comments
2696 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002697 ERROR("TRAILING_STATEMENTS",
2698 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002699 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002700 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002701# if should not continue a brace
2702 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002703 ERROR("TRAILING_STATEMENTS",
2704 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002705 $herecurr);
2706 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002707# case and default should not have general statements after them
2708 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2709 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002710 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002711 \s*return\s+
2712 )/xg)
2713 {
Joe Perches000d1cc2011-07-25 17:13:25 -07002714 ERROR("TRAILING_STATEMENTS",
2715 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002716 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002717
2718 # Check for }<nl>else {, these must be at the same
2719 # indent level to be relevant to each other.
2720 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2721 $previndent == $indent) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002722 ERROR("ELSE_AFTER_BRACE",
2723 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002724 }
2725
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002726 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2727 $previndent == $indent) {
2728 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2729
2730 # Find out what is on the end of the line after the
2731 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002732 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002733 $s =~ s/\n.*//g;
2734
2735 if ($s =~ /^\s*;/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002736 ERROR("WHILE_AFTER_BRACE",
2737 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002738 }
2739 }
2740
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002741#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2742# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2743# print "No studly caps, use _\n";
2744# print "$herecurr";
2745# $clean = 0;
2746# }
2747
2748#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002749 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002750 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2751 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002752 }
2753
Andy Whitcroft653d4872007-06-23 17:16:34 -07002754#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002755 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002756 my $file = "$1.h";
2757 my $checkfile = "include/linux/$file";
2758 if (-f "$root/$checkfile" &&
2759 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002760 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002761 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002762 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002763 CHK("ARCH_INCLUDE_LINUX",
2764 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002765 } else {
Joe Perches000d1cc2011-07-25 17:13:25 -07002766 WARN("INCLUDE_LINUX",
2767 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002768 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002769 }
2770 }
2771
Andy Whitcroft653d4872007-06-23 17:16:34 -07002772# multi-statement macros should be enclosed in a do while loop, grab the
2773# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002774# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002775 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2776 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002777 my $ln = $linenr;
2778 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002779 my ($off, $dstat, $dcond, $rest);
2780 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002781
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002782 my $args = defined($1);
2783
2784 # Find the end of the macro and limit our statement
2785 # search to that.
2786 while ($cnt > 0 && defined $lines[$ln - 1] &&
2787 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2788 {
2789 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002790 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002791 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002792 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002793 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002794
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002795 ($dstat, $dcond, $ln, $cnt, $off) =
2796 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2797 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002798 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002799
2800 # Extract the remainder of the define (if any) and
2801 # rip off surrounding spaces, and trailing \'s.
2802 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002803 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2804 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002805 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2806 $rest .= substr($lines[$ln - 1], $off) . "\n";
2807 $cnt--;
2808 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002809 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002810 $off = 0;
2811 }
2812 $rest =~ s/\\\n.//g;
2813 $rest =~ s/^\s*//s;
2814 $rest =~ s/\s*$//s;
2815
2816 # Clean up the original statement.
2817 if ($args) {
2818 substr($dstat, 0, length($dcond), '');
2819 } else {
2820 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2821 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002822 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002823 $dstat =~ s/\\\n.//g;
2824 $dstat =~ s/^\s*//s;
2825 $dstat =~ s/\s*$//s;
2826
2827 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002828 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2829 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2830 $dstat =~ s/\[[^\{\}]*\]/1/)
2831 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002832 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002833
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002834 my $exceptions = qr{
2835 $Declare|
2836 module_param_named|
2837 MODULE_PARAM_DESC|
2838 DECLARE_PER_CPU|
2839 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002840 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002841 union|
2842 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002843 \.$Ident\s*=\s*|
2844 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002845 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07002846 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2847 if ($rest ne '' && $rest ne ',') {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002848 if ($rest !~ /while\s*\(/ &&
2849 $dstat !~ /$exceptions/)
2850 {
Joe Perches000d1cc2011-07-25 17:13:25 -07002851 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2852 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002853 }
2854
2855 } elsif ($ctx !~ /;/) {
2856 if ($dstat ne '' &&
2857 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2858 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002859 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002860 $dstat =~ /$Operators/)
2861 {
Joe Perches000d1cc2011-07-25 17:13:25 -07002862 ERROR("COMPLEX_MACRO",
2863 "Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002864 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002865 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002866 }
2867
Mike Frysinger080ba922009-01-06 14:41:25 -08002868# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2869# all assignments may have only one of the following with an assignment:
2870# .
2871# ALIGN(...)
2872# VMLINUX_SYMBOL(...)
2873 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002874 WARN("MISSING_VMLINUX_SYMBOL",
2875 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08002876 }
2877
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002878# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002879 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2880 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002881 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002882 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002883 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2884 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002885 my $allowed = 0;
2886 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002887 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002888 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002889 for my $chunk (@chunks) {
2890 my ($cond, $block) = @{$chunk};
2891
Andy Whitcroft773647a2008-03-28 14:15:58 -07002892 # If the condition carries leading newlines, then count those as offsets.
2893 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2894 my $offset = statement_rawlines($whitespace) - 1;
2895
2896 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2897
2898 # We have looked at and allowed this specific line.
2899 $suppress_ifbraces{$ln + $offset} = 1;
2900
2901 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002902 $ln += statement_rawlines($block) - 1;
2903
Andy Whitcroft773647a2008-03-28 14:15:58 -07002904 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002905
2906 $seen++ if ($block =~ /^\s*{/);
2907
Andy Whitcroftcf655042008-03-04 14:28:20 -08002908 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2909 if (statement_lines($cond) > 1) {
2910 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002911 $allowed = 1;
2912 }
2913 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002914 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002915 $allowed = 1;
2916 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002917 if (statement_block_size($block) > 1) {
2918 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002919 $allowed = 1;
2920 }
2921 }
2922 if ($seen && !$allowed) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002923 WARN("BRACES",
2924 "braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002925 }
2926 }
2927 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002928 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002929 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002930 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002931
Andy Whitcroftcf655042008-03-04 14:28:20 -08002932 # Check the pre-context.
2933 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2934 #print "APW: ALLOWED: pre<$1>\n";
2935 $allowed = 1;
2936 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002937
2938 my ($level, $endln, @chunks) =
2939 ctx_statement_full($linenr, $realcnt, $-[0]);
2940
Andy Whitcroftcf655042008-03-04 14:28:20 -08002941 # Check the condition.
2942 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002943 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002944 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002945 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002946 }
2947 if (statement_lines($cond) > 1) {
2948 #print "APW: ALLOWED: cond<$cond>\n";
2949 $allowed = 1;
2950 }
2951 if ($block =~/\b(?:if|for|while)\b/) {
2952 #print "APW: ALLOWED: block<$block>\n";
2953 $allowed = 1;
2954 }
2955 if (statement_block_size($block) > 1) {
2956 #print "APW: ALLOWED: lines block<$block>\n";
2957 $allowed = 1;
2958 }
2959 # Check the post-context.
2960 if (defined $chunks[1]) {
2961 my ($cond, $block) = @{$chunks[1]};
2962 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002963 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002964 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002965 if ($block =~ /^\s*\{/) {
2966 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2967 $allowed = 1;
2968 }
2969 }
2970 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07002971 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07002972 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002973
Andy Whitcroftf0556632008-10-15 22:02:23 -07002974 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07002975 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002976 }
2977
Joe Perches000d1cc2011-07-25 17:13:25 -07002978 WARN("BRACES",
2979 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002980 }
2981 }
2982
Andy Whitcroft653d4872007-06-23 17:16:34 -07002983# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002984 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002985 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002986 ERROR("DEPRECATED_INCLUDE",
2987 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002988 }
2989 }
2990
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002991# don't use deprecated functions
2992 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002993 if ($line =~ /\b$func\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07002994 ERROR("DEPRECATED_FUNCTION",
2995 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002996 }
2997 }
2998
2999# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003000 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3001 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003002 WARN("VOLATILE",
3003 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003004 }
3005
Andy Whitcroft00df3442007-06-08 13:47:06 -07003006# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003007 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003008 CHK("REDUNDANT_CODE",
3009 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003010 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003011 }
3012
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003013# check for needless kfree() checks
3014 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3015 my $expr = $1;
3016 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003017 WARN("NEEDLESS_KFREE",
3018 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003019 }
3020 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003021# check for needless usb_free_urb() checks
3022 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3023 my $expr = $1;
3024 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003025 WARN("NEEDLESS_USB_FREE_URB",
3026 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003027 }
3028 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003029
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003030# prefer usleep_range over udelay
3031 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3032 # ignore udelay's < 10, however
3033 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003034 CHK("USLEEP_RANGE",
3035 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003036 }
3037 }
3038
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003039# warn about unexpectedly long msleep's
3040 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3041 if ($1 < 20) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003042 WARN("MSLEEP",
3043 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003044 }
3045 }
3046
Andy Whitcroft00df3442007-06-08 13:47:06 -07003047# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003048# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003049# print "#ifdef in C files should be avoided\n";
3050# print "$herecurr";
3051# $clean = 0;
3052# }
3053
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003054# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003055 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003056 ERROR("SPACING",
3057 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003058 }
3059
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003060# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003061 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3062 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003063 my $which = $1;
3064 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003065 CHK("UNCOMMENTED_DEFINITION",
3066 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003067 }
3068 }
3069# check for memory barriers without a comment.
3070 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3071 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003072 CHK("MEMORY_BARRIER",
3073 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003074 }
3075 }
3076# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003077 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003078 CHK("ARCH_DEFINES",
3079 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003080 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003081
Tobias Klauserd4977c72010-05-24 14:33:30 -07003082# Check that the storage class is at the beginning of a declaration
3083 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003084 WARN("STORAGE_CLASS",
3085 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003086 }
3087
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003088# check the location of the inline attribute, that it is between
3089# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003090 if ($line =~ /\b$Type\s+$Inline\b/ ||
3091 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003092 ERROR("INLINE_LOCATION",
3093 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003094 }
3095
Andy Whitcroft8905a672007-11-28 16:21:06 -08003096# Check for __inline__ and __inline, prefer inline
3097 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003098 WARN("INLINE",
3099 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003100 }
3101
Joe Perches3d130fd2011-01-12 17:00:00 -08003102# Check for __attribute__ packed, prefer __packed
3103 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003104 WARN("PREFER_PACKED",
3105 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003106 }
3107
Joe Perches39b7e282011-07-25 17:13:24 -07003108# Check for __attribute__ aligned, prefer __aligned
3109 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003110 WARN("PREFER_ALIGNED",
3111 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003112 }
3113
Joe Perches8f53a9b2010-03-05 13:43:48 -08003114# check for sizeof(&)
3115 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003116 WARN("SIZEOF_ADDRESS",
3117 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003118 }
3119
Joe Perches428e2fd2011-05-24 17:13:39 -07003120# check for line continuations in quoted strings with odd counts of "
3121 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003122 WARN("LINE_CONTINUATIONS",
3123 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003124 }
3125
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003126# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003127 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003128 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003129 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003130 my $function_name = $1;
3131 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003132
3133 my $s = $stat;
3134 if (defined $cond) {
3135 substr($s, 0, length($cond), '');
3136 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003137 if ($s =~ /^\s*;/ &&
3138 $function_name ne 'uninitialized_var')
3139 {
Joe Perches000d1cc2011-07-25 17:13:25 -07003140 WARN("AVOID_EXTERNS",
3141 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003142 }
3143
3144 if ($paren_space =~ /\n/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003145 WARN("FUNCTION_ARGUMENTS",
3146 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003147 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003148
3149 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3150 $stat =~ /^.\s*extern\s+/)
3151 {
Joe Perches000d1cc2011-07-25 17:13:25 -07003152 WARN("AVOID_EXTERNS",
3153 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003154 }
3155
3156# checks for new __setup's
3157 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3158 my $name = $1;
3159
3160 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003161 CHK("UNDOCUMENTED_SETUP",
3162 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003163 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003164 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003165
3166# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003167 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003168 WARN("UNNECESSARY_CASTS",
3169 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003170 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003171
Joe Perchescaf2a542011-01-12 16:59:56 -08003172# check for multiple semicolons
3173 if ($line =~ /;\s*;\s*$/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003174 WARN("ONE_SEMICOLON",
3175 "Statements terminations use 1 semicolon\n" . $herecurr);
Joe Perchescaf2a542011-01-12 16:59:56 -08003176 }
3177
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003178# check for gcc specific __FUNCTION__
3179 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003180 WARN("USE_FUNC",
3181 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003182 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003183
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003184# check for semaphores initialized locked
3185 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003186 WARN("CONSIDER_COMPLETION",
3187 "consider using a completion\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003188
Andy Whitcroft773647a2008-03-28 14:15:58 -07003189 }
Joe Perches67d0a072011-10-31 17:13:10 -07003190# recommend kstrto* over simple_strto* and strict_strto*
3191 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003192 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003193 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003194 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07003195# check for __initcall(), use device_initcall() explicitly please
3196 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003197 WARN("USE_DEVICE_INITCALL",
3198 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003199 }
Emese Revfy79404842010-03-05 13:43:53 -08003200# check for various ops structs, ensure they are const.
3201 my $struct_ops = qr{acpi_dock_ops|
3202 address_space_operations|
3203 backlight_ops|
3204 block_device_operations|
3205 dentry_operations|
3206 dev_pm_ops|
3207 dma_map_ops|
3208 extent_io_ops|
3209 file_lock_operations|
3210 file_operations|
3211 hv_ops|
3212 ide_dma_ops|
3213 intel_dvo_dev_ops|
3214 item_operations|
3215 iwl_ops|
3216 kgdb_arch|
3217 kgdb_io|
3218 kset_uevent_ops|
3219 lock_manager_operations|
3220 microcode_ops|
3221 mtrr_ops|
3222 neigh_ops|
3223 nlmsvc_binding|
3224 pci_raw_ops|
3225 pipe_buf_operations|
3226 platform_hibernation_ops|
3227 platform_suspend_ops|
3228 proto_ops|
3229 rpc_pipe_ops|
3230 seq_operations|
3231 snd_ac97_build_ops|
3232 soc_pcmcia_socket_ops|
3233 stacktrace_ops|
3234 sysfs_ops|
3235 tty_operations|
3236 usb_mon_operations|
3237 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003238 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003239 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003240 WARN("CONST_STRUCT",
3241 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003242 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003243 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003244
3245# use of NR_CPUS is usually wrong
3246# ignore definitions of NR_CPUS and usage to define arrays as likely right
3247 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003248 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3249 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003250 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3251 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3252 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003253 {
Joe Perches000d1cc2011-07-25 17:13:25 -07003254 WARN("NR_CPUS",
3255 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003256 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003257
3258# check for %L{u,d,i} in strings
3259 my $string;
3260 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3261 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003262 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003263 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003264 WARN("PRINTF_L",
3265 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003266 last;
3267 }
3268 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003269
3270# whine mightly about in_atomic
3271 if ($line =~ /\bin_atomic\s*\(/) {
3272 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003273 ERROR("IN_ATOMIC",
3274 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003275 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003276 WARN("IN_ATOMIC",
3277 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003278 }
3279 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003280
3281# check for lockdep_set_novalidate_class
3282 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3283 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3284 if ($realfile !~ m@^kernel/lockdep@ &&
3285 $realfile !~ m@^include/linux/lockdep@ &&
3286 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003287 ERROR("LOCKDEP",
3288 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003289 }
3290 }
Dave Jones88f88312011-01-12 16:59:59 -08003291
3292 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3293 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003294 WARN("EXPORTED_WORLD_WRITABLE",
3295 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003296 }
Dave Jones309c00c2011-03-22 16:34:44 -07003297
3298 # Check for memset with swapped arguments
3299 if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003300 ERROR("MEMSET",
3301 "memset size is 3rd argument, not the second.\n" . $herecurr);
Dave Jones309c00c2011-03-22 16:34:44 -07003302 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003303 }
3304
3305 # If we have no input at all, then there is nothing to report on
3306 # so just keep quiet.
3307 if ($#rawlines == -1) {
3308 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003309 }
3310
Andy Whitcroft8905a672007-11-28 16:21:06 -08003311 # In mailback mode only produce a report in the negative, for
3312 # things that appear to be patches.
3313 if ($mailback && ($clean == 1 || !$is_patch)) {
3314 exit(0);
3315 }
3316
3317 # This is not a patch, and we are are in 'no-patch' mode so
3318 # just keep quiet.
3319 if (!$chk_patch && !$is_patch) {
3320 exit(0);
3321 }
3322
3323 if (!$is_patch) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003324 ERROR("NOT_UNIFIED_DIFF",
3325 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003326 }
3327 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003328 ERROR("MISSING_SIGN_OFF",
3329 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003330 }
3331
Andy Whitcroft8905a672007-11-28 16:21:06 -08003332 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003333 if ($summary && !($clean == 1 && $quiet == 1)) {
3334 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003335 print "total: $cnt_error errors, $cnt_warn warnings, " .
3336 (($check)? "$cnt_chk checks, " : "") .
3337 "$cnt_lines lines checked\n";
3338 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003339 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003340
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003341 if ($quiet == 0) {
3342 # If there were whitespace errors which cleanpatch can fix
3343 # then suggest that.
3344 if ($rpt_cleaners) {
3345 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3346 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003347 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003348 }
3349 }
3350
Joe Perches000d1cc2011-07-25 17:13:25 -07003351 if (keys %ignore_type) {
3352 print "NOTE: Ignored message types:";
3353 foreach my $ignore (sort keys %ignore_type) {
3354 print " $ignore";
3355 }
3356 print "\n";
3357 print "\n" if ($quiet == 0);
3358 }
3359
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003360 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003361 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003362 }
3363 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc2011-07-25 17:13:25 -07003364 print << "EOM";
3365$vname has style problems, please review.
3366
3367If any of these errors are false positives, please report
3368them to the maintainer, see CHECKPATCH in MAINTAINERS.
3369EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003370 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003371
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003372 return $clean;
3373}