blob: e3bfcbe8a520b63639b04115bf148fb4ddd144eb [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
Joe Perches000d1cc12011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Joe 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 Whitcroft0a920b52007-06-01 00:46:48 -070098GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700100 'tree!' => \$tree,
101 'signoff!' => \$chk_signoff,
102 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700103 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800104 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700105 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700106 'subjective!' => \$check,
107 'strict!' => \$check,
Joe 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 Whitcroft0a920b52007-06-01 00:46:48 -0700122
123my $exit = 0;
124
125if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700126 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700127 exit(1);
128}
129
Joe 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 Whitcroft0a920b52007-06-01 00:46:48 -0700178}
179
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700180my $emitted_corrupt = 0;
181
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700182our $Ident = qr{
183 [A-Za-z_][A-Za-z\d_]*
184 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
185 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700186our $Storage = qr{extern|static|asmlinkage};
187our $Sparse = qr{
188 __user|
189 __kernel|
190 __force|
191 __iomem|
192 __must_check|
193 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800194 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700195 __ref|
196 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700197 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800198
199# Notes to $Attribute:
200# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700201our $Attribute = qr{
202 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700203 __percpu|
204 __nocast|
205 __safe|
206 __bitwise__|
207 __packed__|
208 __packed2__|
209 __naked|
210 __maybe_unused|
211 __always_unused|
212 __noreturn|
213 __used|
214 __cold|
215 __noclone|
216 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700217 __read_mostly|
218 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800219 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700220 ____cacheline_aligned|
221 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800222 ____cacheline_internodealigned_in_smp|
223 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700224 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700225our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700227our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
228our $Lval = qr{$Ident(?:$Member)*};
229
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800230our $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700231our $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 Whitcroft6b48db22012-01-10 15:10:13 -0800318 (?:typeof|__typeof__)\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*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800337our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700338
339sub deparenthesize {
340 my ($string) = @_;
341 return "" if (!defined($string));
342 $string =~ s@^\s*\(\s*@@g;
343 $string =~ s@\s*\)\s*$@@g;
344 $string =~ s@\s+@ @g;
345 return $string;
346}
347
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700348$chk_signoff = 0 if ($file);
349
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700350my @dep_includes = ();
351my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700352my $removal = "Documentation/feature-removal-schedule.txt";
353if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800354 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700355 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800356 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700357 if (/^Check:\s+(.*\S)/) {
358 for my $entry (split(/[, ]+/, $1)) {
359 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700360 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700361
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700362 } elsif ($entry !~ m@/@) {
363 push(@dep_functions, $entry);
364 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700365 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700366 }
367 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800368 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700369}
370
Andy Whitcroft00df3442007-06-08 13:47:06 -0700371my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800372my @lines = ();
373my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700374for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800375 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700376 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800377 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700378 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800379 } elsif ($filename eq '-') {
380 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700381 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800382 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700383 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700384 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800385 if ($filename eq '-') {
386 $vname = 'Your patch';
387 } else {
388 $vname = $filename;
389 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800390 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700391 chomp;
392 push(@rawlines, $_);
393 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800394 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800395 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700396 $exit = 1;
397 }
398 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800399 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700400}
401
402exit($exit);
403
404sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700405 my ($root) = @_;
406
407 my @tree_check = (
408 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
409 "README", "Documentation", "arch", "include", "drivers",
410 "fs", "init", "ipc", "kernel", "lib", "scripts",
411 );
412
413 foreach my $check (@tree_check) {
414 if (! -e $root . '/' . $check) {
415 return 0;
416 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700417 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700418 return 1;
Joe Perches000d1cc12011-07-25 17:13:25 -0700419 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700420
Joe Perches20112472011-07-25 17:13:23 -0700421sub parse_email {
422 my ($formatted_email) = @_;
423
424 my $name = "";
425 my $address = "";
426 my $comment = "";
427
428 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
429 $name = $1;
430 $address = $2;
431 $comment = $3 if defined $3;
432 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
433 $address = $1;
434 $comment = $2 if defined $2;
435 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
436 $address = $1;
437 $comment = $2 if defined $2;
438 $formatted_email =~ s/$address.*$//;
439 $name = $formatted_email;
440 $name =~ s/^\s+|\s+$//g;
441 $name =~ s/^\"|\"$//g;
442 # If there's a name left after stripping spaces and
443 # leading quotes, and the address doesn't have both
444 # leading and trailing angle brackets, the address
445 # is invalid. ie:
446 # "joe smith joe@smith.com" bad
447 # "joe smith <joe@smith.com" bad
448 if ($name ne "" && $address !~ /^<[^>]+>$/) {
449 $name = "";
450 $address = "";
451 $comment = "";
452 }
453 }
454
455 $name =~ s/^\s+|\s+$//g;
456 $name =~ s/^\"|\"$//g;
457 $address =~ s/^\s+|\s+$//g;
458 $address =~ s/^\<|\>$//g;
459
460 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
461 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
462 $name = "\"$name\"";
463 }
464
465 return ($name, $address, $comment);
466}
467
468sub format_email {
469 my ($name, $address) = @_;
470
471 my $formatted_email;
472
473 $name =~ s/^\s+|\s+$//g;
474 $name =~ s/^\"|\"$//g;
475 $address =~ s/^\s+|\s+$//g;
476
477 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
478 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
479 $name = "\"$name\"";
480 }
481
482 if ("$name" eq "") {
483 $formatted_email = "$address";
484 } else {
485 $formatted_email = "$name <$address>";
486 }
487
488 return $formatted_email;
489}
490
Joe Perches000d1cc12011-07-25 17:13:25 -0700491sub which_conf {
492 my ($conf) = @_;
493
494 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
495 if (-e "$path/$conf") {
496 return "$path/$conf";
497 }
498 }
499
500 return "";
501}
502
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700503sub expand_tabs {
504 my ($str) = @_;
505
506 my $res = '';
507 my $n = 0;
508 for my $c (split(//, $str)) {
509 if ($c eq "\t") {
510 $res .= ' ';
511 $n++;
512 for (; ($n % 8) != 0; $n++) {
513 $res .= ' ';
514 }
515 next;
516 }
517 $res .= $c;
518 $n++;
519 }
520
521 return $res;
522}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700523sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700524 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700525 return $res;
526}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700527
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700528sub line_stats {
529 my ($line) = @_;
530
531 # Drop the diff line leader and expand tabs
532 $line =~ s/^.//;
533 $line = expand_tabs($line);
534
535 # Pick the indent from the front of the line.
536 my ($white) = ($line =~ /^(\s*)/);
537
538 return (length($line), length($white));
539}
540
Andy Whitcroft773647a2008-03-28 14:15:58 -0700541my $sanitise_quote = '';
542
543sub sanitise_line_reset {
544 my ($in_comment) = @_;
545
546 if ($in_comment) {
547 $sanitise_quote = '*/';
548 } else {
549 $sanitise_quote = '';
550 }
551}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700552sub sanitise_line {
553 my ($line) = @_;
554
555 my $res = '';
556 my $l = '';
557
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800558 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700559 my $off = 0;
560 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700561
Andy Whitcroft773647a2008-03-28 14:15:58 -0700562 # Always copy over the diff marker.
563 $res = substr($line, 0, 1);
564
565 for ($off = 1; $off < length($line); $off++) {
566 $c = substr($line, $off, 1);
567
568 # Comments we are wacking completly including the begin
569 # and end, all to $;.
570 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
571 $sanitise_quote = '*/';
572
573 substr($res, $off, 2, "$;$;");
574 $off++;
575 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800576 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700577 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700578 $sanitise_quote = '';
579 substr($res, $off, 2, "$;$;");
580 $off++;
581 next;
582 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700583 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
584 $sanitise_quote = '//';
585
586 substr($res, $off, 2, $sanitise_quote);
587 $off++;
588 next;
589 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700590
591 # A \ in a string means ignore the next character.
592 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
593 $c eq "\\") {
594 substr($res, $off, 2, 'XX');
595 $off++;
596 next;
597 }
598 # Regular quotes.
599 if ($c eq "'" || $c eq '"') {
600 if ($sanitise_quote eq '') {
601 $sanitise_quote = $c;
602
603 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700604 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700605 } elsif ($sanitise_quote eq $c) {
606 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700607 }
608 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700609
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800610 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700611 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
612 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700613 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
614 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700615 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
616 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700617 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700618 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700619 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800620 }
621
Daniel Walker113f04a2009-09-21 17:04:35 -0700622 if ($sanitise_quote eq '//') {
623 $sanitise_quote = '';
624 }
625
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800626 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700627 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800628 my $clean = 'X' x length($1);
629 $res =~ s@\<.*\>@<$clean>@;
630
631 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700632 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800633 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700634 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800635 }
636
Andy Whitcroft00df3442007-06-08 13:47:06 -0700637 return $res;
638}
639
Andy Whitcroft8905a672007-11-28 16:21:06 -0800640sub ctx_statement_block {
641 my ($linenr, $remain, $off) = @_;
642 my $line = $linenr - 1;
643 my $blk = '';
644 my $soff = $off;
645 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700646 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800647
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800648 my $loff = 0;
649
Andy Whitcroft8905a672007-11-28 16:21:06 -0800650 my $type = '';
651 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800652 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800653 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800654 my $c;
655 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800656
657 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800658 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800659 @stack = (['', 0]) if ($#stack == -1);
660
Andy Whitcroft773647a2008-03-28 14:15:58 -0700661 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800662 # If we are about to drop off the end, pull in more
663 # context.
664 if ($off >= $len) {
665 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700666 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800667 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800668 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800669 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800670 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800671 $len = length($blk);
672 $line++;
673 last;
674 }
675 # Bail if there is no further context.
676 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800677 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800678 last;
679 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800680 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
681 $level++;
682 $type = '#';
683 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800684 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800685 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800686 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800687 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800688
Andy Whitcroft773647a2008-03-28 14:15:58 -0700689 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800690
691 # Handle nested #if/#else.
692 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
693 push(@stack, [ $type, $level ]);
694 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
695 ($type, $level) = @{$stack[$#stack - 1]};
696 } elsif ($remainder =~ /^#\s*endif\b/) {
697 ($type, $level) = @{pop(@stack)};
698 }
699
Andy Whitcroft8905a672007-11-28 16:21:06 -0800700 # Statement ends at the ';' or a close '}' at the
701 # outermost level.
702 if ($level == 0 && $c eq ';') {
703 last;
704 }
705
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800706 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700707 if ($level == 0 && $coff_set == 0 &&
708 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
709 $remainder =~ /^(else)(?:\s|{)/ &&
710 $remainder !~ /^else\s+if\b/) {
711 $coff = $off + length($1) - 1;
712 $coff_set = 1;
713 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
714 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800715 }
716
Andy Whitcroft8905a672007-11-28 16:21:06 -0800717 if (($type eq '' || $type eq '(') && $c eq '(') {
718 $level++;
719 $type = '(';
720 }
721 if ($type eq '(' && $c eq ')') {
722 $level--;
723 $type = ($level != 0)? '(' : '';
724
725 if ($level == 0 && $coff < $soff) {
726 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700727 $coff_set = 1;
728 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800729 }
730 }
731 if (($type eq '' || $type eq '{') && $c eq '{') {
732 $level++;
733 $type = '{';
734 }
735 if ($type eq '{' && $c eq '}') {
736 $level--;
737 $type = ($level != 0)? '{' : '';
738
739 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700740 if (substr($blk, $off + 1, 1) eq ';') {
741 $off++;
742 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800743 last;
744 }
745 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800746 # Preprocessor commands end at the newline unless escaped.
747 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
748 $level--;
749 $type = '';
750 $off++;
751 last;
752 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800753 $off++;
754 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700755 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800756 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700757 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800758 $line++;
759 $remain--;
760 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800761
762 my $statement = substr($blk, $soff, $off - $soff + 1);
763 my $condition = substr($blk, $soff, $coff - $soff + 1);
764
765 #warn "STATEMENT<$statement>\n";
766 #warn "CONDITION<$condition>\n";
767
Andy Whitcroft773647a2008-03-28 14:15:58 -0700768 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800769
770 return ($statement, $condition,
771 $line, $remain + 1, $off - $loff + 1, $level);
772}
773
Andy Whitcroftcf655042008-03-04 14:28:20 -0800774sub statement_lines {
775 my ($stmt) = @_;
776
777 # Strip the diff line prefixes and rip blank lines at start and end.
778 $stmt =~ s/(^|\n)./$1/g;
779 $stmt =~ s/^\s*//;
780 $stmt =~ s/\s*$//;
781
782 my @stmt_lines = ($stmt =~ /\n/g);
783
784 return $#stmt_lines + 2;
785}
786
787sub statement_rawlines {
788 my ($stmt) = @_;
789
790 my @stmt_lines = ($stmt =~ /\n/g);
791
792 return $#stmt_lines + 2;
793}
794
795sub statement_block_size {
796 my ($stmt) = @_;
797
798 $stmt =~ s/(^|\n)./$1/g;
799 $stmt =~ s/^\s*{//;
800 $stmt =~ s/}\s*$//;
801 $stmt =~ s/^\s*//;
802 $stmt =~ s/\s*$//;
803
804 my @stmt_lines = ($stmt =~ /\n/g);
805 my @stmt_statements = ($stmt =~ /;/g);
806
807 my $stmt_lines = $#stmt_lines + 2;
808 my $stmt_statements = $#stmt_statements + 1;
809
810 if ($stmt_lines > $stmt_statements) {
811 return $stmt_lines;
812 } else {
813 return $stmt_statements;
814 }
815}
816
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800817sub ctx_statement_full {
818 my ($linenr, $remain, $off) = @_;
819 my ($statement, $condition, $level);
820
821 my (@chunks);
822
Andy Whitcroftcf655042008-03-04 14:28:20 -0800823 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800824 ($statement, $condition, $linenr, $remain, $off, $level) =
825 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700826 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800827 push(@chunks, [ $condition, $statement ]);
828 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
829 return ($level, $linenr, @chunks);
830 }
831
832 # Pull in the following conditional/block pairs and see if they
833 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800834 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800835 ($statement, $condition, $linenr, $remain, $off, $level) =
836 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800837 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700838 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800839 #print "C: push\n";
840 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800841 }
842
843 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800844}
845
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700846sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700847 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700848 my $line;
849 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700850 my $blk = '';
851 my @o;
852 my @c;
853 my @res = ();
854
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700855 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800856 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700857 for ($line = $start; $remain > 0; $line++) {
858 next if ($rawlines[$line] =~ /^-/);
859 $remain--;
860
861 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800862
863 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700864 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800865 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700866 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800867 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700868 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800869 $level = pop(@stack);
870 }
871
Andy Whitcroft01464f32010-10-26 14:23:19 -0700872 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700873 ##print "C<$c>L<$level><$open$close>O<$off>\n";
874 if ($off > 0) {
875 $off--;
876 next;
877 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700878
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700879 if ($c eq $close && $level > 0) {
880 $level--;
881 last if ($level == 0);
882 } elsif ($c eq $open) {
883 $level++;
884 }
885 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700886
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700887 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700888 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700889 }
890
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700891 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700892 }
893
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700894 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700895}
896sub ctx_block_outer {
897 my ($linenr, $remain) = @_;
898
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700899 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
900 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700901}
902sub ctx_block {
903 my ($linenr, $remain) = @_;
904
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700905 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
906 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700907}
908sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700909 my ($linenr, $remain, $off) = @_;
910
911 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
912 return @r;
913}
914sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700915 my ($linenr, $remain) = @_;
916
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700917 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700918}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700919sub ctx_statement_level {
920 my ($linenr, $remain, $off) = @_;
921
922 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
923}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700924
925sub ctx_locate_comment {
926 my ($first_line, $end_line) = @_;
927
928 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700929 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700930 return $current_comment if (defined $current_comment);
931
932 # Look through the context and try and figure out if there is a
933 # comment.
934 my $in_comment = 0;
935 $current_comment = '';
936 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700937 my $line = $rawlines[$linenr - 1];
938 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700939 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
940 $in_comment = 1;
941 }
942 if ($line =~ m@/\*@) {
943 $in_comment = 1;
944 }
945 if (!$in_comment && $current_comment ne '') {
946 $current_comment = '';
947 }
948 $current_comment .= $line . "\n" if ($in_comment);
949 if ($line =~ m@\*/@) {
950 $in_comment = 0;
951 }
952 }
953
954 chomp($current_comment);
955 return($current_comment);
956}
957sub ctx_has_comment {
958 my ($first_line, $end_line) = @_;
959 my $cmt = ctx_locate_comment($first_line, $end_line);
960
Andy Whitcroft00df3442007-06-08 13:47:06 -0700961 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700962 ##print "CMMT: $cmt\n";
963
964 return ($cmt ne '');
965}
966
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700967sub raw_line {
968 my ($linenr, $cnt) = @_;
969
970 my $offset = $linenr - 1;
971 $cnt++;
972
973 my $line;
974 while ($cnt) {
975 $line = $rawlines[$offset++];
976 next if (defined($line) && $line =~ /^-/);
977 $cnt--;
978 }
979
980 return $line;
981}
982
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700983sub cat_vet {
984 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700985 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700986
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700987 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700988 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
989 $res .= $1;
990 if ($2 ne '') {
991 $coded = sprintf("^%c", unpack('C', $2) + 64);
992 $res .= $coded;
993 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700994 }
995 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700996
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700997 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700998}
999
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001000my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001001my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001002my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001003my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001004
1005sub annotate_reset {
1006 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001007 $av_pending = '_';
1008 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001009 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010}
1011
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001012sub annotate_values {
1013 my ($stream, $type) = @_;
1014
1015 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001016 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001017 my $cur = $stream;
1018
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001019 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001020
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001021 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001022 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001023 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001024 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001025 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001026 print "WS($1)\n" if ($dbg_values > 1);
1027 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001028 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001029 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001030 }
1031
Florian Micklerc023e4732011-01-12 16:59:58 -08001032 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001033 print "CAST($1)\n" if ($dbg_values > 1);
1034 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001035 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001036
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001037 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001038 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001039 $type = 'T';
1040
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001041 } elsif ($cur =~ /^($Modifier)\s*/) {
1042 print "MODIFIER($1)\n" if ($dbg_values > 1);
1043 $type = 'T';
1044
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001045 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001046 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001047 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001048 push(@av_paren_type, $type);
1049 if ($2 ne '') {
1050 $av_pending = 'N';
1051 }
1052 $type = 'E';
1053
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001054 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001055 print "UNDEF($1)\n" if ($dbg_values > 1);
1056 $av_preprocessor = 1;
1057 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001058
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001059 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001060 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001061 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001062
1063 push(@av_paren_type, $type);
1064 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001065 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001066
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001067 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001068 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1069 $av_preprocessor = 1;
1070
1071 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1072
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001073 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001074
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001075 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001076 print "PRE_END($1)\n" if ($dbg_values > 1);
1077
1078 $av_preprocessor = 1;
1079
1080 # Assume all arms of the conditional end as this
1081 # one does, and continue as if the #endif was not here.
1082 pop(@av_paren_type);
1083 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001084 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001085
1086 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001087 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001088
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001089 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1090 print "ATTR($1)\n" if ($dbg_values > 1);
1091 $av_pending = $type;
1092 $type = 'N';
1093
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001094 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001095 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001096 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001097 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001098 }
1099 $type = 'N';
1100
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001101 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001102 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001103 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001104 $type = 'N';
1105
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001106 } elsif ($cur =~/^(case)/o) {
1107 print "CASE($1)\n" if ($dbg_values > 1);
1108 $av_pend_colon = 'C';
1109 $type = 'N';
1110
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001111 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001112 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001113 $type = 'N';
1114
1115 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001116 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001117 push(@av_paren_type, $av_pending);
1118 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001119 $type = 'N';
1120
1121 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001122 my $new_type = pop(@av_paren_type);
1123 if ($new_type ne '_') {
1124 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001125 print "PAREN('$1') -> $type\n"
1126 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001127 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001128 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001129 }
1130
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001131 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001132 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001133 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001134 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001135
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001136 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1137 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001138 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001139 } elsif ($type eq 'E') {
1140 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001141 }
1142 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1143 $type = 'V';
1144
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001145 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001146 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001147 $type = 'V';
1148
1149 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001150 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001151 $type = 'N';
1152
Andy Whitcroftcf655042008-03-04 14:28:20 -08001153 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001154 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001155 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001156 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001157
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001158 } elsif ($cur =~/^(,)/) {
1159 print "COMMA($1)\n" if ($dbg_values > 1);
1160 $type = 'C';
1161
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001162 } elsif ($cur =~ /^(\?)/o) {
1163 print "QUESTION($1)\n" if ($dbg_values > 1);
1164 $type = 'N';
1165
1166 } elsif ($cur =~ /^(:)/o) {
1167 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1168
1169 substr($var, length($res), 1, $av_pend_colon);
1170 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1171 $type = 'E';
1172 } else {
1173 $type = 'N';
1174 }
1175 $av_pend_colon = 'O';
1176
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001177 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001178 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001179 $type = 'N';
1180
Andy Whitcroft0d413862008-10-15 22:02:16 -07001181 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001182 my $variant;
1183
1184 print "OPV($1)\n" if ($dbg_values > 1);
1185 if ($type eq 'V') {
1186 $variant = 'B';
1187 } else {
1188 $variant = 'U';
1189 }
1190
1191 substr($var, length($res), 1, $variant);
1192 $type = 'N';
1193
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001195 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001196 if ($1 ne '++' && $1 ne '--') {
1197 $type = 'N';
1198 }
1199
1200 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001201 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001202 }
1203 if (defined $1) {
1204 $cur = substr($cur, length($1));
1205 $res .= $type x length($1);
1206 }
1207 }
1208
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001209 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001210}
1211
Andy Whitcroft8905a672007-11-28 16:21:06 -08001212sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001213 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001214 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001215 ^(?:
1216 $Modifier|
1217 $Storage|
1218 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001219 DEFINE_\S+
1220 )$|
1221 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001222 goto|
1223 return|
1224 case|
1225 else|
1226 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001227 do|
1228 \#|
1229 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001230 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001231 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001232 )}x;
1233 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1234 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001235 # Check for modifiers.
1236 $possible =~ s/\s*$Storage\s*//g;
1237 $possible =~ s/\s*$Sparse\s*//g;
1238 if ($possible =~ /^\s*$/) {
1239
1240 } elsif ($possible =~ /\s/) {
1241 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001242 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001243 if ($modifier !~ $notPermitted) {
1244 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1245 push(@modifierList, $modifier);
1246 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001247 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001248
1249 } else {
1250 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1251 push(@typeList, $possible);
1252 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001253 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001254 } else {
1255 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001256 }
1257}
1258
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001259my $prefix = '';
1260
Joe Perches000d1cc12011-07-25 17:13:25 -07001261sub show_type {
1262 return !defined $ignore_type{$_[0]};
1263}
1264
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001265sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001266 if (!show_type($_[1]) ||
1267 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001268 return 0;
1269 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001270 my $line;
1271 if ($show_types) {
1272 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1273 } else {
1274 $line = "$prefix$_[0]: $_[2]\n";
1275 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001276 $line = (split('\n', $line))[0] . "\n" if ($terse);
1277
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001278 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001279
1280 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001281}
1282sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001283 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001284}
Joe Perches000d1cc12011-07-25 17:13:25 -07001285
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001286sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001287 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001288 our $clean = 0;
1289 our $cnt_error++;
1290 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001291}
1292sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001293 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001294 our $clean = 0;
1295 our $cnt_warn++;
1296 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001297}
1298sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001299 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001300 our $clean = 0;
1301 our $cnt_chk++;
1302 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001303}
1304
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001305sub check_absolute_file {
1306 my ($absolute, $herecurr) = @_;
1307 my $file = $absolute;
1308
1309 ##print "absolute<$absolute>\n";
1310
1311 # See if any suffix of this path is a path within the tree.
1312 while ($file =~ s@^[^/]*/@@) {
1313 if (-f "$root/$file") {
1314 ##print "file<$file>\n";
1315 last;
1316 }
1317 }
1318 if (! -f _) {
1319 return 0;
1320 }
1321
1322 # It is, so see if the prefix is acceptable.
1323 my $prefix = $absolute;
1324 substr($prefix, -length($file)) = '';
1325
1326 ##print "prefix<$prefix>\n";
1327 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001328 WARN("USE_RELATIVE_PATH",
1329 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001330 }
1331}
1332
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001333sub process {
1334 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001335
1336 my $linenr=0;
1337 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001338 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001339 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001340 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001341
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001342 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001343 my $indent;
1344 my $previndent=0;
1345 my $stashindent=0;
1346
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001347 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001348 my $signoff = 0;
1349 my $is_patch = 0;
1350
Joe Perches15662b32011-10-31 17:13:12 -07001351 my $in_header_lines = 1;
1352 my $in_commit_log = 0; #Scanning lines before patch
1353
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001354 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001355 our $cnt_lines = 0;
1356 our $cnt_error = 0;
1357 our $cnt_warn = 0;
1358 our $cnt_chk = 0;
1359
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001360 # Trace the real file/line as we go.
1361 my $realfile = '';
1362 my $realline = 0;
1363 my $realcnt = 0;
1364 my $here = '';
1365 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001366 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001367 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001368 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001369
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001370 my $prev_values = 'E';
1371
1372 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001373 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001374 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001375 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001376 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001377
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001378 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001379 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001380 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001381 my @setup_docs = ();
1382 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001383
1384 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001385 my $line;
1386 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001387 $linenr++;
1388 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001389
Andy Whitcroft773647a2008-03-28 14:15:58 -07001390 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001391 $setup_docs = 0;
1392 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1393 $setup_docs = 1;
1394 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001395 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001396 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001397 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1398 $realline=$1-1;
1399 if (defined $2) {
1400 $realcnt=$3+1;
1401 } else {
1402 $realcnt=1+1;
1403 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001404 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001405
1406 # Guestimate if this is a continuing comment. Run
1407 # the context looking for a comment "edge". If this
1408 # edge is a close comment then we must be in a comment
1409 # at context start.
1410 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001411 my $cnt = $realcnt;
1412 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1413 next if (defined $rawlines[$ln - 1] &&
1414 $rawlines[$ln - 1] =~ /^-/);
1415 $cnt--;
1416 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001417 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001418 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1419 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1420 ($edge) = $1;
1421 last;
1422 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001423 }
1424 if (defined $edge && $edge eq '*/') {
1425 $in_comment = 1;
1426 }
1427
1428 # Guestimate if this is a continuing comment. If this
1429 # is the start of a diff block and this line starts
1430 # ' *' then it is very likely a comment.
1431 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001432 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001433 {
1434 $in_comment = 1;
1435 }
1436
1437 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1438 sanitise_line_reset($in_comment);
1439
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001440 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001441 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001442 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001443 $line = sanitise_line($rawline);
1444 }
1445 push(@lines, $line);
1446
1447 if ($realcnt > 1) {
1448 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1449 } else {
1450 $realcnt = 0;
1451 }
1452
1453 #print "==>$rawline\n";
1454 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001455
1456 if ($setup_docs && $line =~ /^\+/) {
1457 push(@setup_docs, $line);
1458 }
1459 }
1460
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001461 $prefix = '';
1462
Andy Whitcroft773647a2008-03-28 14:15:58 -07001463 $realcnt = 0;
1464 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001465 foreach my $line (@lines) {
1466 $linenr++;
1467
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001468 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001469
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001470#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001471 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001472 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001473 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001474 $realline=$1-1;
1475 if (defined $2) {
1476 $realcnt=$3+1;
1477 } else {
1478 $realcnt=1+1;
1479 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001480 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001481 $prev_values = 'E';
1482
Andy Whitcroft773647a2008-03-28 14:15:58 -07001483 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001484 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001485 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001486 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001487 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001488
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001489# track the line number as we move through the hunk, note that
1490# new versions of GNU diff omit the leading space on completely
1491# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001492 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001493 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001494 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001495
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001496 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001497 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001498
1499 # Track the previous line.
1500 ($prevline, $stashline) = ($stashline, $line);
1501 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001502 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1503
Andy Whitcroft773647a2008-03-28 14:15:58 -07001504 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001505
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001506 } elsif ($realcnt == 1) {
1507 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001508 }
1509
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001510 my $hunk_line = ($realcnt != 0);
1511
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001512#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001513 $prefix = "$filename:$realline: " if ($emacs && $file);
1514 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1515
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001516 $here = "#$linenr: " if (!$file);
1517 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001518
1519 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001520 if ($line =~ /^diff --git.*?(\S+)$/) {
1521 $realfile = $1;
1522 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001523 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001524 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001525 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001526 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001527 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001528
1529 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001530 if (!$file && $tree && $p1_prefix ne '' &&
1531 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001532 WARN("PATCH_PREFIX",
1533 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001534 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001535
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001536 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001537 ERROR("MODIFIED_INCLUDE_ASM",
1538 "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 -07001539 }
1540 next;
1541 }
1542
Randy Dunlap389834b2007-06-08 13:47:03 -07001543 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001544
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001545 my $hereline = "$here\n$rawline\n";
1546 my $herecurr = "$here\n$rawline\n";
1547 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001548
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001549 $cnt_lines++ if ($realcnt != 0);
1550
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001551# Check for incorrect file permissions
1552 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1553 my $permhere = $here . "FILE: $realfile\n";
1554 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001555 ERROR("EXECUTE_PERMISSIONS",
1556 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001557 }
1558 }
1559
Joe Perches20112472011-07-25 17:13:23 -07001560# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001561 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001562 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001563 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001564 }
1565
1566# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001567 if (!$in_header_lines &&
1568 $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
Joe Perches20112472011-07-25 17:13:23 -07001569 my $space_before = $1;
1570 my $sign_off = $2;
1571 my $space_after = $3;
1572 my $email = $4;
1573 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1574
1575 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001576 WARN("BAD_SIGN_OFF",
1577 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001578 }
Joe Perches20112472011-07-25 17:13:23 -07001579 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001580 WARN("BAD_SIGN_OFF",
1581 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001582 }
1583 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001584 WARN("BAD_SIGN_OFF",
1585 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001586 }
1587
1588 my ($email_name, $email_address, $comment) = parse_email($email);
1589 my $suggested_email = format_email(($email_name, $email_address));
1590 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001591 ERROR("BAD_SIGN_OFF",
1592 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001593 } else {
1594 my $dequoted = $suggested_email;
1595 $dequoted =~ s/^"//;
1596 $dequoted =~ s/" </ </;
1597 # Don't force email to have quotes
1598 # Allow just an angle bracketed address
1599 if ("$dequoted$comment" ne $email &&
1600 "<$email_address>$comment" ne $email &&
1601 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001602 WARN("BAD_SIGN_OFF",
1603 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001604 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001605 }
1606 }
1607
Andy Whitcroft00df3442007-06-08 13:47:06 -07001608# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001609 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001610 ERROR("CORRUPTED_PATCH",
1611 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001612 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001613 }
1614
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001615# Check for absolute kernel paths.
1616 if ($tree) {
1617 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1618 my $file = $1;
1619
1620 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1621 check_absolute_file($1, $herecurr)) {
1622 #
1623 } else {
1624 check_absolute_file($file, $herecurr);
1625 }
1626 }
1627 }
1628
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001629# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1630 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001631 $rawline !~ m/^$UTF8*$/) {
1632 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1633
1634 my $blank = copy_spacing($rawline);
1635 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1636 my $hereptr = "$hereline$ptr\n";
1637
Joe Perches34d99212011-07-25 17:13:26 -07001638 CHK("INVALID_UTF8",
1639 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001640 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001641
Joe Perches15662b32011-10-31 17:13:12 -07001642# Check if it's the start of a commit log
1643# (not a header line and we haven't seen the patch filename)
1644 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001645 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001646 $in_header_lines = 0;
1647 $in_commit_log = 1;
1648 }
1649
1650# Still not yet in a patch, check for any UTF-8
1651 if ($in_commit_log && $realfile =~ /^$/ &&
1652 $rawline =~ /$NON_ASCII_UTF8/) {
1653 CHK("UTF8_BEFORE_PATCH",
1654 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1655 }
1656
Andy Whitcroft306708542008-10-15 22:02:28 -07001657# ignore non-hunk lines and lines being removed
1658 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001659
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001660#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001661 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001662 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001663 ERROR("DOS_LINE_ENDINGS",
1664 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001665
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001666 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1667 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001668 ERROR("TRAILING_WHITESPACE",
1669 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001670 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001671 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001672
Andi Kleen33549572010-05-24 14:33:29 -07001673# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001674# Only applies when adding the entry originally, after that we do not have
1675# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001676 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001677 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001678 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001679 my $cnt = $realcnt;
1680 my $ln = $linenr + 1;
1681 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001682 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001683 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001684 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001685 $f = $lines[$ln - 1];
1686 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1687 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001688
1689 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001690
1691 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1692 $is_start = 1;
1693 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1694 $length = -1;
1695 }
1696
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001697 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001698 $f =~ s/#.*//;
1699 $f =~ s/^\s+//;
1700 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001701 if ($f =~ /^\s*config\s/) {
1702 $is_end = 1;
1703 last;
1704 }
Andi Kleen33549572010-05-24 14:33:29 -07001705 $length++;
1706 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001707 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001708 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1709 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001710 }
1711
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001712 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1713 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1714 my $flag = $1;
1715 my $replacement = {
1716 'EXTRA_AFLAGS' => 'asflags-y',
1717 'EXTRA_CFLAGS' => 'ccflags-y',
1718 'EXTRA_CPPFLAGS' => 'cppflags-y',
1719 'EXTRA_LDFLAGS' => 'ldflags-y',
1720 };
1721
1722 WARN("DEPRECATED_VARIABLE",
1723 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1724 }
1725
Andy Whitcroft5368df22008-10-15 22:02:27 -07001726# check we are in a valid source file if not then ignore this hunk
1727 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1728
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001729#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001730 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001731 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001732 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001733 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001734 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001735 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001736 WARN("LONG_LINE",
1737 "line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001738 }
1739
Joe Perches5e79d962010-03-05 13:43:55 -08001740# check for spaces before a quoted newline
1741 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001742 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1743 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001744 }
1745
Andy Whitcroft8905a672007-11-28 16:21:06 -08001746# check for adding lines without a newline.
1747 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001748 WARN("MISSING_EOF_NEWLINE",
1749 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001750 }
1751
Mike Frysinger42e41c52009-09-21 17:04:40 -07001752# Blackfin: use hi/lo macros
1753 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1754 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1755 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001756 ERROR("LO_MACRO",
1757 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001758 }
1759 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1760 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001761 ERROR("HI_MACRO",
1762 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001763 }
1764 }
1765
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001766# check we are in a valid source file C or perl if not then ignore this hunk
1767 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001768
1769# at the beginning of a line any tabs must come first and anything
1770# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001771 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1772 $rawline =~ /^\+\s* \s*/) {
1773 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001774 ERROR("CODE_INDENT",
1775 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001776 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001777 }
1778
Alberto Panizzo08e44362010-03-05 13:43:54 -08001779# check for space before tabs.
1780 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1781 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001782 WARN("SPACE_BEFORE_TAB",
1783 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001784 }
1785
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001786# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001787# Exceptions:
1788# 1) within comments
1789# 2) indented preprocessor commands
1790# 3) hanging labels
1791 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001792 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001793 WARN("LEADING_SPACE",
1794 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001795 }
1796
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001797# check we are in a valid C source file if not then ignore this hunk
1798 next if ($realfile !~ /\.(h|c)$/);
1799
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001800# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001801 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001802 WARN("CVS_KEYWORD",
1803 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001804 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001805
Mike Frysinger42e41c52009-09-21 17:04:40 -07001806# Blackfin: don't use __builtin_bfin_[cs]sync
1807 if ($line =~ /__builtin_bfin_csync/) {
1808 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001809 ERROR("CSYNC",
1810 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001811 }
1812 if ($line =~ /__builtin_bfin_ssync/) {
1813 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001814 ERROR("SSYNC",
1815 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001816 }
1817
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001818# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001819 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1820 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001821#print "LINE<$line>\n";
1822 if ($linenr >= $suppress_statement &&
1823 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001824 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001825 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001826 $stat =~ s/\n./\n /g;
1827 $cond =~ s/\n./\n /g;
1828
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001829#print "linenr<$linenr> <$stat>\n";
1830 # If this statement has no statement boundaries within
1831 # it there is no point in retrying a statement scan
1832 # until we hit end of it.
1833 my $frag = $stat; $frag =~ s/;+\s*$//;
1834 if ($frag !~ /(?:{|;)/) {
1835#print "skip<$line_nr_next>\n";
1836 $suppress_statement = $line_nr_next;
1837 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001838
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001839 # Find the real next line.
1840 $realline_next = $line_nr_next;
1841 if (defined $realline_next &&
1842 (!defined $lines[$realline_next - 1] ||
1843 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1844 $realline_next++;
1845 }
1846
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001847 my $s = $stat;
1848 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001849
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001850 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001851 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001852
1853 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001854 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001855
Andy Whitcroft463f2862009-09-21 17:04:34 -07001856 } elsif ($s =~ /^.\s*else\b/s) {
1857
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001858 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001859 } 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 -07001860 my $type = $1;
1861 $type =~ s/\s+/ /g;
1862 possible($type, "A:" . $s);
1863
Andy Whitcroft8905a672007-11-28 16:21:06 -08001864 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001865 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001866 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001867 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001868
1869 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001870 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001871 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001872 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001873
1874 # Check for any sort of function declaration.
1875 # int foo(something bar, other baz);
1876 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001877 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 -08001878 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001879
Andy Whitcroftcf655042008-03-04 14:28:20 -08001880 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001881 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001882 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001883
Andy Whitcroft8905a672007-11-28 16:21:06 -08001884 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001885 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001886
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001887 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001888 }
1889 }
1890 }
1891
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001892 }
1893
Andy Whitcroft653d4872007-06-23 17:16:34 -07001894#
1895# Checks which may be anchored in the context.
1896#
1897
1898# Check for switch () and associated case and default
1899# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001900 if ($line=~/\bswitch\s*\(.*\)/) {
1901 my $err = '';
1902 my $sep = '';
1903 my @ctx = ctx_block_outer($linenr, $realcnt);
1904 shift(@ctx);
1905 for my $ctx (@ctx) {
1906 my ($clen, $cindent) = line_stats($ctx);
1907 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1908 $indent != $cindent) {
1909 $err .= "$sep$ctx\n";
1910 $sep = '';
1911 } else {
1912 $sep = "[...]\n";
1913 }
1914 }
1915 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07001916 ERROR("SWITCH_CASE_INDENT_LEVEL",
1917 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001918 }
1919 }
1920
1921# if/while/etc brace do not go on next line, unless defining a do while loop,
1922# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001923 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001924 my $pre_ctx = "$1$2";
1925
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001926 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001927 my $ctx_cnt = $realcnt - $#ctx - 1;
1928 my $ctx = join("\n", @ctx);
1929
Andy Whitcroft548596d2008-07-23 21:29:01 -07001930 my $ctx_ln = $linenr;
1931 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001932
Andy Whitcroft548596d2008-07-23 21:29:01 -07001933 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1934 defined $lines[$ctx_ln - 1] &&
1935 $lines[$ctx_ln - 1] =~ /^-/)) {
1936 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1937 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001938 $ctx_ln++;
1939 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001940
Andy Whitcroft53210162008-07-23 21:29:03 -07001941 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1942 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001943
1944 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001945 ERROR("OPEN_BRACE",
1946 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001947 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001948 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001949 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1950 $ctx =~ /\)\s*\;\s*$/ &&
1951 defined $lines[$ctx_ln - 1])
1952 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001953 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1954 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001955 WARN("TRAILING_SEMICOLON",
1956 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001957 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001958 }
1959 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001960 }
1961
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001962# Check relative indent for conditionals and blocks.
1963 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001964 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1965 ctx_statement_block($linenr, $realcnt, 0)
1966 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001967 my ($s, $c) = ($stat, $cond);
1968
1969 substr($s, 0, length($c), '');
1970
1971 # Make sure we remove the line prefixes as we have
1972 # none on the first line, and are going to readd them
1973 # where necessary.
1974 $s =~ s/\n./\n/gs;
1975
1976 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001977 my @newlines = ($c =~ /\n/gs);
1978 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001979
1980 # We want to check the first line inside the block
1981 # starting at the end of the conditional, so remove:
1982 # 1) any blank line termination
1983 # 2) any opening brace { on end of the line
1984 # 3) any do (...) {
1985 my $continuation = 0;
1986 my $check = 0;
1987 $s =~ s/^.*\bdo\b//;
1988 $s =~ s/^\s*{//;
1989 if ($s =~ s/^\s*\\//) {
1990 $continuation = 1;
1991 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001992 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001993 $check = 1;
1994 $cond_lines++;
1995 }
1996
1997 # Also ignore a loop construct at the end of a
1998 # preprocessor statement.
1999 if (($prevline =~ /^.\s*#\s*define\s/ ||
2000 $prevline =~ /\\\s*$/) && $continuation == 0) {
2001 $check = 0;
2002 }
2003
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002004 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002005 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002006 while ($cond_ptr != $cond_lines) {
2007 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002008
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002009 # If we see an #else/#elif then the code
2010 # is not linear.
2011 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2012 $check = 0;
2013 }
2014
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002015 # Ignore:
2016 # 1) blank lines, they should be at 0,
2017 # 2) preprocessor lines, and
2018 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002019 if ($continuation ||
2020 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002021 $s =~ /^\s*#\s*?/ ||
2022 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002023 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002024 if ($s =~ s/^.*?\n//) {
2025 $cond_lines++;
2026 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002027 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002028 }
2029
2030 my (undef, $sindent) = line_stats("+" . $s);
2031 my $stat_real = raw_line($linenr, $cond_lines);
2032
2033 # Check if either of these lines are modified, else
2034 # this is not this patch's fault.
2035 if (!defined($stat_real) ||
2036 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2037 $check = 0;
2038 }
2039 if (defined($stat_real) && $cond_lines > 1) {
2040 $stat_real = "[...]\n$stat_real";
2041 }
2042
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002043 #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 -07002044
2045 if ($check && (($sindent % 8) != 0 ||
2046 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002047 WARN("SUSPECT_CODE_INDENT",
2048 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002049 }
2050 }
2051
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002052 # Track the 'values' across context and added lines.
2053 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002054 my ($curr_values, $curr_vars) =
2055 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002056 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002057 if ($dbg_values) {
2058 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002059 print "$linenr > .$outline\n";
2060 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002061 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002062 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002063 $prev_values = substr($curr_values, -1);
2064
Andy Whitcroft00df3442007-06-08 13:47:06 -07002065#ignore lines not being added
2066 if ($line=~/^[^\+]/) {next;}
2067
Andy Whitcroft653d4872007-06-23 17:16:34 -07002068# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002069 if ($dbg_type) {
2070 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002071 ERROR("TEST_TYPE",
2072 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002073 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002074 ERROR("TEST_NOT_TYPE",
2075 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002076 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002077 next;
2078 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002079# TEST: allow direct testing of the attribute matcher.
2080 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002081 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002082 ERROR("TEST_ATTR",
2083 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002084 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002085 ERROR("TEST_NOT_ATTR",
2086 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002087 }
2088 next;
2089 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002090
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002091# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002092 if ($line =~ /^.\s*{/ &&
2093 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002094 ERROR("OPEN_BRACE",
2095 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002096 }
2097
Andy Whitcroft653d4872007-06-23 17:16:34 -07002098#
2099# Checks which are anchored on the added line.
2100#
2101
2102# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002103 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002104 my $path = $1;
2105 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002106 ERROR("MALFORMED_INCLUDE",
2107 "malformed #include filename\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002108 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002109 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002110 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002111
2112# no C99 // comments
2113 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002114 ERROR("C99_COMMENTS",
2115 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002116 }
2117 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002118 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002119 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002120
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002121# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2122# the whole statement.
2123#print "APW <$lines[$realline_next - 1]>\n";
2124 if (defined $realline_next &&
2125 exists $lines[$realline_next - 1] &&
2126 !defined $suppress_export{$realline_next} &&
2127 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2128 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002129 # Handle definitions which produce identifiers with
2130 # a prefix:
2131 # XXX(foo);
2132 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002133 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002134 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002135 $name =~ /^${Ident}_$2/) {
2136#print "FOO C name<$name>\n";
2137 $suppress_export{$realline_next} = 1;
2138
2139 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002140 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002141 ^.DEFINE_$Ident\(\Q$name\E\)|
2142 ^.DECLARE_$Ident\(\Q$name\E\)|
2143 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002144 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2145 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002146 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002147#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2148 $suppress_export{$realline_next} = 2;
2149 } else {
2150 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002151 }
2152 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002153 if (!defined $suppress_export{$linenr} &&
2154 $prevline =~ /^.\s*$/ &&
2155 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2156 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2157#print "FOO B <$lines[$linenr - 1]>\n";
2158 $suppress_export{$linenr} = 2;
2159 }
2160 if (defined $suppress_export{$linenr} &&
2161 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002162 WARN("EXPORT_SYMBOL",
2163 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002164 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002165
Joe Eloff5150bda2010-08-09 17:21:00 -07002166# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002167 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002168 ERROR("GLOBAL_INITIALISERS",
2169 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002170 $herecurr);
2171 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002172# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002173 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002174 ERROR("INITIALISED_STATIC",
2175 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002176 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002177 }
2178
Joe Perchescb710ec2010-10-26 14:23:20 -07002179# check for static const char * arrays.
2180 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002181 WARN("STATIC_CONST_CHAR_ARRAY",
2182 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002183 $herecurr);
2184 }
2185
2186# check for static char foo[] = "bar" declarations.
2187 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002188 WARN("STATIC_CONST_CHAR_ARRAY",
2189 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002190 $herecurr);
2191 }
2192
Joe Perches93ed0e22010-10-26 14:23:21 -07002193# check for declarations of struct pci_device_id
2194 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002195 WARN("DEFINE_PCI_DEVICE_TABLE",
2196 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002197 }
2198
Andy Whitcroft653d4872007-06-23 17:16:34 -07002199# check for new typedefs, only function parameters and sparse annotations
2200# make sense.
2201 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002202 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002203 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002204 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002205 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002206 WARN("NEW_TYPEDEFS",
2207 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002208 }
2209
2210# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002211 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002212 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2213 #print "AA<$1>\n";
2214 my ($from, $to) = ($2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002215
Andy Whitcroft65863862009-01-06 14:41:21 -08002216 # Should start with a space.
2217 $to =~ s/^(\S)/ $1/;
2218 # Should not end with a space.
2219 $to =~ s/\s+$//;
2220 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002221 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002222 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002223
Andy Whitcroft65863862009-01-06 14:41:21 -08002224 #print "from<$from> to<$to>\n";
2225 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002226 ERROR("POINTER_LOCATION",
2227 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002228 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002229 }
2230 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2231 #print "BB<$1>\n";
2232 my ($from, $to, $ident) = ($2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002233
Andy Whitcroft65863862009-01-06 14:41:21 -08002234 # Should start with a space.
2235 $to =~ s/^(\S)/ $1/;
2236 # Should not end with a space.
2237 $to =~ s/\s+$//;
2238 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002239 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002240 }
2241 # Modifiers should have spaces.
2242 $to =~ s/(\b$Modifier$)/$1 /;
2243
Andy Whitcroft667026e2009-02-27 14:03:08 -08002244 #print "from<$from> to<$to> ident<$ident>\n";
2245 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002246 ERROR("POINTER_LOCATION",
2247 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002248 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002249 }
2250
2251# # no BUG() or BUG_ON()
2252# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2253# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2254# print "$herecurr";
2255# $clean = 0;
2256# }
2257
Andy Whitcroft8905a672007-11-28 16:21:06 -08002258 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002259 WARN("LINUX_VERSION_CODE",
2260 "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 -08002261 }
2262
Joe Perches17441222011-06-15 15:08:17 -07002263# check for uses of printk_ratelimit
2264 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002265 WARN("PRINTK_RATELIMITED",
2266"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002267 }
2268
Andy Whitcroft00df3442007-06-08 13:47:06 -07002269# printk should use KERN_* levels. Note that follow on printk's on the
2270# same line do not need a level, so we use the current block context
2271# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002272# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002273# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002274 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002275 my $ok = 0;
2276 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2277 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002278 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002279 # with "\n" ignore it, else it is to blame
2280 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2281 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2282 $ok = 1;
2283 }
2284 last;
2285 }
2286 }
2287 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002288 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2289 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002290 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002291 }
2292
Andy Whitcroft653d4872007-06-23 17:16:34 -07002293# function brace can't be on same line, except for #defines of do while,
2294# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002295 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2296 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002297 ERROR("OPEN_BRACE",
2298 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002299 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002300
Andy Whitcroft8905a672007-11-28 16:21:06 -08002301# open braces for enum, union and struct go on the same line.
2302 if ($line =~ /^.\s*{/ &&
2303 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002304 ERROR("OPEN_BRACE",
2305 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002306 }
2307
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002308# missing space after union, struct or enum definition
2309 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002310 WARN("SPACING",
2311 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002312 }
2313
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002314# check for spacing round square brackets; allowed:
2315# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002316# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2317# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002318 while ($line =~ /(.*?\s)\[/g) {
2319 my ($where, $prefix) = ($-[1], $1);
2320 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002321 ($where != 0 || $prefix !~ /^.\s+$/) &&
2322 $prefix !~ /{\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002323 ERROR("BRACKET_SPACE",
2324 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002325 }
2326 }
2327
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002328# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002329 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002330 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002331 my $ctx_before = substr($line, 0, $-[1]);
2332 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002333
2334 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002335 if ($name =~ /^(?:
2336 if|for|while|switch|return|case|
2337 volatile|__volatile__|
2338 __attribute__|format|__extension__|
2339 asm|__asm__)$/x)
2340 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002341
2342 # cpp #define statements have non-optional spaces, ie
2343 # if there is a space between the name and the open
2344 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002345 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002346
2347 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002348 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002349
2350 # If this whole things ends with a type its most
2351 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002352 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002353
2354 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002355 WARN("SPACING",
2356 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002357 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002358 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002359# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002360 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002361 my $ops = qr{
2362 <<=|>>=|<=|>=|==|!=|
2363 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2364 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002365 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2366 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002367 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002368 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002369 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002370
2371 my $blank = copy_spacing($opline);
2372
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002373 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002374 $off += length($elements[$n]);
2375
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002376 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002377 my $ca = substr($opline, 0, $off);
2378 my $cc = '';
2379 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2380 $cc = substr($opline, $off + length($elements[$n + 1]));
2381 }
2382 my $cb = "$ca$;$cc";
2383
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002384 my $a = '';
2385 $a = 'V' if ($elements[$n] ne '');
2386 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002387 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002388 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2389 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002390 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002391
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002392 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002393
2394 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002395 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002396 $c = 'V' if ($elements[$n + 2] ne '');
2397 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002398 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002399 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2400 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002401 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002402 } else {
2403 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002404 }
2405
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002406 my $ctx = "${a}x${c}";
2407
2408 my $at = "(ctx:$ctx)";
2409
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002410 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002411 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002412
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002413 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002414 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002415
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002416 # Get the full operator variant.
2417 my $opv = $op . substr($curr_vars, $off, 1);
2418
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002419 # Ignore operators passed as parameters.
2420 if ($op_type ne 'V' &&
2421 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2422
Andy Whitcroftcf655042008-03-04 14:28:20 -08002423# # Ignore comments
2424# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002425
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002426 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002427 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002428 if ($ctx !~ /.x[WEBC]/ &&
2429 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002430 ERROR("SPACING",
2431 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002432 }
2433
2434 # // is a comment
2435 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002436
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002437 # No spaces for:
2438 # ->
2439 # : when part of a bitfield
2440 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002441 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002442 ERROR("SPACING",
2443 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002444 }
2445
2446 # , must have a space on the right.
2447 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002448 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002449 ERROR("SPACING",
2450 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002451 }
2452
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002453 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002454 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002455 #warn "'*' is part of type\n";
2456
2457 # unary operators should have a space before and
2458 # none after. May be left adjacent to another
2459 # unary operator, or a cast
2460 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002461 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002462 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002463 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002464 ERROR("SPACING",
2465 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002466 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002467 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002468 # A unary '*' may be const
2469
2470 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002471 ERROR("SPACING",
2472 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002473 }
2474
2475 # unary ++ and unary -- are allowed no space on one side.
2476 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002477 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002478 ERROR("SPACING",
2479 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002480 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002481 if ($ctx =~ /Wx[BE]/ ||
2482 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002483 ERROR("SPACING",
2484 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002485 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002486 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002487 ERROR("SPACING",
2488 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002489 }
2490
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002491
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002492 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002493 } elsif ($op eq '<<' or $op eq '>>' or
2494 $op eq '&' or $op eq '^' or $op eq '|' or
2495 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002496 $op eq '*' or $op eq '/' or
2497 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002498 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002499 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002500 ERROR("SPACING",
2501 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002502 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002503 }
2504
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002505 # A colon needs no spaces before when it is
2506 # terminating a case value or a label.
2507 } elsif ($opv eq ':C' || $opv eq ':L') {
2508 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002509 ERROR("SPACING",
2510 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002511 }
2512
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002513 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002514 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002515 my $ok = 0;
2516
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002517 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002518 if (($op eq '<' &&
2519 $cc =~ /^\S+\@\S+>/) ||
2520 ($op eq '>' &&
2521 $ca =~ /<\S+\@\S+$/))
2522 {
2523 $ok = 1;
2524 }
2525
2526 # Ignore ?:
2527 if (($opv eq ':O' && $ca =~ /\?$/) ||
2528 ($op eq '?' && $cc =~ /^:/)) {
2529 $ok = 1;
2530 }
2531
2532 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002533 ERROR("SPACING",
2534 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002535 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002536 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002537 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002538 }
2539 }
2540
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002541# check for multiple assignments
2542 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002543 CHK("MULTIPLE_ASSIGNMENTS",
2544 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002545 }
2546
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002547## # check for multiple declarations, allowing for a function declaration
2548## # continuation.
2549## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2550## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2551##
2552## # Remove any bracketed sections to ensure we do not
2553## # falsly report the parameters of functions.
2554## my $ln = $line;
2555## while ($ln =~ s/\([^\(\)]*\)//g) {
2556## }
2557## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002558## WARN("MULTIPLE_DECLARATION",
2559## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002560## }
2561## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002562
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002563#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002564 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2565 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002566 ERROR("SPACING",
2567 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002568 }
2569
2570# closing brace should have a space following it when it has anything
2571# on the line
2572 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002573 ERROR("SPACING",
2574 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002575 }
2576
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002577# check spacing on square brackets
2578 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002579 ERROR("SPACING",
2580 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002581 }
2582 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002583 ERROR("SPACING",
2584 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002585 }
2586
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002587# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002588 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2589 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002590 ERROR("SPACING",
2591 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002592 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002593 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002594 $line !~ /for\s*\(.*;\s+\)/ &&
2595 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002596 ERROR("SPACING",
2597 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002598 }
2599
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002600#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002601 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002602 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002603 WARN("INDENTED_LABEL",
2604 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002605 }
2606
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002607# Return is not a function.
2608 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2609 my $spacing = $1;
2610 my $value = $2;
2611
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002612 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002613 $value =~ s/\(/ \(/g;
2614 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08002615 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002616 $value !~ /(?:$Ident|-?$Constant)\s*
2617 $Compare\s*
2618 (?:$Ident|-?$Constant)/x &&
2619 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002620 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002621#print "value<$value>\n";
2622 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002623 ERROR("RETURN_PARENTHESES",
2624 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002625
2626 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002627 ERROR("SPACING",
2628 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002629 }
2630 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002631# Return of what appears to be an errno should normally be -'ve
2632 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2633 my $name = $1;
2634 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002635 WARN("USE_NEGATIVE_ERRNO",
2636 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002637 }
2638 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002639
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002640# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002641 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002642 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002643 }
2644
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002645# Check for illegal assignment in if conditional -- and check for trailing
2646# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002647 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002648 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2649 ctx_statement_block($linenr, $realcnt, 0)
2650 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002651 my ($stat_next) = ctx_statement_block($line_nr_next,
2652 $remain_next, $off_next);
2653 $stat_next =~ s/\n./\n /g;
2654 ##print "stat<$stat> stat_next<$stat_next>\n";
2655
2656 if ($stat_next =~ /^\s*while\b/) {
2657 # If the statement carries leading newlines,
2658 # then count those as offsets.
2659 my ($whitespace) =
2660 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2661 my $offset =
2662 statement_rawlines($whitespace) - 1;
2663
2664 $suppress_whiletrailers{$line_nr_next +
2665 $offset} = 1;
2666 }
2667 }
2668 if (!defined $suppress_whiletrailers{$linenr} &&
2669 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002670 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002671
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002672 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002673 ERROR("ASSIGN_IN_IF",
2674 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002675 }
2676
2677 # Find out what is on the end of the line after the
2678 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002679 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002680 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002681 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002682 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2683 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002684 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002685 # Find out how long the conditional actually is.
2686 my @newlines = ($c =~ /\n/gs);
2687 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002688 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002689
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002690 $stat_real = raw_line($linenr, $cond_lines)
2691 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002692 if (defined($stat_real) && $cond_lines > 1) {
2693 $stat_real = "[...]\n$stat_real";
2694 }
2695
Joe Perches000d1cc12011-07-25 17:13:25 -07002696 ERROR("TRAILING_STATEMENTS",
2697 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002698 }
2699 }
2700
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002701# Check for bitwise tests written as boolean
2702 if ($line =~ /
2703 (?:
2704 (?:\[|\(|\&\&|\|\|)
2705 \s*0[xX][0-9]+\s*
2706 (?:\&\&|\|\|)
2707 |
2708 (?:\&\&|\|\|)
2709 \s*0[xX][0-9]+\s*
2710 (?:\&\&|\|\||\)|\])
2711 )/x)
2712 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002713 WARN("HEXADECIMAL_BOOLEAN_TEST",
2714 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002715 }
2716
Andy Whitcroft8905a672007-11-28 16:21:06 -08002717# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002718 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2719 my $s = $1;
2720 $s =~ s/$;//g; # Remove any comments
2721 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002722 ERROR("TRAILING_STATEMENTS",
2723 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002724 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002725 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002726# if should not continue a brace
2727 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002728 ERROR("TRAILING_STATEMENTS",
2729 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002730 $herecurr);
2731 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002732# case and default should not have general statements after them
2733 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2734 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002735 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002736 \s*return\s+
2737 )/xg)
2738 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002739 ERROR("TRAILING_STATEMENTS",
2740 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002741 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002742
2743 # Check for }<nl>else {, these must be at the same
2744 # indent level to be relevant to each other.
2745 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2746 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002747 ERROR("ELSE_AFTER_BRACE",
2748 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002749 }
2750
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002751 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2752 $previndent == $indent) {
2753 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2754
2755 # Find out what is on the end of the line after the
2756 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002757 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002758 $s =~ s/\n.*//g;
2759
2760 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002761 ERROR("WHILE_AFTER_BRACE",
2762 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002763 }
2764 }
2765
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002766#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2767# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2768# print "No studly caps, use _\n";
2769# print "$herecurr";
2770# $clean = 0;
2771# }
2772
2773#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002774 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002775 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2776 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002777 }
2778
Andy Whitcroft653d4872007-06-23 17:16:34 -07002779#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002780 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002781 my $file = "$1.h";
2782 my $checkfile = "include/linux/$file";
2783 if (-f "$root/$checkfile" &&
2784 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002785 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002786 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002787 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002788 CHK("ARCH_INCLUDE_LINUX",
2789 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002790 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002791 WARN("INCLUDE_LINUX",
2792 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002793 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002794 }
2795 }
2796
Andy Whitcroft653d4872007-06-23 17:16:34 -07002797# multi-statement macros should be enclosed in a do while loop, grab the
2798# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002799# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002800 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2801 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002802 my $ln = $linenr;
2803 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002804 my ($off, $dstat, $dcond, $rest);
2805 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002806 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002807 ctx_statement_block($linenr, $realcnt, 0);
2808 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002809 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002810 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002811
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002812 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002813 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002814 $dstat =~ s/\\\n.//g;
2815 $dstat =~ s/^\s*//s;
2816 $dstat =~ s/\s*$//s;
2817
2818 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002819 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2820 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08002821 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002822 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002823 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002824
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002825 my $exceptions = qr{
2826 $Declare|
2827 module_param_named|
2828 MODULE_PARAM_DESC|
2829 DECLARE_PER_CPU|
2830 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002831 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002832 union|
2833 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002834 \.$Ident\s*=\s*|
2835 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002836 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07002837 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002838 if ($dstat ne '' &&
2839 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2840 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
2841 $dstat !~ /^(?:$Ident|-?$Constant)$/ && # 10 // foo()
2842 $dstat !~ /$exceptions/ &&
2843 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Andy Whitcroft72f115f2012-01-10 15:10:06 -08002844 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002845 $dstat !~ /^for\s*$Constant$/ && # for (...)
2846 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2847 $dstat !~ /^do\s*{/ && # do {...
2848 $dstat !~ /^\({/) # ({...
2849 {
2850 $ctx =~ s/\n*$//;
2851 my $herectx = $here . "\n";
2852 my $cnt = statement_rawlines($ctx);
2853
2854 for (my $n = 0; $n < $cnt; $n++) {
2855 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002856 }
2857
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002858 if ($dstat =~ /;/) {
2859 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2860 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
2861 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002862 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002863 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002864 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002865 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002866 }
2867
Mike Frysinger080ba922009-01-06 14:41:25 -08002868# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2869# all assignments may have only one of the following with an assignment:
2870# .
2871# ALIGN(...)
2872# VMLINUX_SYMBOL(...)
2873 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002874 WARN("MISSING_VMLINUX_SYMBOL",
2875 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08002876 }
2877
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002878# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002879 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2880 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002881 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002882 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002883 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2884 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002885 my $allowed = 0;
2886 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002887 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002888 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002889 for my $chunk (@chunks) {
2890 my ($cond, $block) = @{$chunk};
2891
Andy Whitcroft773647a2008-03-28 14:15:58 -07002892 # If the condition carries leading newlines, then count those as offsets.
2893 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2894 my $offset = statement_rawlines($whitespace) - 1;
2895
2896 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2897
2898 # We have looked at and allowed this specific line.
2899 $suppress_ifbraces{$ln + $offset} = 1;
2900
2901 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002902 $ln += statement_rawlines($block) - 1;
2903
Andy Whitcroft773647a2008-03-28 14:15:58 -07002904 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002905
2906 $seen++ if ($block =~ /^\s*{/);
2907
Andy Whitcroftcf655042008-03-04 14:28:20 -08002908 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2909 if (statement_lines($cond) > 1) {
2910 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002911 $allowed = 1;
2912 }
2913 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002914 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002915 $allowed = 1;
2916 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002917 if (statement_block_size($block) > 1) {
2918 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002919 $allowed = 1;
2920 }
2921 }
2922 if ($seen && !$allowed) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002923 WARN("BRACES",
2924 "braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002925 }
2926 }
2927 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002928 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002929 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002930 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002931
Andy Whitcroftcf655042008-03-04 14:28:20 -08002932 # Check the pre-context.
2933 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2934 #print "APW: ALLOWED: pre<$1>\n";
2935 $allowed = 1;
2936 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002937
2938 my ($level, $endln, @chunks) =
2939 ctx_statement_full($linenr, $realcnt, $-[0]);
2940
Andy Whitcroftcf655042008-03-04 14:28:20 -08002941 # Check the condition.
2942 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002943 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002944 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002945 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002946 }
2947 if (statement_lines($cond) > 1) {
2948 #print "APW: ALLOWED: cond<$cond>\n";
2949 $allowed = 1;
2950 }
2951 if ($block =~/\b(?:if|for|while)\b/) {
2952 #print "APW: ALLOWED: block<$block>\n";
2953 $allowed = 1;
2954 }
2955 if (statement_block_size($block) > 1) {
2956 #print "APW: ALLOWED: lines block<$block>\n";
2957 $allowed = 1;
2958 }
2959 # Check the post-context.
2960 if (defined $chunks[1]) {
2961 my ($cond, $block) = @{$chunks[1]};
2962 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002963 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002964 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002965 if ($block =~ /^\s*\{/) {
2966 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2967 $allowed = 1;
2968 }
2969 }
2970 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07002971 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07002972 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002973
Andy Whitcroftf0556632008-10-15 22:02:23 -07002974 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07002975 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002976 }
2977
Joe Perches000d1cc12011-07-25 17:13:25 -07002978 WARN("BRACES",
2979 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002980 }
2981 }
2982
Andy Whitcroft653d4872007-06-23 17:16:34 -07002983# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002984 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002985 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002986 ERROR("DEPRECATED_INCLUDE",
2987 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002988 }
2989 }
2990
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002991# don't use deprecated functions
2992 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002993 if ($line =~ /\b$func\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002994 ERROR("DEPRECATED_FUNCTION",
2995 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002996 }
2997 }
2998
2999# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003000 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3001 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003002 WARN("VOLATILE",
3003 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003004 }
3005
Andy Whitcroft00df3442007-06-08 13:47:06 -07003006# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003007 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003008 CHK("REDUNDANT_CODE",
3009 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003010 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003011 }
3012
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003013# check for needless kfree() checks
3014 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3015 my $expr = $1;
3016 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003017 WARN("NEEDLESS_KFREE",
3018 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003019 }
3020 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003021# check for needless usb_free_urb() checks
3022 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3023 my $expr = $1;
3024 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003025 WARN("NEEDLESS_USB_FREE_URB",
3026 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003027 }
3028 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003029
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003030# prefer usleep_range over udelay
3031 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3032 # ignore udelay's < 10, however
3033 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003034 CHK("USLEEP_RANGE",
3035 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003036 }
3037 }
3038
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003039# warn about unexpectedly long msleep's
3040 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3041 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003042 WARN("MSLEEP",
3043 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003044 }
3045 }
3046
Andy Whitcroft00df3442007-06-08 13:47:06 -07003047# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003048# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003049# print "#ifdef in C files should be avoided\n";
3050# print "$herecurr";
3051# $clean = 0;
3052# }
3053
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003054# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003055 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003056 ERROR("SPACING",
3057 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003058 }
3059
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003060# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003061 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3062 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003063 my $which = $1;
3064 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003065 CHK("UNCOMMENTED_DEFINITION",
3066 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003067 }
3068 }
3069# check for memory barriers without a comment.
3070 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3071 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003072 CHK("MEMORY_BARRIER",
3073 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003074 }
3075 }
3076# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003077 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003078 CHK("ARCH_DEFINES",
3079 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003080 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003081
Tobias Klauserd4977c72010-05-24 14:33:30 -07003082# Check that the storage class is at the beginning of a declaration
3083 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003084 WARN("STORAGE_CLASS",
3085 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003086 }
3087
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003088# check the location of the inline attribute, that it is between
3089# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003090 if ($line =~ /\b$Type\s+$Inline\b/ ||
3091 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003092 ERROR("INLINE_LOCATION",
3093 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003094 }
3095
Andy Whitcroft8905a672007-11-28 16:21:06 -08003096# Check for __inline__ and __inline, prefer inline
3097 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003098 WARN("INLINE",
3099 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003100 }
3101
Joe Perches3d130fd2011-01-12 17:00:00 -08003102# Check for __attribute__ packed, prefer __packed
3103 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003104 WARN("PREFER_PACKED",
3105 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003106 }
3107
Joe Perches39b7e282011-07-25 17:13:24 -07003108# Check for __attribute__ aligned, prefer __aligned
3109 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003110 WARN("PREFER_ALIGNED",
3111 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003112 }
3113
Joe Perches5f14d3b2012-01-10 15:09:52 -08003114# Check for __attribute__ format(printf, prefer __printf
3115 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3116 WARN("PREFER_PRINTF",
3117 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3118 }
3119
Joe Perches8f53a9b2010-03-05 13:43:48 -08003120# check for sizeof(&)
3121 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003122 WARN("SIZEOF_ADDRESS",
3123 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003124 }
3125
Joe Perches428e2fd2011-05-24 17:13:39 -07003126# check for line continuations in quoted strings with odd counts of "
3127 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003128 WARN("LINE_CONTINUATIONS",
3129 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003130 }
3131
Andy Whitcroft554e1652012-01-10 15:09:57 -08003132# Check for misused memsets
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003133 if (defined $stat &&
3134 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003135
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003136 my $ms_addr = $2;
3137 my $ms_val = $8;
3138 my $ms_size = $14;
3139
Andy Whitcroft554e1652012-01-10 15:09:57 -08003140 if ($ms_size =~ /^(0x|)0$/i) {
3141 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003142 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003143 } elsif ($ms_size =~ /^(0x|)1$/i) {
3144 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003145 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3146 }
3147 }
3148
3149# typecasts on min/max could be min_t/max_t
3150 if (defined $stat &&
3151 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3152 if (defined $2 || defined $8) {
3153 my $call = $1;
3154 my $cast1 = deparenthesize($2);
3155 my $arg1 = $3;
3156 my $cast2 = deparenthesize($8);
3157 my $arg2 = $9;
3158 my $cast;
3159
3160 if ($cast1 ne "" && $cast2 ne "") {
3161 $cast = "$cast1 or $cast2";
3162 } elsif ($cast1 ne "") {
3163 $cast = $cast1;
3164 } else {
3165 $cast = $cast2;
3166 }
3167 WARN("MINMAX",
3168 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003169 }
3170 }
3171
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003172# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003173 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003174 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003175 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003176 my $function_name = $1;
3177 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003178
3179 my $s = $stat;
3180 if (defined $cond) {
3181 substr($s, 0, length($cond), '');
3182 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003183 if ($s =~ /^\s*;/ &&
3184 $function_name ne 'uninitialized_var')
3185 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003186 WARN("AVOID_EXTERNS",
3187 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003188 }
3189
3190 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003191 WARN("FUNCTION_ARGUMENTS",
3192 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003193 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003194
3195 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3196 $stat =~ /^.\s*extern\s+/)
3197 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003198 WARN("AVOID_EXTERNS",
3199 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003200 }
3201
3202# checks for new __setup's
3203 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3204 my $name = $1;
3205
3206 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003207 CHK("UNDOCUMENTED_SETUP",
3208 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003209 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003210 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003211
3212# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003213 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003214 WARN("UNNECESSARY_CASTS",
3215 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003216 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003217
Joe Perchescaf2a542011-01-12 16:59:56 -08003218# check for multiple semicolons
3219 if ($line =~ /;\s*;\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003220 WARN("ONE_SEMICOLON",
3221 "Statements terminations use 1 semicolon\n" . $herecurr);
Joe Perchescaf2a542011-01-12 16:59:56 -08003222 }
3223
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003224# check for gcc specific __FUNCTION__
3225 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003226 WARN("USE_FUNC",
3227 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003228 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003229
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003230# check for semaphores initialized locked
3231 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003232 WARN("CONSIDER_COMPLETION",
3233 "consider using a completion\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003234
Andy Whitcroft773647a2008-03-28 14:15:58 -07003235 }
Joe Perches67d0a072011-10-31 17:13:10 -07003236# recommend kstrto* over simple_strto* and strict_strto*
3237 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003238 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003239 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003240 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07003241# check for __initcall(), use device_initcall() explicitly please
3242 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003243 WARN("USE_DEVICE_INITCALL",
3244 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003245 }
Emese Revfy79404842010-03-05 13:43:53 -08003246# check for various ops structs, ensure they are const.
3247 my $struct_ops = qr{acpi_dock_ops|
3248 address_space_operations|
3249 backlight_ops|
3250 block_device_operations|
3251 dentry_operations|
3252 dev_pm_ops|
3253 dma_map_ops|
3254 extent_io_ops|
3255 file_lock_operations|
3256 file_operations|
3257 hv_ops|
3258 ide_dma_ops|
3259 intel_dvo_dev_ops|
3260 item_operations|
3261 iwl_ops|
3262 kgdb_arch|
3263 kgdb_io|
3264 kset_uevent_ops|
3265 lock_manager_operations|
3266 microcode_ops|
3267 mtrr_ops|
3268 neigh_ops|
3269 nlmsvc_binding|
3270 pci_raw_ops|
3271 pipe_buf_operations|
3272 platform_hibernation_ops|
3273 platform_suspend_ops|
3274 proto_ops|
3275 rpc_pipe_ops|
3276 seq_operations|
3277 snd_ac97_build_ops|
3278 soc_pcmcia_socket_ops|
3279 stacktrace_ops|
3280 sysfs_ops|
3281 tty_operations|
3282 usb_mon_operations|
3283 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003284 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003285 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003286 WARN("CONST_STRUCT",
3287 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003288 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003289 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003290
3291# use of NR_CPUS is usually wrong
3292# ignore definitions of NR_CPUS and usage to define arrays as likely right
3293 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003294 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3295 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003296 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3297 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3298 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003299 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003300 WARN("NR_CPUS",
3301 "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 -07003302 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003303
3304# check for %L{u,d,i} in strings
3305 my $string;
3306 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3307 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003308 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003309 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003310 WARN("PRINTF_L",
3311 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003312 last;
3313 }
3314 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003315
3316# whine mightly about in_atomic
3317 if ($line =~ /\bin_atomic\s*\(/) {
3318 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003319 ERROR("IN_ATOMIC",
3320 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003321 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003322 WARN("IN_ATOMIC",
3323 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003324 }
3325 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003326
3327# check for lockdep_set_novalidate_class
3328 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3329 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3330 if ($realfile !~ m@^kernel/lockdep@ &&
3331 $realfile !~ m@^include/linux/lockdep@ &&
3332 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003333 ERROR("LOCKDEP",
3334 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003335 }
3336 }
Dave Jones88f88312011-01-12 16:59:59 -08003337
3338 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3339 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003340 WARN("EXPORTED_WORLD_WRITABLE",
3341 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003342 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003343 }
3344
3345 # If we have no input at all, then there is nothing to report on
3346 # so just keep quiet.
3347 if ($#rawlines == -1) {
3348 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003349 }
3350
Andy Whitcroft8905a672007-11-28 16:21:06 -08003351 # In mailback mode only produce a report in the negative, for
3352 # things that appear to be patches.
3353 if ($mailback && ($clean == 1 || !$is_patch)) {
3354 exit(0);
3355 }
3356
3357 # This is not a patch, and we are are in 'no-patch' mode so
3358 # just keep quiet.
3359 if (!$chk_patch && !$is_patch) {
3360 exit(0);
3361 }
3362
3363 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003364 ERROR("NOT_UNIFIED_DIFF",
3365 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003366 }
3367 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003368 ERROR("MISSING_SIGN_OFF",
3369 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003370 }
3371
Andy Whitcroft8905a672007-11-28 16:21:06 -08003372 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003373 if ($summary && !($clean == 1 && $quiet == 1)) {
3374 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003375 print "total: $cnt_error errors, $cnt_warn warnings, " .
3376 (($check)? "$cnt_chk checks, " : "") .
3377 "$cnt_lines lines checked\n";
3378 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003379 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003380
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003381 if ($quiet == 0) {
3382 # If there were whitespace errors which cleanpatch can fix
3383 # then suggest that.
3384 if ($rpt_cleaners) {
3385 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3386 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003387 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003388 }
3389 }
3390
Joe Perches000d1cc12011-07-25 17:13:25 -07003391 if (keys %ignore_type) {
3392 print "NOTE: Ignored message types:";
3393 foreach my $ignore (sort keys %ignore_type) {
3394 print " $ignore";
3395 }
3396 print "\n";
3397 print "\n" if ($quiet == 0);
3398 }
3399
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003400 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003401 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003402 }
3403 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003404 print << "EOM";
3405$vname has style problems, please review.
3406
3407If any of these errors are false positives, please report
3408them to the maintainer, see CHECKPATCH in MAINTAINERS.
3409EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003410 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003411
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003412 return $clean;
3413}