blob: 06e22caa5692d81a482e1254e470b0129e1050d7 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-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 Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070012
Joe Perches000d1cc12011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b5b2007-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 Perches000d1cc12011-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 Perches000d1cc12011-07-25 17:13:25 -070032my %ignore_type = ();
33my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070034my $help = 0;
Joe Perches000d1cc12011-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 Perches000d1cc12011-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 Perches000d1cc12011-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 Whitcroft0a920b5b2007-06-01 00:46:48 -070098GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Perches000d1cc12011-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700127 exit(1);
128}
129
Joe Perches000d1cc12011-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700365 }
366 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800367 close($REMOVE);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700368}
369
Andy Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700416 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700417 return 1;
Joe Perches000d1cc12011-07-25 17:13:25 -0700418 }
Andy Whitcroft0a920b5b2007-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 Perches000d1cc12011-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700603 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700604 } elsif ($sanitise_quote eq $c) {
605 $sanitise_quote = '';
Andy Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700616 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700617 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800679 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
680 $level++;
681 $type = '#';
682 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800683 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800684 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800685 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800686 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800687
Andy Whitcroft773647a2008-03-28 14:15:58 -0700688 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800689
690 # Handle nested #if/#else.
691 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
692 push(@stack, [ $type, $level ]);
693 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
694 ($type, $level) = @{$stack[$#stack - 1]};
695 } elsif ($remainder =~ /^#\s*endif\b/) {
696 ($type, $level) = @{pop(@stack)};
697 }
698
Andy Whitcroft8905a672007-11-28 16:21:06 -0800699 # Statement ends at the ';' or a close '}' at the
700 # outermost level.
701 if ($level == 0 && $c eq ';') {
702 last;
703 }
704
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800705 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700706 if ($level == 0 && $coff_set == 0 &&
707 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
708 $remainder =~ /^(else)(?:\s|{)/ &&
709 $remainder !~ /^else\s+if\b/) {
710 $coff = $off + length($1) - 1;
711 $coff_set = 1;
712 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
713 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800714 }
715
Andy Whitcroft8905a672007-11-28 16:21:06 -0800716 if (($type eq '' || $type eq '(') && $c eq '(') {
717 $level++;
718 $type = '(';
719 }
720 if ($type eq '(' && $c eq ')') {
721 $level--;
722 $type = ($level != 0)? '(' : '';
723
724 if ($level == 0 && $coff < $soff) {
725 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700726 $coff_set = 1;
727 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800728 }
729 }
730 if (($type eq '' || $type eq '{') && $c eq '{') {
731 $level++;
732 $type = '{';
733 }
734 if ($type eq '{' && $c eq '}') {
735 $level--;
736 $type = ($level != 0)? '{' : '';
737
738 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700739 if (substr($blk, $off + 1, 1) eq ';') {
740 $off++;
741 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800742 last;
743 }
744 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800745 # Preprocessor commands end at the newline unless escaped.
746 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
747 $level--;
748 $type = '';
749 $off++;
750 last;
751 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800752 $off++;
753 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700754 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800755 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700756 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800757 $line++;
758 $remain--;
759 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800760
761 my $statement = substr($blk, $soff, $off - $soff + 1);
762 my $condition = substr($blk, $soff, $coff - $soff + 1);
763
764 #warn "STATEMENT<$statement>\n";
765 #warn "CONDITION<$condition>\n";
766
Andy Whitcroft773647a2008-03-28 14:15:58 -0700767 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800768
769 return ($statement, $condition,
770 $line, $remain + 1, $off - $loff + 1, $level);
771}
772
Andy Whitcroftcf655042008-03-04 14:28:20 -0800773sub statement_lines {
774 my ($stmt) = @_;
775
776 # Strip the diff line prefixes and rip blank lines at start and end.
777 $stmt =~ s/(^|\n)./$1/g;
778 $stmt =~ s/^\s*//;
779 $stmt =~ s/\s*$//;
780
781 my @stmt_lines = ($stmt =~ /\n/g);
782
783 return $#stmt_lines + 2;
784}
785
786sub statement_rawlines {
787 my ($stmt) = @_;
788
789 my @stmt_lines = ($stmt =~ /\n/g);
790
791 return $#stmt_lines + 2;
792}
793
794sub statement_block_size {
795 my ($stmt) = @_;
796
797 $stmt =~ s/(^|\n)./$1/g;
798 $stmt =~ s/^\s*{//;
799 $stmt =~ s/}\s*$//;
800 $stmt =~ s/^\s*//;
801 $stmt =~ s/\s*$//;
802
803 my @stmt_lines = ($stmt =~ /\n/g);
804 my @stmt_statements = ($stmt =~ /;/g);
805
806 my $stmt_lines = $#stmt_lines + 2;
807 my $stmt_statements = $#stmt_statements + 1;
808
809 if ($stmt_lines > $stmt_statements) {
810 return $stmt_lines;
811 } else {
812 return $stmt_statements;
813 }
814}
815
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800816sub ctx_statement_full {
817 my ($linenr, $remain, $off) = @_;
818 my ($statement, $condition, $level);
819
820 my (@chunks);
821
Andy Whitcroftcf655042008-03-04 14:28:20 -0800822 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800823 ($statement, $condition, $linenr, $remain, $off, $level) =
824 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700825 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800826 push(@chunks, [ $condition, $statement ]);
827 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
828 return ($level, $linenr, @chunks);
829 }
830
831 # Pull in the following conditional/block pairs and see if they
832 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800833 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800834 ($statement, $condition, $linenr, $remain, $off, $level) =
835 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800836 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700837 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800838 #print "C: push\n";
839 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800840 }
841
842 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800843}
844
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700845sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700846 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700847 my $line;
848 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700849 my $blk = '';
850 my @o;
851 my @c;
852 my @res = ();
853
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700854 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800855 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700856 for ($line = $start; $remain > 0; $line++) {
857 next if ($rawlines[$line] =~ /^-/);
858 $remain--;
859
860 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800861
862 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700863 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800864 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700865 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800866 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700867 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800868 $level = pop(@stack);
869 }
870
Andy Whitcroft01464f32010-10-26 14:23:19 -0700871 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700872 ##print "C<$c>L<$level><$open$close>O<$off>\n";
873 if ($off > 0) {
874 $off--;
875 next;
876 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700877
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700878 if ($c eq $close && $level > 0) {
879 $level--;
880 last if ($level == 0);
881 } elsif ($c eq $open) {
882 $level++;
883 }
884 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700885
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700886 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700887 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700888 }
889
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700890 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700891 }
892
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700893 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700894}
895sub ctx_block_outer {
896 my ($linenr, $remain) = @_;
897
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700898 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
899 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700900}
901sub ctx_block {
902 my ($linenr, $remain) = @_;
903
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700904 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
905 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700906}
907sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700908 my ($linenr, $remain, $off) = @_;
909
910 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
911 return @r;
912}
913sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700914 my ($linenr, $remain) = @_;
915
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700916 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700917}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700918sub ctx_statement_level {
919 my ($linenr, $remain, $off) = @_;
920
921 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
922}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700923
924sub ctx_locate_comment {
925 my ($first_line, $end_line) = @_;
926
927 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700928 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700929 return $current_comment if (defined $current_comment);
930
931 # Look through the context and try and figure out if there is a
932 # comment.
933 my $in_comment = 0;
934 $current_comment = '';
935 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700936 my $line = $rawlines[$linenr - 1];
937 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700938 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
939 $in_comment = 1;
940 }
941 if ($line =~ m@/\*@) {
942 $in_comment = 1;
943 }
944 if (!$in_comment && $current_comment ne '') {
945 $current_comment = '';
946 }
947 $current_comment .= $line . "\n" if ($in_comment);
948 if ($line =~ m@\*/@) {
949 $in_comment = 0;
950 }
951 }
952
953 chomp($current_comment);
954 return($current_comment);
955}
956sub ctx_has_comment {
957 my ($first_line, $end_line) = @_;
958 my $cmt = ctx_locate_comment($first_line, $end_line);
959
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700960 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700961 ##print "CMMT: $cmt\n";
962
963 return ($cmt ne '');
964}
965
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700966sub raw_line {
967 my ($linenr, $cnt) = @_;
968
969 my $offset = $linenr - 1;
970 $cnt++;
971
972 my $line;
973 while ($cnt) {
974 $line = $rawlines[$offset++];
975 next if (defined($line) && $line =~ /^-/);
976 $cnt--;
977 }
978
979 return $line;
980}
981
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700982sub cat_vet {
983 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700984 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700985
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700986 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700987 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
988 $res .= $1;
989 if ($2 ne '') {
990 $coded = sprintf("^%c", unpack('C', $2) + 64);
991 $res .= $coded;
992 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700993 }
994 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700995
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700996 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700997}
998
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800999my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001000my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001001my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001002my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001003
1004sub annotate_reset {
1005 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001006 $av_pending = '_';
1007 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001008 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001009}
1010
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001011sub annotate_values {
1012 my ($stream, $type) = @_;
1013
1014 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001015 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001016 my $cur = $stream;
1017
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001018 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001019
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001020 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001021 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001022 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001023 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001024 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001025 print "WS($1)\n" if ($dbg_values > 1);
1026 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001027 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001028 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001029 }
1030
Florian Micklerc023e4732011-01-12 16:59:58 -08001031 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001032 print "CAST($1)\n" if ($dbg_values > 1);
1033 push(@av_paren_type, $type);
1034 $type = 'C';
1035
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001036 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001037 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001038 $type = 'T';
1039
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001040 } elsif ($cur =~ /^($Modifier)\s*/) {
1041 print "MODIFIER($1)\n" if ($dbg_values > 1);
1042 $type = 'T';
1043
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001044 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001045 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001046 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001047 push(@av_paren_type, $type);
1048 if ($2 ne '') {
1049 $av_pending = 'N';
1050 }
1051 $type = 'E';
1052
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001053 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001054 print "UNDEF($1)\n" if ($dbg_values > 1);
1055 $av_preprocessor = 1;
1056 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001057
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001058 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001059 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001060 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001061
1062 push(@av_paren_type, $type);
1063 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001064 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001065
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001066 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001067 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1068 $av_preprocessor = 1;
1069
1070 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1071
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001072 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001073
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001074 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001075 print "PRE_END($1)\n" if ($dbg_values > 1);
1076
1077 $av_preprocessor = 1;
1078
1079 # Assume all arms of the conditional end as this
1080 # one does, and continue as if the #endif was not here.
1081 pop(@av_paren_type);
1082 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001083 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001084
1085 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001087
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001088 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1089 print "ATTR($1)\n" if ($dbg_values > 1);
1090 $av_pending = $type;
1091 $type = 'N';
1092
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001093 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001094 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001095 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001096 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001097 }
1098 $type = 'N';
1099
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001100 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001101 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001102 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001103 $type = 'N';
1104
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001105 } elsif ($cur =~/^(case)/o) {
1106 print "CASE($1)\n" if ($dbg_values > 1);
1107 $av_pend_colon = 'C';
1108 $type = 'N';
1109
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001110 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001111 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001112 $type = 'N';
1113
1114 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001115 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001116 push(@av_paren_type, $av_pending);
1117 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001118 $type = 'N';
1119
1120 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001121 my $new_type = pop(@av_paren_type);
1122 if ($new_type ne '_') {
1123 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001124 print "PAREN('$1') -> $type\n"
1125 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001126 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001127 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001128 }
1129
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001130 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001131 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001132 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001133 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001134
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001135 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1136 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001137 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001138 } elsif ($type eq 'E') {
1139 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001140 }
1141 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1142 $type = 'V';
1143
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001144 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001145 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001146 $type = 'V';
1147
1148 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001149 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001150 $type = 'N';
1151
Andy Whitcroftcf655042008-03-04 14:28:20 -08001152 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001153 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001154 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001155 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001156
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001157 } elsif ($cur =~/^(,)/) {
1158 print "COMMA($1)\n" if ($dbg_values > 1);
1159 $type = 'C';
1160
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001161 } elsif ($cur =~ /^(\?)/o) {
1162 print "QUESTION($1)\n" if ($dbg_values > 1);
1163 $type = 'N';
1164
1165 } elsif ($cur =~ /^(:)/o) {
1166 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1167
1168 substr($var, length($res), 1, $av_pend_colon);
1169 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1170 $type = 'E';
1171 } else {
1172 $type = 'N';
1173 }
1174 $av_pend_colon = 'O';
1175
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001176 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001177 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001178 $type = 'N';
1179
Andy Whitcroft0d413862008-10-15 22:02:16 -07001180 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001181 my $variant;
1182
1183 print "OPV($1)\n" if ($dbg_values > 1);
1184 if ($type eq 'V') {
1185 $variant = 'B';
1186 } else {
1187 $variant = 'U';
1188 }
1189
1190 substr($var, length($res), 1, $variant);
1191 $type = 'N';
1192
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001194 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001195 if ($1 ne '++' && $1 ne '--') {
1196 $type = 'N';
1197 }
1198
1199 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001200 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001201 }
1202 if (defined $1) {
1203 $cur = substr($cur, length($1));
1204 $res .= $type x length($1);
1205 }
1206 }
1207
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001208 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001209}
1210
Andy Whitcroft8905a672007-11-28 16:21:06 -08001211sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001212 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001213 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001214 ^(?:
1215 $Modifier|
1216 $Storage|
1217 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001218 DEFINE_\S+
1219 )$|
1220 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001221 goto|
1222 return|
1223 case|
1224 else|
1225 asm|__asm__|
1226 do
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001227 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001228 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001229 )}x;
1230 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1231 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001232 # Check for modifiers.
1233 $possible =~ s/\s*$Storage\s*//g;
1234 $possible =~ s/\s*$Sparse\s*//g;
1235 if ($possible =~ /^\s*$/) {
1236
1237 } elsif ($possible =~ /\s/) {
1238 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001239 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001240 if ($modifier !~ $notPermitted) {
1241 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1242 push(@modifierList, $modifier);
1243 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001244 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001245
1246 } else {
1247 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1248 push(@typeList, $possible);
1249 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001250 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001251 } else {
1252 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001253 }
1254}
1255
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001256my $prefix = '';
1257
Joe Perches000d1cc12011-07-25 17:13:25 -07001258sub show_type {
1259 return !defined $ignore_type{$_[0]};
1260}
1261
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001262sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001263 if (!show_type($_[1]) ||
1264 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001265 return 0;
1266 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001267 my $line;
1268 if ($show_types) {
1269 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1270 } else {
1271 $line = "$prefix$_[0]: $_[2]\n";
1272 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001273 $line = (split('\n', $line))[0] . "\n" if ($terse);
1274
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001275 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001276
1277 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001278}
1279sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001280 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001281}
Joe Perches000d1cc12011-07-25 17:13:25 -07001282
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001283sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001284 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001285 our $clean = 0;
1286 our $cnt_error++;
1287 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001288}
1289sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001290 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001291 our $clean = 0;
1292 our $cnt_warn++;
1293 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001294}
1295sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001296 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001297 our $clean = 0;
1298 our $cnt_chk++;
1299 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001300}
1301
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001302sub check_absolute_file {
1303 my ($absolute, $herecurr) = @_;
1304 my $file = $absolute;
1305
1306 ##print "absolute<$absolute>\n";
1307
1308 # See if any suffix of this path is a path within the tree.
1309 while ($file =~ s@^[^/]*/@@) {
1310 if (-f "$root/$file") {
1311 ##print "file<$file>\n";
1312 last;
1313 }
1314 }
1315 if (! -f _) {
1316 return 0;
1317 }
1318
1319 # It is, so see if the prefix is acceptable.
1320 my $prefix = $absolute;
1321 substr($prefix, -length($file)) = '';
1322
1323 ##print "prefix<$prefix>\n";
1324 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001325 WARN("USE_RELATIVE_PATH",
1326 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001327 }
1328}
1329
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001330sub process {
1331 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001332
1333 my $linenr=0;
1334 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001335 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001336 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001337 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001338
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001339 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001340 my $indent;
1341 my $previndent=0;
1342 my $stashindent=0;
1343
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001344 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001345 my $signoff = 0;
1346 my $is_patch = 0;
1347
Joe Perches15662b32011-10-31 17:13:12 -07001348 my $in_header_lines = 1;
1349 my $in_commit_log = 0; #Scanning lines before patch
1350
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001351 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001352 our $cnt_lines = 0;
1353 our $cnt_error = 0;
1354 our $cnt_warn = 0;
1355 our $cnt_chk = 0;
1356
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001357 # Trace the real file/line as we go.
1358 my $realfile = '';
1359 my $realline = 0;
1360 my $realcnt = 0;
1361 my $here = '';
1362 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001363 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001364 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001365 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001366
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001367 my $prev_values = 'E';
1368
1369 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001370 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001371 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001372 my %suppress_export;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001373
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001374 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001375 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001376 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001377 my @setup_docs = ();
1378 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001379
1380 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001381 my $line;
1382 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001383 $linenr++;
1384 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001385
Andy Whitcroft773647a2008-03-28 14:15:58 -07001386 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001387 $setup_docs = 0;
1388 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1389 $setup_docs = 1;
1390 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001391 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001392 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001393 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1394 $realline=$1-1;
1395 if (defined $2) {
1396 $realcnt=$3+1;
1397 } else {
1398 $realcnt=1+1;
1399 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001400 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001401
1402 # Guestimate if this is a continuing comment. Run
1403 # the context looking for a comment "edge". If this
1404 # edge is a close comment then we must be in a comment
1405 # at context start.
1406 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001407 my $cnt = $realcnt;
1408 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1409 next if (defined $rawlines[$ln - 1] &&
1410 $rawlines[$ln - 1] =~ /^-/);
1411 $cnt--;
1412 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001413 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001414 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1415 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1416 ($edge) = $1;
1417 last;
1418 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001419 }
1420 if (defined $edge && $edge eq '*/') {
1421 $in_comment = 1;
1422 }
1423
1424 # Guestimate if this is a continuing comment. If this
1425 # is the start of a diff block and this line starts
1426 # ' *' then it is very likely a comment.
1427 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001428 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001429 {
1430 $in_comment = 1;
1431 }
1432
1433 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1434 sanitise_line_reset($in_comment);
1435
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001436 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001437 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001438 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001439 $line = sanitise_line($rawline);
1440 }
1441 push(@lines, $line);
1442
1443 if ($realcnt > 1) {
1444 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1445 } else {
1446 $realcnt = 0;
1447 }
1448
1449 #print "==>$rawline\n";
1450 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001451
1452 if ($setup_docs && $line =~ /^\+/) {
1453 push(@setup_docs, $line);
1454 }
1455 }
1456
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001457 $prefix = '';
1458
Andy Whitcroft773647a2008-03-28 14:15:58 -07001459 $realcnt = 0;
1460 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001461 foreach my $line (@lines) {
1462 $linenr++;
1463
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001464 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001465
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001466#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001467 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001468 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001469 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001470 $realline=$1-1;
1471 if (defined $2) {
1472 $realcnt=$3+1;
1473 } else {
1474 $realcnt=1+1;
1475 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001476 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001477 $prev_values = 'E';
1478
Andy Whitcroft773647a2008-03-28 14:15:58 -07001479 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001480 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001481 %suppress_export = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001482 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001483
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001484# track the line number as we move through the hunk, note that
1485# new versions of GNU diff omit the leading space on completely
1486# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001487 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001488 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001489 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001490
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001491 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001492 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001493
1494 # Track the previous line.
1495 ($prevline, $stashline) = ($stashline, $line);
1496 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001497 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1498
Andy Whitcroft773647a2008-03-28 14:15:58 -07001499 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001500
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001501 } elsif ($realcnt == 1) {
1502 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001503 }
1504
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001505 my $hunk_line = ($realcnt != 0);
1506
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001507#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001508 $prefix = "$filename:$realline: " if ($emacs && $file);
1509 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1510
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001511 $here = "#$linenr: " if (!$file);
1512 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001513
1514 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001515 if ($line =~ /^diff --git.*?(\S+)$/) {
1516 $realfile = $1;
1517 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001518 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001519 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001520 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001521 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001522 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001523
1524 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001525 if (!$file && $tree && $p1_prefix ne '' &&
1526 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001527 WARN("PATCH_PREFIX",
1528 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001529 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001530
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001531 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001532 ERROR("MODIFIED_INCLUDE_ASM",
1533 "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 -07001534 }
1535 next;
1536 }
1537
Randy Dunlap389834b2007-06-08 13:47:03 -07001538 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001539
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001540 my $hereline = "$here\n$rawline\n";
1541 my $herecurr = "$here\n$rawline\n";
1542 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001543
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001544 $cnt_lines++ if ($realcnt != 0);
1545
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001546# Check for incorrect file permissions
1547 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1548 my $permhere = $here . "FILE: $realfile\n";
1549 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001550 ERROR("EXECUTE_PERMISSIONS",
1551 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001552 }
1553 }
1554
Joe Perches20112472011-07-25 17:13:23 -07001555# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001556 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001557 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001558 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001559 }
1560
1561# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001562 if (!$in_header_lines &&
1563 $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
Joe Perches20112472011-07-25 17:13:23 -07001564 my $space_before = $1;
1565 my $sign_off = $2;
1566 my $space_after = $3;
1567 my $email = $4;
1568 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1569
1570 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001571 WARN("BAD_SIGN_OFF",
1572 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001573 }
Joe Perches20112472011-07-25 17:13:23 -07001574 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001575 WARN("BAD_SIGN_OFF",
1576 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001577 }
1578 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001579 WARN("BAD_SIGN_OFF",
1580 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001581 }
1582
1583 my ($email_name, $email_address, $comment) = parse_email($email);
1584 my $suggested_email = format_email(($email_name, $email_address));
1585 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001586 ERROR("BAD_SIGN_OFF",
1587 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001588 } else {
1589 my $dequoted = $suggested_email;
1590 $dequoted =~ s/^"//;
1591 $dequoted =~ s/" </ </;
1592 # Don't force email to have quotes
1593 # Allow just an angle bracketed address
1594 if ("$dequoted$comment" ne $email &&
1595 "<$email_address>$comment" ne $email &&
1596 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001597 WARN("BAD_SIGN_OFF",
1598 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001599 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001600 }
1601 }
1602
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001603# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001604 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001605 ERROR("CORRUPTED_PATCH",
1606 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001607 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001608 }
1609
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001610# Check for absolute kernel paths.
1611 if ($tree) {
1612 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1613 my $file = $1;
1614
1615 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1616 check_absolute_file($1, $herecurr)) {
1617 #
1618 } else {
1619 check_absolute_file($file, $herecurr);
1620 }
1621 }
1622 }
1623
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001624# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1625 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001626 $rawline !~ m/^$UTF8*$/) {
1627 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1628
1629 my $blank = copy_spacing($rawline);
1630 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1631 my $hereptr = "$hereline$ptr\n";
1632
Joe Perches34d99212011-07-25 17:13:26 -07001633 CHK("INVALID_UTF8",
1634 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001635 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001636
Joe Perches15662b32011-10-31 17:13:12 -07001637# Check if it's the start of a commit log
1638# (not a header line and we haven't seen the patch filename)
1639 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001640 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001641 $in_header_lines = 0;
1642 $in_commit_log = 1;
1643 }
1644
1645# Still not yet in a patch, check for any UTF-8
1646 if ($in_commit_log && $realfile =~ /^$/ &&
1647 $rawline =~ /$NON_ASCII_UTF8/) {
1648 CHK("UTF8_BEFORE_PATCH",
1649 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1650 }
1651
Andy Whitcroft306708542008-10-15 22:02:28 -07001652# ignore non-hunk lines and lines being removed
1653 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001654
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001655#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001656 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001657 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001658 ERROR("DOS_LINE_ENDINGS",
1659 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001660
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001661 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1662 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001663 ERROR("TRAILING_WHITESPACE",
1664 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001665 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001666 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001667
Andi Kleen33549572010-05-24 14:33:29 -07001668# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001669# Only applies when adding the entry originally, after that we do not have
1670# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001671 if ($realfile =~ /Kconfig/ &&
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001672 $line =~ /\+\s*(?:---)?help(?:---)?$/) {
Andi Kleen33549572010-05-24 14:33:29 -07001673 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001674 my $cnt = $realcnt;
1675 my $ln = $linenr + 1;
1676 my $f;
1677 my $is_end = 0;
1678 while ($cnt > 0 && defined $lines[$ln - 1]) {
1679 $f = $lines[$ln - 1];
1680 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1681 $is_end = $lines[$ln - 1] =~ /^\+/;
1682 $ln++;
1683
1684 next if ($f =~ /^-/);
1685 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001686 $f =~ s/#.*//;
1687 $f =~ s/^\s+//;
1688 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001689 if ($f =~ /^\s*config\s/) {
1690 $is_end = 1;
1691 last;
1692 }
Andi Kleen33549572010-05-24 14:33:29 -07001693 $length++;
1694 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001695 WARN("CONFIG_DESCRIPTION",
1696 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001697 #print "is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001698 }
1699
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001700 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1701 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1702 my $flag = $1;
1703 my $replacement = {
1704 'EXTRA_AFLAGS' => 'asflags-y',
1705 'EXTRA_CFLAGS' => 'ccflags-y',
1706 'EXTRA_CPPFLAGS' => 'cppflags-y',
1707 'EXTRA_LDFLAGS' => 'ldflags-y',
1708 };
1709
1710 WARN("DEPRECATED_VARIABLE",
1711 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1712 }
1713
Andy Whitcroft5368df202008-10-15 22:02:27 -07001714# check we are in a valid source file if not then ignore this hunk
1715 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1716
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001717#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001718 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001719 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001720 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001721 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001722 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001723 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001724 WARN("LONG_LINE",
1725 "line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001726 }
1727
Joe Perches5e79d962010-03-05 13:43:55 -08001728# check for spaces before a quoted newline
1729 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001730 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1731 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001732 }
1733
Andy Whitcroft8905a672007-11-28 16:21:06 -08001734# check for adding lines without a newline.
1735 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001736 WARN("MISSING_EOF_NEWLINE",
1737 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001738 }
1739
Mike Frysinger42e41c52009-09-21 17:04:40 -07001740# Blackfin: use hi/lo macros
1741 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1742 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1743 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001744 ERROR("LO_MACRO",
1745 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001746 }
1747 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1748 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001749 ERROR("HI_MACRO",
1750 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001751 }
1752 }
1753
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001754# check we are in a valid source file C or perl if not then ignore this hunk
1755 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001756
1757# at the beginning of a line any tabs must come first and anything
1758# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001759 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1760 $rawline =~ /^\+\s* \s*/) {
1761 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001762 ERROR("CODE_INDENT",
1763 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001764 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001765 }
1766
Alberto Panizzo08e44362010-03-05 13:43:54 -08001767# check for space before tabs.
1768 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1769 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001770 WARN("SPACE_BEFORE_TAB",
1771 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001772 }
1773
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001774# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001775# Exceptions:
1776# 1) within comments
1777# 2) indented preprocessor commands
1778# 3) hanging labels
1779 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001780 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001781 WARN("LEADING_SPACE",
1782 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001783 }
1784
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001785# check we are in a valid C source file if not then ignore this hunk
1786 next if ($realfile !~ /\.(h|c)$/);
1787
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001788# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001789 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001790 WARN("CVS_KEYWORD",
1791 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001792 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001793
Mike Frysinger42e41c52009-09-21 17:04:40 -07001794# Blackfin: don't use __builtin_bfin_[cs]sync
1795 if ($line =~ /__builtin_bfin_csync/) {
1796 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001797 ERROR("CSYNC",
1798 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001799 }
1800 if ($line =~ /__builtin_bfin_ssync/) {
1801 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001802 ERROR("SSYNC",
1803 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001804 }
1805
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001806# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001807 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1808 $realline_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001809 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001810 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001811 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001812 $stat =~ s/\n./\n /g;
1813 $cond =~ s/\n./\n /g;
1814
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001815#print "stat<$stat>\n";
1816
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001817 # Find the real next line.
1818 $realline_next = $line_nr_next;
1819 if (defined $realline_next &&
1820 (!defined $lines[$realline_next - 1] ||
1821 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1822 $realline_next++;
1823 }
1824
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001825 my $s = $stat;
1826 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001827
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001828 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001829 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001830
1831 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001832 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001833
Andy Whitcroft463f2862009-09-21 17:04:34 -07001834 } elsif ($s =~ /^.\s*else\b/s) {
1835
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001836 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001837 } 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 -07001838 my $type = $1;
1839 $type =~ s/\s+/ /g;
1840 possible($type, "A:" . $s);
1841
Andy Whitcroft8905a672007-11-28 16:21:06 -08001842 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001843 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001844 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001845 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001846
1847 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001848 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001849 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001850 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001851
1852 # Check for any sort of function declaration.
1853 # int foo(something bar, other baz);
1854 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001855 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 -08001856 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001857
Andy Whitcroftcf655042008-03-04 14:28:20 -08001858 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001859 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001860 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001861
Andy Whitcroft8905a672007-11-28 16:21:06 -08001862 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001863 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001864
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001865 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001866 }
1867 }
1868 }
1869
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001870 }
1871
Andy Whitcroft653d4872007-06-23 17:16:34 -07001872#
1873# Checks which may be anchored in the context.
1874#
1875
1876# Check for switch () and associated case and default
1877# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001878 if ($line=~/\bswitch\s*\(.*\)/) {
1879 my $err = '';
1880 my $sep = '';
1881 my @ctx = ctx_block_outer($linenr, $realcnt);
1882 shift(@ctx);
1883 for my $ctx (@ctx) {
1884 my ($clen, $cindent) = line_stats($ctx);
1885 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1886 $indent != $cindent) {
1887 $err .= "$sep$ctx\n";
1888 $sep = '';
1889 } else {
1890 $sep = "[...]\n";
1891 }
1892 }
1893 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07001894 ERROR("SWITCH_CASE_INDENT_LEVEL",
1895 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001896 }
1897 }
1898
1899# if/while/etc brace do not go on next line, unless defining a do while loop,
1900# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001901 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001902 my $pre_ctx = "$1$2";
1903
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001904 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001905 my $ctx_cnt = $realcnt - $#ctx - 1;
1906 my $ctx = join("\n", @ctx);
1907
Andy Whitcroft548596d2008-07-23 21:29:01 -07001908 my $ctx_ln = $linenr;
1909 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001910
Andy Whitcroft548596d2008-07-23 21:29:01 -07001911 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1912 defined $lines[$ctx_ln - 1] &&
1913 $lines[$ctx_ln - 1] =~ /^-/)) {
1914 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1915 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001916 $ctx_ln++;
1917 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001918
Andy Whitcroft53210162008-07-23 21:29:03 -07001919 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1920 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001921
1922 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001923 ERROR("OPEN_BRACE",
1924 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001925 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001926 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001927 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1928 $ctx =~ /\)\s*\;\s*$/ &&
1929 defined $lines[$ctx_ln - 1])
1930 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001931 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1932 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001933 WARN("TRAILING_SEMICOLON",
1934 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001935 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001936 }
1937 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001938 }
1939
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001940# Check relative indent for conditionals and blocks.
1941 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1942 my ($s, $c) = ($stat, $cond);
1943
1944 substr($s, 0, length($c), '');
1945
1946 # Make sure we remove the line prefixes as we have
1947 # none on the first line, and are going to readd them
1948 # where necessary.
1949 $s =~ s/\n./\n/gs;
1950
1951 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001952 my @newlines = ($c =~ /\n/gs);
1953 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001954
1955 # We want to check the first line inside the block
1956 # starting at the end of the conditional, so remove:
1957 # 1) any blank line termination
1958 # 2) any opening brace { on end of the line
1959 # 3) any do (...) {
1960 my $continuation = 0;
1961 my $check = 0;
1962 $s =~ s/^.*\bdo\b//;
1963 $s =~ s/^\s*{//;
1964 if ($s =~ s/^\s*\\//) {
1965 $continuation = 1;
1966 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001967 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001968 $check = 1;
1969 $cond_lines++;
1970 }
1971
1972 # Also ignore a loop construct at the end of a
1973 # preprocessor statement.
1974 if (($prevline =~ /^.\s*#\s*define\s/ ||
1975 $prevline =~ /\\\s*$/) && $continuation == 0) {
1976 $check = 0;
1977 }
1978
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001979 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001980 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001981 while ($cond_ptr != $cond_lines) {
1982 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001983
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001984 # If we see an #else/#elif then the code
1985 # is not linear.
1986 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1987 $check = 0;
1988 }
1989
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001990 # Ignore:
1991 # 1) blank lines, they should be at 0,
1992 # 2) preprocessor lines, and
1993 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001994 if ($continuation ||
1995 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001996 $s =~ /^\s*#\s*?/ ||
1997 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001998 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001999 if ($s =~ s/^.*?\n//) {
2000 $cond_lines++;
2001 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002002 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002003 }
2004
2005 my (undef, $sindent) = line_stats("+" . $s);
2006 my $stat_real = raw_line($linenr, $cond_lines);
2007
2008 # Check if either of these lines are modified, else
2009 # this is not this patch's fault.
2010 if (!defined($stat_real) ||
2011 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2012 $check = 0;
2013 }
2014 if (defined($stat_real) && $cond_lines > 1) {
2015 $stat_real = "[...]\n$stat_real";
2016 }
2017
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002018 #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 -07002019
2020 if ($check && (($sindent % 8) != 0 ||
2021 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002022 WARN("SUSPECT_CODE_INDENT",
2023 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002024 }
2025 }
2026
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002027 # Track the 'values' across context and added lines.
2028 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002029 my ($curr_values, $curr_vars) =
2030 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002031 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002032 if ($dbg_values) {
2033 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002034 print "$linenr > .$outline\n";
2035 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002036 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002037 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002038 $prev_values = substr($curr_values, -1);
2039
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002040#ignore lines not being added
2041 if ($line=~/^[^\+]/) {next;}
2042
Andy Whitcroft653d4872007-06-23 17:16:34 -07002043# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002044 if ($dbg_type) {
2045 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002046 ERROR("TEST_TYPE",
2047 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002048 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002049 ERROR("TEST_NOT_TYPE",
2050 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002051 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002052 next;
2053 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002054# TEST: allow direct testing of the attribute matcher.
2055 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002056 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002057 ERROR("TEST_ATTR",
2058 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002059 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002060 ERROR("TEST_NOT_ATTR",
2061 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002062 }
2063 next;
2064 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002065
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002066# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002067 if ($line =~ /^.\s*{/ &&
2068 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002069 ERROR("OPEN_BRACE",
2070 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002071 }
2072
Andy Whitcroft653d4872007-06-23 17:16:34 -07002073#
2074# Checks which are anchored on the added line.
2075#
2076
2077# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002078 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002079 my $path = $1;
2080 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002081 ERROR("MALFORMED_INCLUDE",
2082 "malformed #include filename\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002083 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002084 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002085 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002086
2087# no C99 // comments
2088 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002089 ERROR("C99_COMMENTS",
2090 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002091 }
2092 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002093 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002094 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002095
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002096# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2097# the whole statement.
2098#print "APW <$lines[$realline_next - 1]>\n";
2099 if (defined $realline_next &&
2100 exists $lines[$realline_next - 1] &&
2101 !defined $suppress_export{$realline_next} &&
2102 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2103 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002104 # Handle definitions which produce identifiers with
2105 # a prefix:
2106 # XXX(foo);
2107 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002108 my $name = $1;
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002109 if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ &&
2110 $name =~ /^${Ident}_$2/) {
2111#print "FOO C name<$name>\n";
2112 $suppress_export{$realline_next} = 1;
2113
2114 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002115 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002116 ^.DEFINE_$Ident\(\Q$name\E\)|
2117 ^.DECLARE_$Ident\(\Q$name\E\)|
2118 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002119 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2120 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002121 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002122#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2123 $suppress_export{$realline_next} = 2;
2124 } else {
2125 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002126 }
2127 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002128 if (!defined $suppress_export{$linenr} &&
2129 $prevline =~ /^.\s*$/ &&
2130 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2131 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2132#print "FOO B <$lines[$linenr - 1]>\n";
2133 $suppress_export{$linenr} = 2;
2134 }
2135 if (defined $suppress_export{$linenr} &&
2136 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002137 WARN("EXPORT_SYMBOL",
2138 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002139 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002140
Joe Eloff5150bda2010-08-09 17:21:00 -07002141# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002142 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002143 ERROR("GLOBAL_INITIALISERS",
2144 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002145 $herecurr);
2146 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002147# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002148 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002149 ERROR("INITIALISED_STATIC",
2150 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002151 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002152 }
2153
Joe Perchescb710ec2010-10-26 14:23:20 -07002154# check for static const char * arrays.
2155 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002156 WARN("STATIC_CONST_CHAR_ARRAY",
2157 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002158 $herecurr);
2159 }
2160
2161# check for static char foo[] = "bar" declarations.
2162 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002163 WARN("STATIC_CONST_CHAR_ARRAY",
2164 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002165 $herecurr);
2166 }
2167
Joe Perches93ed0e22010-10-26 14:23:21 -07002168# check for declarations of struct pci_device_id
2169 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002170 WARN("DEFINE_PCI_DEVICE_TABLE",
2171 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002172 }
2173
Andy Whitcroft653d4872007-06-23 17:16:34 -07002174# check for new typedefs, only function parameters and sparse annotations
2175# make sense.
2176 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002177 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002178 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002179 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002180 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002181 WARN("NEW_TYPEDEFS",
2182 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002183 }
2184
2185# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002186 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08002187 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002188 my ($from, $to) = ($1, $1);
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 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002197
Andy Whitcroft65863862009-01-06 14:41:21 -08002198 #print "from<$from> to<$to>\n";
2199 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002200 ERROR("POINTER_LOCATION",
2201 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002202 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08002203 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002204 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002205
Andy Whitcroft65863862009-01-06 14:41:21 -08002206 # Should start with a space.
2207 $to =~ s/^(\S)/ $1/;
2208 # Should not end with a space.
2209 $to =~ s/\s+$//;
2210 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002211 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002212 }
2213 # Modifiers should have spaces.
2214 $to =~ s/(\b$Modifier$)/$1 /;
2215
Andy Whitcroft667026e2009-02-27 14:03:08 -08002216 #print "from<$from> to<$to> ident<$ident>\n";
2217 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002218 ERROR("POINTER_LOCATION",
2219 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002220 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002221 }
2222
2223# # no BUG() or BUG_ON()
2224# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2225# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2226# print "$herecurr";
2227# $clean = 0;
2228# }
2229
Andy Whitcroft8905a672007-11-28 16:21:06 -08002230 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002231 WARN("LINUX_VERSION_CODE",
2232 "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 -08002233 }
2234
Joe Perches17441222011-06-15 15:08:17 -07002235# check for uses of printk_ratelimit
2236 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002237 WARN("PRINTK_RATELIMITED",
2238"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002239 }
2240
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002241# printk should use KERN_* levels. Note that follow on printk's on the
2242# same line do not need a level, so we use the current block context
2243# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002244# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002245# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002246 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002247 my $ok = 0;
2248 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2249 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002250 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002251 # with "\n" ignore it, else it is to blame
2252 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2253 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2254 $ok = 1;
2255 }
2256 last;
2257 }
2258 }
2259 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002260 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2261 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002262 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002263 }
2264
Andy Whitcroft653d4872007-06-23 17:16:34 -07002265# function brace can't be on same line, except for #defines of do while,
2266# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002267 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2268 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002269 ERROR("OPEN_BRACE",
2270 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002271 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002272
Andy Whitcroft8905a672007-11-28 16:21:06 -08002273# open braces for enum, union and struct go on the same line.
2274 if ($line =~ /^.\s*{/ &&
2275 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002276 ERROR("OPEN_BRACE",
2277 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002278 }
2279
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002280# missing space after union, struct or enum definition
2281 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002282 WARN("SPACING",
2283 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002284 }
2285
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002286# check for spacing round square brackets; allowed:
2287# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002288# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2289# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002290 while ($line =~ /(.*?\s)\[/g) {
2291 my ($where, $prefix) = ($-[1], $1);
2292 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002293 ($where != 0 || $prefix !~ /^.\s+$/) &&
2294 $prefix !~ /{\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002295 ERROR("BRACKET_SPACE",
2296 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002297 }
2298 }
2299
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002300# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002301 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002302 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002303 my $ctx_before = substr($line, 0, $-[1]);
2304 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002305
2306 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002307 if ($name =~ /^(?:
2308 if|for|while|switch|return|case|
2309 volatile|__volatile__|
2310 __attribute__|format|__extension__|
2311 asm|__asm__)$/x)
2312 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002313
2314 # cpp #define statements have non-optional spaces, ie
2315 # if there is a space between the name and the open
2316 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002317 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002318
2319 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002320 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002321
2322 # If this whole things ends with a type its most
2323 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002324 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002325
2326 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002327 WARN("SPACING",
2328 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002329 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002330 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002331# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002332 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002333 my $ops = qr{
2334 <<=|>>=|<=|>=|==|!=|
2335 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2336 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002337 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2338 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002339 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002340 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002341 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002342
2343 my $blank = copy_spacing($opline);
2344
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002345 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002346 $off += length($elements[$n]);
2347
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002348 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002349 my $ca = substr($opline, 0, $off);
2350 my $cc = '';
2351 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2352 $cc = substr($opline, $off + length($elements[$n + 1]));
2353 }
2354 my $cb = "$ca$;$cc";
2355
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002356 my $a = '';
2357 $a = 'V' if ($elements[$n] ne '');
2358 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002359 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002360 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2361 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002362 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002363
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002364 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002365
2366 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002367 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002368 $c = 'V' if ($elements[$n + 2] ne '');
2369 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002370 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002371 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2372 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002373 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002374 } else {
2375 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002376 }
2377
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002378 my $ctx = "${a}x${c}";
2379
2380 my $at = "(ctx:$ctx)";
2381
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002382 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002383 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002384
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002385 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002386 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002387
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002388 # Get the full operator variant.
2389 my $opv = $op . substr($curr_vars, $off, 1);
2390
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002391 # Ignore operators passed as parameters.
2392 if ($op_type ne 'V' &&
2393 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2394
Andy Whitcroftcf655042008-03-04 14:28:20 -08002395# # Ignore comments
2396# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002397
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002398 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002399 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002400 if ($ctx !~ /.x[WEBC]/ &&
2401 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002402 ERROR("SPACING",
2403 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002404 }
2405
2406 # // is a comment
2407 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002408
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002409 # No spaces for:
2410 # ->
2411 # : when part of a bitfield
2412 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002413 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002414 ERROR("SPACING",
2415 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002416 }
2417
2418 # , must have a space on the right.
2419 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002420 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002421 ERROR("SPACING",
2422 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002423 }
2424
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002425 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002426 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002427 #warn "'*' is part of type\n";
2428
2429 # unary operators should have a space before and
2430 # none after. May be left adjacent to another
2431 # unary operator, or a cast
2432 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002433 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002434 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002435 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002436 ERROR("SPACING",
2437 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002438 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002439 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002440 # A unary '*' may be const
2441
2442 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002443 ERROR("SPACING",
2444 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002445 }
2446
2447 # unary ++ and unary -- are allowed no space on one side.
2448 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002449 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002450 ERROR("SPACING",
2451 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002452 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002453 if ($ctx =~ /Wx[BE]/ ||
2454 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002455 ERROR("SPACING",
2456 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002457 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002458 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002459 ERROR("SPACING",
2460 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002461 }
2462
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002463
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002464 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002465 } elsif ($op eq '<<' or $op eq '>>' or
2466 $op eq '&' or $op eq '^' or $op eq '|' or
2467 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002468 $op eq '*' or $op eq '/' or
2469 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002470 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002471 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002472 ERROR("SPACING",
2473 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002474 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002475 }
2476
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002477 # A colon needs no spaces before when it is
2478 # terminating a case value or a label.
2479 } elsif ($opv eq ':C' || $opv eq ':L') {
2480 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002481 ERROR("SPACING",
2482 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002483 }
2484
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002485 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002486 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002487 my $ok = 0;
2488
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002489 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002490 if (($op eq '<' &&
2491 $cc =~ /^\S+\@\S+>/) ||
2492 ($op eq '>' &&
2493 $ca =~ /<\S+\@\S+$/))
2494 {
2495 $ok = 1;
2496 }
2497
2498 # Ignore ?:
2499 if (($opv eq ':O' && $ca =~ /\?$/) ||
2500 ($op eq '?' && $cc =~ /^:/)) {
2501 $ok = 1;
2502 }
2503
2504 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002505 ERROR("SPACING",
2506 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002507 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002508 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002509 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002510 }
2511 }
2512
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002513# check for multiple assignments
2514 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002515 CHK("MULTIPLE_ASSIGNMENTS",
2516 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002517 }
2518
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002519## # check for multiple declarations, allowing for a function declaration
2520## # continuation.
2521## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2522## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2523##
2524## # Remove any bracketed sections to ensure we do not
2525## # falsly report the parameters of functions.
2526## my $ln = $line;
2527## while ($ln =~ s/\([^\(\)]*\)//g) {
2528## }
2529## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002530## WARN("MULTIPLE_DECLARATION",
2531## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002532## }
2533## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002534
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002535#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002536 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2537 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002538 ERROR("SPACING",
2539 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002540 }
2541
2542# closing brace should have a space following it when it has anything
2543# on the line
2544 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002545 ERROR("SPACING",
2546 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002547 }
2548
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002549# check spacing on square brackets
2550 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002551 ERROR("SPACING",
2552 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002553 }
2554 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002555 ERROR("SPACING",
2556 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002557 }
2558
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002559# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002560 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2561 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002562 ERROR("SPACING",
2563 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002564 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002565 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002566 $line !~ /for\s*\(.*;\s+\)/ &&
2567 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002568 ERROR("SPACING",
2569 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002570 }
2571
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002572#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002573 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002574 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002575 WARN("INDENTED_LABEL",
2576 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002577 }
2578
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002579# Return is not a function.
2580 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2581 my $spacing = $1;
2582 my $value = $2;
2583
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002584 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002585 $value =~ s/\(/ \(/g;
2586 $value =~ s/\)/\) /g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002587 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2588 $value !~ /(?:$Ident|-?$Constant)\s*
2589 $Compare\s*
2590 (?:$Ident|-?$Constant)/x &&
2591 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002592 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002593#print "value<$value>\n";
2594 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002595 ERROR("RETURN_PARENTHESES",
2596 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002597
2598 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002599 ERROR("SPACING",
2600 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002601 }
2602 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002603# Return of what appears to be an errno should normally be -'ve
2604 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2605 my $name = $1;
2606 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002607 WARN("USE_NEGATIVE_ERRNO",
2608 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002609 }
2610 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002611
Joe Perches7d2367a2011-07-25 17:13:22 -07002612# typecasts on min/max could be min_t/max_t
2613 if ($line =~ /^\+(?:.*?)\b(min|max)\s*\($Typecast{0,1}($LvalOrFunc)\s*,\s*$Typecast{0,1}($LvalOrFunc)\s*\)/) {
2614 if (defined $2 || defined $8) {
2615 my $call = $1;
2616 my $cast1 = deparenthesize($2);
2617 my $arg1 = $3;
2618 my $cast2 = deparenthesize($8);
2619 my $arg2 = $9;
2620 my $cast;
2621
2622 if ($cast1 ne "" && $cast2 ne "") {
2623 $cast = "$cast1 or $cast2";
2624 } elsif ($cast1 ne "") {
2625 $cast = $cast1;
2626 } else {
2627 $cast = $cast2;
2628 }
Hui Zhu30ecad52011-08-25 15:59:08 -07002629 WARN("MINMAX",
2630 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . $herecurr);
Joe Perches7d2367a2011-07-25 17:13:22 -07002631 }
2632 }
2633
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002634# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002635 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002636 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002637 }
2638
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002639# Check for illegal assignment in if conditional -- and check for trailing
2640# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002641 if ($line =~ /do\s*(?!{)/) {
2642 my ($stat_next) = ctx_statement_block($line_nr_next,
2643 $remain_next, $off_next);
2644 $stat_next =~ s/\n./\n /g;
2645 ##print "stat<$stat> stat_next<$stat_next>\n";
2646
2647 if ($stat_next =~ /^\s*while\b/) {
2648 # If the statement carries leading newlines,
2649 # then count those as offsets.
2650 my ($whitespace) =
2651 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2652 my $offset =
2653 statement_rawlines($whitespace) - 1;
2654
2655 $suppress_whiletrailers{$line_nr_next +
2656 $offset} = 1;
2657 }
2658 }
2659 if (!defined $suppress_whiletrailers{$linenr} &&
2660 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002661 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002662
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002663 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002664 ERROR("ASSIGN_IN_IF",
2665 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002666 }
2667
2668 # Find out what is on the end of the line after the
2669 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002670 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002671 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002672 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002673 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2674 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002675 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002676 # Find out how long the conditional actually is.
2677 my @newlines = ($c =~ /\n/gs);
2678 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002679 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002680
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002681 $stat_real = raw_line($linenr, $cond_lines)
2682 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002683 if (defined($stat_real) && $cond_lines > 1) {
2684 $stat_real = "[...]\n$stat_real";
2685 }
2686
Joe Perches000d1cc12011-07-25 17:13:25 -07002687 ERROR("TRAILING_STATEMENTS",
2688 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002689 }
2690 }
2691
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002692# Check for bitwise tests written as boolean
2693 if ($line =~ /
2694 (?:
2695 (?:\[|\(|\&\&|\|\|)
2696 \s*0[xX][0-9]+\s*
2697 (?:\&\&|\|\|)
2698 |
2699 (?:\&\&|\|\|)
2700 \s*0[xX][0-9]+\s*
2701 (?:\&\&|\|\||\)|\])
2702 )/x)
2703 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002704 WARN("HEXADECIMAL_BOOLEAN_TEST",
2705 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002706 }
2707
Andy Whitcroft8905a672007-11-28 16:21:06 -08002708# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002709 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2710 my $s = $1;
2711 $s =~ s/$;//g; # Remove any comments
2712 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002713 ERROR("TRAILING_STATEMENTS",
2714 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002715 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002716 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002717# if should not continue a brace
2718 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002719 ERROR("TRAILING_STATEMENTS",
2720 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002721 $herecurr);
2722 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002723# case and default should not have general statements after them
2724 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2725 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002726 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002727 \s*return\s+
2728 )/xg)
2729 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002730 ERROR("TRAILING_STATEMENTS",
2731 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002732 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002733
2734 # Check for }<nl>else {, these must be at the same
2735 # indent level to be relevant to each other.
2736 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2737 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002738 ERROR("ELSE_AFTER_BRACE",
2739 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002740 }
2741
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002742 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2743 $previndent == $indent) {
2744 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2745
2746 # Find out what is on the end of the line after the
2747 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002748 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002749 $s =~ s/\n.*//g;
2750
2751 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002752 ERROR("WHILE_AFTER_BRACE",
2753 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002754 }
2755 }
2756
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002757#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2758# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2759# print "No studly caps, use _\n";
2760# print "$herecurr";
2761# $clean = 0;
2762# }
2763
2764#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002765 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002766 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2767 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002768 }
2769
Andy Whitcroft653d4872007-06-23 17:16:34 -07002770#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002771 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002772 my $file = "$1.h";
2773 my $checkfile = "include/linux/$file";
2774 if (-f "$root/$checkfile" &&
2775 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002776 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002777 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002778 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002779 CHK("ARCH_INCLUDE_LINUX",
2780 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002781 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002782 WARN("INCLUDE_LINUX",
2783 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002784 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002785 }
2786 }
2787
Andy Whitcroft653d4872007-06-23 17:16:34 -07002788# multi-statement macros should be enclosed in a do while loop, grab the
2789# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002790# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002791 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2792 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002793 my $ln = $linenr;
2794 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002795 my ($off, $dstat, $dcond, $rest);
2796 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002797 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002798 ctx_statement_block($linenr, $realcnt, 0);
2799 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002800 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002801 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002802
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002803 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002804 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002805 $dstat =~ s/\\\n.//g;
2806 $dstat =~ s/^\s*//s;
2807 $dstat =~ s/\s*$//s;
2808
2809 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002810 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2811 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2812 $dstat =~ s/\[[^\{\}]*\]/1/)
2813 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002814 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002815
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002816 my $exceptions = qr{
2817 $Declare|
2818 module_param_named|
2819 MODULE_PARAM_DESC|
2820 DECLARE_PER_CPU|
2821 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002822 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002823 union|
2824 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002825 \.$Ident\s*=\s*|
2826 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002827 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07002828 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002829 if ($dstat ne '' &&
2830 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2831 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
2832 $dstat !~ /^(?:$Ident|-?$Constant)$/ && # 10 // foo()
2833 $dstat !~ /$exceptions/ &&
2834 $dstat !~ /^\.$Ident\s*=/ && # .foo =
2835 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;$/ && # do {...} while (...);
2836 $dstat !~ /^for\s*$Constant$/ && # for (...)
2837 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2838 $dstat !~ /^do\s*{/ && # do {...
2839 $dstat !~ /^\({/) # ({...
2840 {
2841 $ctx =~ s/\n*$//;
2842 my $herectx = $here . "\n";
2843 my $cnt = statement_rawlines($ctx);
2844
2845 for (my $n = 0; $n < $cnt; $n++) {
2846 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002847 }
2848
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002849 if ($dstat =~ /;/) {
2850 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2851 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
2852 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002853 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002854 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002855 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002856 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002857 }
2858
Mike Frysinger080ba922009-01-06 14:41:25 -08002859# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2860# all assignments may have only one of the following with an assignment:
2861# .
2862# ALIGN(...)
2863# VMLINUX_SYMBOL(...)
2864 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002865 WARN("MISSING_VMLINUX_SYMBOL",
2866 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08002867 }
2868
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002869# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002870 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2871 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002872 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002873 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002874 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2875 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002876 my $allowed = 0;
2877 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002878 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002879 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002880 for my $chunk (@chunks) {
2881 my ($cond, $block) = @{$chunk};
2882
Andy Whitcroft773647a2008-03-28 14:15:58 -07002883 # If the condition carries leading newlines, then count those as offsets.
2884 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2885 my $offset = statement_rawlines($whitespace) - 1;
2886
2887 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2888
2889 # We have looked at and allowed this specific line.
2890 $suppress_ifbraces{$ln + $offset} = 1;
2891
2892 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002893 $ln += statement_rawlines($block) - 1;
2894
Andy Whitcroft773647a2008-03-28 14:15:58 -07002895 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002896
2897 $seen++ if ($block =~ /^\s*{/);
2898
Andy Whitcroftcf655042008-03-04 14:28:20 -08002899 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2900 if (statement_lines($cond) > 1) {
2901 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002902 $allowed = 1;
2903 }
2904 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002905 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002906 $allowed = 1;
2907 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002908 if (statement_block_size($block) > 1) {
2909 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002910 $allowed = 1;
2911 }
2912 }
2913 if ($seen && !$allowed) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002914 WARN("BRACES",
2915 "braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002916 }
2917 }
2918 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002919 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002920 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002921 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002922
Andy Whitcroftcf655042008-03-04 14:28:20 -08002923 # Check the pre-context.
2924 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2925 #print "APW: ALLOWED: pre<$1>\n";
2926 $allowed = 1;
2927 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002928
2929 my ($level, $endln, @chunks) =
2930 ctx_statement_full($linenr, $realcnt, $-[0]);
2931
Andy Whitcroftcf655042008-03-04 14:28:20 -08002932 # Check the condition.
2933 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002934 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002935 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002936 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002937 }
2938 if (statement_lines($cond) > 1) {
2939 #print "APW: ALLOWED: cond<$cond>\n";
2940 $allowed = 1;
2941 }
2942 if ($block =~/\b(?:if|for|while)\b/) {
2943 #print "APW: ALLOWED: block<$block>\n";
2944 $allowed = 1;
2945 }
2946 if (statement_block_size($block) > 1) {
2947 #print "APW: ALLOWED: lines block<$block>\n";
2948 $allowed = 1;
2949 }
2950 # Check the post-context.
2951 if (defined $chunks[1]) {
2952 my ($cond, $block) = @{$chunks[1]};
2953 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002954 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002955 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002956 if ($block =~ /^\s*\{/) {
2957 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2958 $allowed = 1;
2959 }
2960 }
2961 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07002962 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07002963 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002964
Andy Whitcroftf0556632008-10-15 22:02:23 -07002965 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07002966 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002967 }
2968
Joe Perches000d1cc12011-07-25 17:13:25 -07002969 WARN("BRACES",
2970 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002971 }
2972 }
2973
Andy Whitcroft653d4872007-06-23 17:16:34 -07002974# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002975 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002976 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002977 ERROR("DEPRECATED_INCLUDE",
2978 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002979 }
2980 }
2981
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002982# don't use deprecated functions
2983 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002984 if ($line =~ /\b$func\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002985 ERROR("DEPRECATED_FUNCTION",
2986 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002987 }
2988 }
2989
2990# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002991 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2992 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002993 WARN("VOLATILE",
2994 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002995 }
2996
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002997# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002998 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002999 CHK("REDUNDANT_CODE",
3000 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003001 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003002 }
3003
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003004# check for needless kfree() checks
3005 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3006 my $expr = $1;
3007 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003008 WARN("NEEDLESS_KFREE",
3009 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003010 }
3011 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003012# check for needless usb_free_urb() checks
3013 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3014 my $expr = $1;
3015 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003016 WARN("NEEDLESS_USB_FREE_URB",
3017 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003018 }
3019 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003020
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003021# prefer usleep_range over udelay
3022 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3023 # ignore udelay's < 10, however
3024 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003025 CHK("USLEEP_RANGE",
3026 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003027 }
3028 }
3029
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003030# warn about unexpectedly long msleep's
3031 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3032 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003033 WARN("MSLEEP",
3034 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003035 }
3036 }
3037
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003038# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003039# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003040# print "#ifdef in C files should be avoided\n";
3041# print "$herecurr";
3042# $clean = 0;
3043# }
3044
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003045# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003046 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003047 ERROR("SPACING",
3048 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003049 }
3050
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003051# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003052 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3053 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003054 my $which = $1;
3055 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003056 CHK("UNCOMMENTED_DEFINITION",
3057 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003058 }
3059 }
3060# check for memory barriers without a comment.
3061 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3062 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003063 CHK("MEMORY_BARRIER",
3064 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003065 }
3066 }
3067# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003068 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003069 CHK("ARCH_DEFINES",
3070 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003071 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003072
Tobias Klauserd4977c72010-05-24 14:33:30 -07003073# Check that the storage class is at the beginning of a declaration
3074 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003075 WARN("STORAGE_CLASS",
3076 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003077 }
3078
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003079# check the location of the inline attribute, that it is between
3080# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003081 if ($line =~ /\b$Type\s+$Inline\b/ ||
3082 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003083 ERROR("INLINE_LOCATION",
3084 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003085 }
3086
Andy Whitcroft8905a672007-11-28 16:21:06 -08003087# Check for __inline__ and __inline, prefer inline
3088 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003089 WARN("INLINE",
3090 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003091 }
3092
Joe Perches3d130fd2011-01-12 17:00:00 -08003093# Check for __attribute__ packed, prefer __packed
3094 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003095 WARN("PREFER_PACKED",
3096 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003097 }
3098
Joe Perches39b7e282011-07-25 17:13:24 -07003099# Check for __attribute__ aligned, prefer __aligned
3100 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003101 WARN("PREFER_ALIGNED",
3102 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003103 }
3104
Joe Perches5f14d3b2012-01-10 15:09:52 -08003105# Check for __attribute__ format(printf, prefer __printf
3106 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3107 WARN("PREFER_PRINTF",
3108 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3109 }
3110
Joe Perches8f53a9b2010-03-05 13:43:48 -08003111# check for sizeof(&)
3112 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003113 WARN("SIZEOF_ADDRESS",
3114 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003115 }
3116
Joe Perches428e2fd2011-05-24 17:13:39 -07003117# check for line continuations in quoted strings with odd counts of "
3118 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003119 WARN("LINE_CONTINUATIONS",
3120 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003121 }
3122
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003123# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003124 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003125 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003126 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003127 my $function_name = $1;
3128 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003129
3130 my $s = $stat;
3131 if (defined $cond) {
3132 substr($s, 0, length($cond), '');
3133 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003134 if ($s =~ /^\s*;/ &&
3135 $function_name ne 'uninitialized_var')
3136 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003137 WARN("AVOID_EXTERNS",
3138 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003139 }
3140
3141 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003142 WARN("FUNCTION_ARGUMENTS",
3143 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003144 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003145
3146 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3147 $stat =~ /^.\s*extern\s+/)
3148 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003149 WARN("AVOID_EXTERNS",
3150 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003151 }
3152
3153# checks for new __setup's
3154 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3155 my $name = $1;
3156
3157 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003158 CHK("UNDOCUMENTED_SETUP",
3159 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003160 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003161 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003162
3163# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003164 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003165 WARN("UNNECESSARY_CASTS",
3166 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003167 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003168
Joe Perchescaf2a542011-01-12 16:59:56 -08003169# check for multiple semicolons
3170 if ($line =~ /;\s*;\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003171 WARN("ONE_SEMICOLON",
3172 "Statements terminations use 1 semicolon\n" . $herecurr);
Joe Perchescaf2a542011-01-12 16:59:56 -08003173 }
3174
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003175# check for gcc specific __FUNCTION__
3176 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003177 WARN("USE_FUNC",
3178 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003179 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003180
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003181# check for semaphores initialized locked
3182 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003183 WARN("CONSIDER_COMPLETION",
3184 "consider using a completion\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003185
Andy Whitcroft773647a2008-03-28 14:15:58 -07003186 }
Joe Perches67d0a072011-10-31 17:13:10 -07003187# recommend kstrto* over simple_strto* and strict_strto*
3188 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003189 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003190 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003191 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07003192# check for __initcall(), use device_initcall() explicitly please
3193 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003194 WARN("USE_DEVICE_INITCALL",
3195 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003196 }
Emese Revfy79404842010-03-05 13:43:53 -08003197# check for various ops structs, ensure they are const.
3198 my $struct_ops = qr{acpi_dock_ops|
3199 address_space_operations|
3200 backlight_ops|
3201 block_device_operations|
3202 dentry_operations|
3203 dev_pm_ops|
3204 dma_map_ops|
3205 extent_io_ops|
3206 file_lock_operations|
3207 file_operations|
3208 hv_ops|
3209 ide_dma_ops|
3210 intel_dvo_dev_ops|
3211 item_operations|
3212 iwl_ops|
3213 kgdb_arch|
3214 kgdb_io|
3215 kset_uevent_ops|
3216 lock_manager_operations|
3217 microcode_ops|
3218 mtrr_ops|
3219 neigh_ops|
3220 nlmsvc_binding|
3221 pci_raw_ops|
3222 pipe_buf_operations|
3223 platform_hibernation_ops|
3224 platform_suspend_ops|
3225 proto_ops|
3226 rpc_pipe_ops|
3227 seq_operations|
3228 snd_ac97_build_ops|
3229 soc_pcmcia_socket_ops|
3230 stacktrace_ops|
3231 sysfs_ops|
3232 tty_operations|
3233 usb_mon_operations|
3234 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003235 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003236 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003237 WARN("CONST_STRUCT",
3238 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003239 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003240 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003241
3242# use of NR_CPUS is usually wrong
3243# ignore definitions of NR_CPUS and usage to define arrays as likely right
3244 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003245 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3246 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003247 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3248 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3249 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003250 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003251 WARN("NR_CPUS",
3252 "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 -07003253 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003254
3255# check for %L{u,d,i} in strings
3256 my $string;
3257 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3258 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003259 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003260 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003261 WARN("PRINTF_L",
3262 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003263 last;
3264 }
3265 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003266
3267# whine mightly about in_atomic
3268 if ($line =~ /\bin_atomic\s*\(/) {
3269 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003270 ERROR("IN_ATOMIC",
3271 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003272 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003273 WARN("IN_ATOMIC",
3274 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003275 }
3276 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003277
3278# check for lockdep_set_novalidate_class
3279 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3280 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3281 if ($realfile !~ m@^kernel/lockdep@ &&
3282 $realfile !~ m@^include/linux/lockdep@ &&
3283 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003284 ERROR("LOCKDEP",
3285 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003286 }
3287 }
Dave Jones88f88312011-01-12 16:59:59 -08003288
3289 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3290 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003291 WARN("EXPORTED_WORLD_WRITABLE",
3292 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003293 }
Dave Jones309c00c2011-03-22 16:34:44 -07003294
3295 # Check for memset with swapped arguments
3296 if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003297 ERROR("MEMSET",
3298 "memset size is 3rd argument, not the second.\n" . $herecurr);
Dave Jones309c00c2011-03-22 16:34:44 -07003299 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003300 }
3301
3302 # If we have no input at all, then there is nothing to report on
3303 # so just keep quiet.
3304 if ($#rawlines == -1) {
3305 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003306 }
3307
Andy Whitcroft8905a672007-11-28 16:21:06 -08003308 # In mailback mode only produce a report in the negative, for
3309 # things that appear to be patches.
3310 if ($mailback && ($clean == 1 || !$is_patch)) {
3311 exit(0);
3312 }
3313
3314 # This is not a patch, and we are are in 'no-patch' mode so
3315 # just keep quiet.
3316 if (!$chk_patch && !$is_patch) {
3317 exit(0);
3318 }
3319
3320 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003321 ERROR("NOT_UNIFIED_DIFF",
3322 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003323 }
3324 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003325 ERROR("MISSING_SIGN_OFF",
3326 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003327 }
3328
Andy Whitcroft8905a672007-11-28 16:21:06 -08003329 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003330 if ($summary && !($clean == 1 && $quiet == 1)) {
3331 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003332 print "total: $cnt_error errors, $cnt_warn warnings, " .
3333 (($check)? "$cnt_chk checks, " : "") .
3334 "$cnt_lines lines checked\n";
3335 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003336 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003337
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003338 if ($quiet == 0) {
3339 # If there were whitespace errors which cleanpatch can fix
3340 # then suggest that.
3341 if ($rpt_cleaners) {
3342 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3343 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003344 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003345 }
3346 }
3347
Joe Perches000d1cc12011-07-25 17:13:25 -07003348 if (keys %ignore_type) {
3349 print "NOTE: Ignored message types:";
3350 foreach my $ignore (sort keys %ignore_type) {
3351 print " $ignore";
3352 }
3353 print "\n";
3354 print "\n" if ($quiet == 0);
3355 }
3356
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003357 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003358 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003359 }
3360 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003361 print << "EOM";
3362$vname has style problems, please review.
3363
3364If any of these errors are false positives, please report
3365them to the maintainer, see CHECKPATCH in MAINTAINERS.
3366EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003367 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003368
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003369 return $clean;
3370}