blob: f18750e3bd6c290b285464b193d7d65972b6de19 [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 Whitcroftb337d8b2012-03-23 15:02:18 -0700326 (?:(?:\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 -0700333
334our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700335
336# Using $balanced_parens, $LvalOrFunc, or $FuncArg
337# requires at least perl version v5.10.0
338# Any use must be runtime checked with $^V
339
340our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
341our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800342our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700343
344sub deparenthesize {
345 my ($string) = @_;
346 return "" if (!defined($string));
347 $string =~ s@^\s*\(\s*@@g;
348 $string =~ s@\s*\)\s*$@@g;
349 $string =~ s@\s+@ @g;
350 return $string;
351}
352
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700353$chk_signoff = 0 if ($file);
354
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700355my @dep_includes = ();
356my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700357my $removal = "Documentation/feature-removal-schedule.txt";
358if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800359 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700360 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800361 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700362 if (/^Check:\s+(.*\S)/) {
363 for my $entry (split(/[, ]+/, $1)) {
364 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700365 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700366
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700367 } elsif ($entry !~ m@/@) {
368 push(@dep_functions, $entry);
369 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700370 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700371 }
372 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800373 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700374}
375
Andy Whitcroft00df3442007-06-08 13:47:06 -0700376my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800377my @lines = ();
378my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700379for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800380 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700381 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800382 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700383 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800384 } elsif ($filename eq '-') {
385 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700386 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800387 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700388 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700389 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800390 if ($filename eq '-') {
391 $vname = 'Your patch';
392 } else {
393 $vname = $filename;
394 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800395 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700396 chomp;
397 push(@rawlines, $_);
398 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800399 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800400 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700401 $exit = 1;
402 }
403 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800404 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700405}
406
407exit($exit);
408
409sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700410 my ($root) = @_;
411
412 my @tree_check = (
413 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
414 "README", "Documentation", "arch", "include", "drivers",
415 "fs", "init", "ipc", "kernel", "lib", "scripts",
416 );
417
418 foreach my $check (@tree_check) {
419 if (! -e $root . '/' . $check) {
420 return 0;
421 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700422 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700423 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700424}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700425
Joe Perches20112472011-07-25 17:13:23 -0700426sub parse_email {
427 my ($formatted_email) = @_;
428
429 my $name = "";
430 my $address = "";
431 my $comment = "";
432
433 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
434 $name = $1;
435 $address = $2;
436 $comment = $3 if defined $3;
437 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
438 $address = $1;
439 $comment = $2 if defined $2;
440 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
441 $address = $1;
442 $comment = $2 if defined $2;
443 $formatted_email =~ s/$address.*$//;
444 $name = $formatted_email;
445 $name =~ s/^\s+|\s+$//g;
446 $name =~ s/^\"|\"$//g;
447 # If there's a name left after stripping spaces and
448 # leading quotes, and the address doesn't have both
449 # leading and trailing angle brackets, the address
450 # is invalid. ie:
451 # "joe smith joe@smith.com" bad
452 # "joe smith <joe@smith.com" bad
453 if ($name ne "" && $address !~ /^<[^>]+>$/) {
454 $name = "";
455 $address = "";
456 $comment = "";
457 }
458 }
459
460 $name =~ s/^\s+|\s+$//g;
461 $name =~ s/^\"|\"$//g;
462 $address =~ s/^\s+|\s+$//g;
463 $address =~ s/^\<|\>$//g;
464
465 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
466 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
467 $name = "\"$name\"";
468 }
469
470 return ($name, $address, $comment);
471}
472
473sub format_email {
474 my ($name, $address) = @_;
475
476 my $formatted_email;
477
478 $name =~ s/^\s+|\s+$//g;
479 $name =~ s/^\"|\"$//g;
480 $address =~ s/^\s+|\s+$//g;
481
482 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
483 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
484 $name = "\"$name\"";
485 }
486
487 if ("$name" eq "") {
488 $formatted_email = "$address";
489 } else {
490 $formatted_email = "$name <$address>";
491 }
492
493 return $formatted_email;
494}
495
Joe Perches000d1cc12011-07-25 17:13:25 -0700496sub which_conf {
497 my ($conf) = @_;
498
499 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
500 if (-e "$path/$conf") {
501 return "$path/$conf";
502 }
503 }
504
505 return "";
506}
507
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700508sub expand_tabs {
509 my ($str) = @_;
510
511 my $res = '';
512 my $n = 0;
513 for my $c (split(//, $str)) {
514 if ($c eq "\t") {
515 $res .= ' ';
516 $n++;
517 for (; ($n % 8) != 0; $n++) {
518 $res .= ' ';
519 }
520 next;
521 }
522 $res .= $c;
523 $n++;
524 }
525
526 return $res;
527}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700528sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700529 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700530 return $res;
531}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700532
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700533sub line_stats {
534 my ($line) = @_;
535
536 # Drop the diff line leader and expand tabs
537 $line =~ s/^.//;
538 $line = expand_tabs($line);
539
540 # Pick the indent from the front of the line.
541 my ($white) = ($line =~ /^(\s*)/);
542
543 return (length($line), length($white));
544}
545
Andy Whitcroft773647a2008-03-28 14:15:58 -0700546my $sanitise_quote = '';
547
548sub sanitise_line_reset {
549 my ($in_comment) = @_;
550
551 if ($in_comment) {
552 $sanitise_quote = '*/';
553 } else {
554 $sanitise_quote = '';
555 }
556}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700557sub sanitise_line {
558 my ($line) = @_;
559
560 my $res = '';
561 my $l = '';
562
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800563 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700564 my $off = 0;
565 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700566
Andy Whitcroft773647a2008-03-28 14:15:58 -0700567 # Always copy over the diff marker.
568 $res = substr($line, 0, 1);
569
570 for ($off = 1; $off < length($line); $off++) {
571 $c = substr($line, $off, 1);
572
573 # Comments we are wacking completly including the begin
574 # and end, all to $;.
575 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
576 $sanitise_quote = '*/';
577
578 substr($res, $off, 2, "$;$;");
579 $off++;
580 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800581 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700582 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700583 $sanitise_quote = '';
584 substr($res, $off, 2, "$;$;");
585 $off++;
586 next;
587 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700588 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
589 $sanitise_quote = '//';
590
591 substr($res, $off, 2, $sanitise_quote);
592 $off++;
593 next;
594 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700595
596 # A \ in a string means ignore the next character.
597 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
598 $c eq "\\") {
599 substr($res, $off, 2, 'XX');
600 $off++;
601 next;
602 }
603 # Regular quotes.
604 if ($c eq "'" || $c eq '"') {
605 if ($sanitise_quote eq '') {
606 $sanitise_quote = $c;
607
608 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700609 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700610 } elsif ($sanitise_quote eq $c) {
611 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700612 }
613 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700614
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800615 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700616 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
617 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700618 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
619 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700620 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
621 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700622 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700623 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700624 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800625 }
626
Daniel Walker113f04a2009-09-21 17:04:35 -0700627 if ($sanitise_quote eq '//') {
628 $sanitise_quote = '';
629 }
630
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800631 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700632 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800633 my $clean = 'X' x length($1);
634 $res =~ s@\<.*\>@<$clean>@;
635
636 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700637 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800638 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700639 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800640 }
641
Andy Whitcroft00df3442007-06-08 13:47:06 -0700642 return $res;
643}
644
Andy Whitcroft8905a672007-11-28 16:21:06 -0800645sub ctx_statement_block {
646 my ($linenr, $remain, $off) = @_;
647 my $line = $linenr - 1;
648 my $blk = '';
649 my $soff = $off;
650 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700651 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800652
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800653 my $loff = 0;
654
Andy Whitcroft8905a672007-11-28 16:21:06 -0800655 my $type = '';
656 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800657 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800658 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800659 my $c;
660 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800661
662 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800663 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800664 @stack = (['', 0]) if ($#stack == -1);
665
Andy Whitcroft773647a2008-03-28 14:15:58 -0700666 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800667 # If we are about to drop off the end, pull in more
668 # context.
669 if ($off >= $len) {
670 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700671 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800672 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800673 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800674 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800675 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800676 $len = length($blk);
677 $line++;
678 last;
679 }
680 # Bail if there is no further context.
681 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800682 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800683 last;
684 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800685 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
686 $level++;
687 $type = '#';
688 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800689 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800690 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800691 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800692 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800693
Andy Whitcroft773647a2008-03-28 14:15:58 -0700694 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800695
696 # Handle nested #if/#else.
697 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
698 push(@stack, [ $type, $level ]);
699 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
700 ($type, $level) = @{$stack[$#stack - 1]};
701 } elsif ($remainder =~ /^#\s*endif\b/) {
702 ($type, $level) = @{pop(@stack)};
703 }
704
Andy Whitcroft8905a672007-11-28 16:21:06 -0800705 # Statement ends at the ';' or a close '}' at the
706 # outermost level.
707 if ($level == 0 && $c eq ';') {
708 last;
709 }
710
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800711 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700712 if ($level == 0 && $coff_set == 0 &&
713 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
714 $remainder =~ /^(else)(?:\s|{)/ &&
715 $remainder !~ /^else\s+if\b/) {
716 $coff = $off + length($1) - 1;
717 $coff_set = 1;
718 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
719 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800720 }
721
Andy Whitcroft8905a672007-11-28 16:21:06 -0800722 if (($type eq '' || $type eq '(') && $c eq '(') {
723 $level++;
724 $type = '(';
725 }
726 if ($type eq '(' && $c eq ')') {
727 $level--;
728 $type = ($level != 0)? '(' : '';
729
730 if ($level == 0 && $coff < $soff) {
731 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700732 $coff_set = 1;
733 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800734 }
735 }
736 if (($type eq '' || $type eq '{') && $c eq '{') {
737 $level++;
738 $type = '{';
739 }
740 if ($type eq '{' && $c eq '}') {
741 $level--;
742 $type = ($level != 0)? '{' : '';
743
744 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700745 if (substr($blk, $off + 1, 1) eq ';') {
746 $off++;
747 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800748 last;
749 }
750 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800751 # Preprocessor commands end at the newline unless escaped.
752 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
753 $level--;
754 $type = '';
755 $off++;
756 last;
757 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800758 $off++;
759 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700760 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800761 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700762 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800763 $line++;
764 $remain--;
765 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800766
767 my $statement = substr($blk, $soff, $off - $soff + 1);
768 my $condition = substr($blk, $soff, $coff - $soff + 1);
769
770 #warn "STATEMENT<$statement>\n";
771 #warn "CONDITION<$condition>\n";
772
Andy Whitcroft773647a2008-03-28 14:15:58 -0700773 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800774
775 return ($statement, $condition,
776 $line, $remain + 1, $off - $loff + 1, $level);
777}
778
Andy Whitcroftcf655042008-03-04 14:28:20 -0800779sub statement_lines {
780 my ($stmt) = @_;
781
782 # Strip the diff line prefixes and rip blank lines at start and end.
783 $stmt =~ s/(^|\n)./$1/g;
784 $stmt =~ s/^\s*//;
785 $stmt =~ s/\s*$//;
786
787 my @stmt_lines = ($stmt =~ /\n/g);
788
789 return $#stmt_lines + 2;
790}
791
792sub statement_rawlines {
793 my ($stmt) = @_;
794
795 my @stmt_lines = ($stmt =~ /\n/g);
796
797 return $#stmt_lines + 2;
798}
799
800sub statement_block_size {
801 my ($stmt) = @_;
802
803 $stmt =~ s/(^|\n)./$1/g;
804 $stmt =~ s/^\s*{//;
805 $stmt =~ s/}\s*$//;
806 $stmt =~ s/^\s*//;
807 $stmt =~ s/\s*$//;
808
809 my @stmt_lines = ($stmt =~ /\n/g);
810 my @stmt_statements = ($stmt =~ /;/g);
811
812 my $stmt_lines = $#stmt_lines + 2;
813 my $stmt_statements = $#stmt_statements + 1;
814
815 if ($stmt_lines > $stmt_statements) {
816 return $stmt_lines;
817 } else {
818 return $stmt_statements;
819 }
820}
821
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800822sub ctx_statement_full {
823 my ($linenr, $remain, $off) = @_;
824 my ($statement, $condition, $level);
825
826 my (@chunks);
827
Andy Whitcroftcf655042008-03-04 14:28:20 -0800828 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800829 ($statement, $condition, $linenr, $remain, $off, $level) =
830 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700831 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800832 push(@chunks, [ $condition, $statement ]);
833 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
834 return ($level, $linenr, @chunks);
835 }
836
837 # Pull in the following conditional/block pairs and see if they
838 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800839 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800840 ($statement, $condition, $linenr, $remain, $off, $level) =
841 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800842 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700843 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800844 #print "C: push\n";
845 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800846 }
847
848 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800849}
850
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700851sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700852 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700853 my $line;
854 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700855 my $blk = '';
856 my @o;
857 my @c;
858 my @res = ();
859
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700860 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800861 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700862 for ($line = $start; $remain > 0; $line++) {
863 next if ($rawlines[$line] =~ /^-/);
864 $remain--;
865
866 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800867
868 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700869 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800870 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700871 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800872 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700873 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800874 $level = pop(@stack);
875 }
876
Andy Whitcroft01464f32010-10-26 14:23:19 -0700877 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700878 ##print "C<$c>L<$level><$open$close>O<$off>\n";
879 if ($off > 0) {
880 $off--;
881 next;
882 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700883
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700884 if ($c eq $close && $level > 0) {
885 $level--;
886 last if ($level == 0);
887 } elsif ($c eq $open) {
888 $level++;
889 }
890 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700891
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700892 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700893 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700894 }
895
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700896 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700897 }
898
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700899 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700900}
901sub ctx_block_outer {
902 my ($linenr, $remain) = @_;
903
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700904 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
905 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700906}
907sub ctx_block {
908 my ($linenr, $remain) = @_;
909
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700910 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
911 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700912}
913sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700914 my ($linenr, $remain, $off) = @_;
915
916 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
917 return @r;
918}
919sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700920 my ($linenr, $remain) = @_;
921
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700922 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700923}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700924sub ctx_statement_level {
925 my ($linenr, $remain, $off) = @_;
926
927 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
928}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700929
930sub ctx_locate_comment {
931 my ($first_line, $end_line) = @_;
932
933 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700934 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700935 return $current_comment if (defined $current_comment);
936
937 # Look through the context and try and figure out if there is a
938 # comment.
939 my $in_comment = 0;
940 $current_comment = '';
941 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700942 my $line = $rawlines[$linenr - 1];
943 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700944 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
945 $in_comment = 1;
946 }
947 if ($line =~ m@/\*@) {
948 $in_comment = 1;
949 }
950 if (!$in_comment && $current_comment ne '') {
951 $current_comment = '';
952 }
953 $current_comment .= $line . "\n" if ($in_comment);
954 if ($line =~ m@\*/@) {
955 $in_comment = 0;
956 }
957 }
958
959 chomp($current_comment);
960 return($current_comment);
961}
962sub ctx_has_comment {
963 my ($first_line, $end_line) = @_;
964 my $cmt = ctx_locate_comment($first_line, $end_line);
965
Andy Whitcroft00df3442007-06-08 13:47:06 -0700966 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700967 ##print "CMMT: $cmt\n";
968
969 return ($cmt ne '');
970}
971
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700972sub raw_line {
973 my ($linenr, $cnt) = @_;
974
975 my $offset = $linenr - 1;
976 $cnt++;
977
978 my $line;
979 while ($cnt) {
980 $line = $rawlines[$offset++];
981 next if (defined($line) && $line =~ /^-/);
982 $cnt--;
983 }
984
985 return $line;
986}
987
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700988sub cat_vet {
989 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700990 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700991
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700992 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700993 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
994 $res .= $1;
995 if ($2 ne '') {
996 $coded = sprintf("^%c", unpack('C', $2) + 64);
997 $res .= $coded;
998 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700999 }
1000 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001001
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001002 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001003}
1004
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001005my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001006my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001007my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001008my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001009
1010sub annotate_reset {
1011 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001012 $av_pending = '_';
1013 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001014 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001015}
1016
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001017sub annotate_values {
1018 my ($stream, $type) = @_;
1019
1020 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001021 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001022 my $cur = $stream;
1023
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001024 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001025
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001026 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001027 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001028 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001029 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001030 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001031 print "WS($1)\n" if ($dbg_values > 1);
1032 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001033 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001034 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001035 }
1036
Florian Micklerc023e4732011-01-12 16:59:58 -08001037 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001038 print "CAST($1)\n" if ($dbg_values > 1);
1039 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001040 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001041
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001042 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001043 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001044 $type = 'T';
1045
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001046 } elsif ($cur =~ /^($Modifier)\s*/) {
1047 print "MODIFIER($1)\n" if ($dbg_values > 1);
1048 $type = 'T';
1049
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001050 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001051 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001052 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001053 push(@av_paren_type, $type);
1054 if ($2 ne '') {
1055 $av_pending = 'N';
1056 }
1057 $type = 'E';
1058
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001059 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001060 print "UNDEF($1)\n" if ($dbg_values > 1);
1061 $av_preprocessor = 1;
1062 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001063
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001064 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001065 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001066 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001067
1068 push(@av_paren_type, $type);
1069 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001070 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001071
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001072 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001073 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1074 $av_preprocessor = 1;
1075
1076 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1077
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001078 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001079
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001080 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001081 print "PRE_END($1)\n" if ($dbg_values > 1);
1082
1083 $av_preprocessor = 1;
1084
1085 # Assume all arms of the conditional end as this
1086 # one does, and continue as if the #endif was not here.
1087 pop(@av_paren_type);
1088 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001089 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001090
1091 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001092 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001093
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001094 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1095 print "ATTR($1)\n" if ($dbg_values > 1);
1096 $av_pending = $type;
1097 $type = 'N';
1098
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001099 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001100 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001101 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001102 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001103 }
1104 $type = 'N';
1105
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001106 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001107 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001108 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001109 $type = 'N';
1110
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001111 } elsif ($cur =~/^(case)/o) {
1112 print "CASE($1)\n" if ($dbg_values > 1);
1113 $av_pend_colon = 'C';
1114 $type = 'N';
1115
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001116 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001117 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001118 $type = 'N';
1119
1120 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001121 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001122 push(@av_paren_type, $av_pending);
1123 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001124 $type = 'N';
1125
1126 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001127 my $new_type = pop(@av_paren_type);
1128 if ($new_type ne '_') {
1129 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001130 print "PAREN('$1') -> $type\n"
1131 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001132 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001133 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001134 }
1135
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001136 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001137 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001138 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001139 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001140
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001141 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1142 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001143 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001144 } elsif ($type eq 'E') {
1145 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001146 }
1147 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1148 $type = 'V';
1149
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001150 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001151 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001152 $type = 'V';
1153
1154 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001155 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001156 $type = 'N';
1157
Andy Whitcroftcf655042008-03-04 14:28:20 -08001158 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001159 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001160 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001161 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001162
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001163 } elsif ($cur =~/^(,)/) {
1164 print "COMMA($1)\n" if ($dbg_values > 1);
1165 $type = 'C';
1166
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001167 } elsif ($cur =~ /^(\?)/o) {
1168 print "QUESTION($1)\n" if ($dbg_values > 1);
1169 $type = 'N';
1170
1171 } elsif ($cur =~ /^(:)/o) {
1172 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1173
1174 substr($var, length($res), 1, $av_pend_colon);
1175 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1176 $type = 'E';
1177 } else {
1178 $type = 'N';
1179 }
1180 $av_pend_colon = 'O';
1181
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001182 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001183 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001184 $type = 'N';
1185
Andy Whitcroft0d413862008-10-15 22:02:16 -07001186 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001187 my $variant;
1188
1189 print "OPV($1)\n" if ($dbg_values > 1);
1190 if ($type eq 'V') {
1191 $variant = 'B';
1192 } else {
1193 $variant = 'U';
1194 }
1195
1196 substr($var, length($res), 1, $variant);
1197 $type = 'N';
1198
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001199 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001200 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001201 if ($1 ne '++' && $1 ne '--') {
1202 $type = 'N';
1203 }
1204
1205 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001206 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001207 }
1208 if (defined $1) {
1209 $cur = substr($cur, length($1));
1210 $res .= $type x length($1);
1211 }
1212 }
1213
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001214 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001215}
1216
Andy Whitcroft8905a672007-11-28 16:21:06 -08001217sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001218 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001219 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001220 ^(?:
1221 $Modifier|
1222 $Storage|
1223 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001224 DEFINE_\S+
1225 )$|
1226 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001227 goto|
1228 return|
1229 case|
1230 else|
1231 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001232 do|
1233 \#|
1234 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001235 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001236 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001237 )}x;
1238 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1239 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001240 # Check for modifiers.
1241 $possible =~ s/\s*$Storage\s*//g;
1242 $possible =~ s/\s*$Sparse\s*//g;
1243 if ($possible =~ /^\s*$/) {
1244
1245 } elsif ($possible =~ /\s/) {
1246 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001247 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001248 if ($modifier !~ $notPermitted) {
1249 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1250 push(@modifierList, $modifier);
1251 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001252 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001253
1254 } else {
1255 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1256 push(@typeList, $possible);
1257 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001258 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001259 } else {
1260 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001261 }
1262}
1263
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001264my $prefix = '';
1265
Joe Perches000d1cc12011-07-25 17:13:25 -07001266sub show_type {
1267 return !defined $ignore_type{$_[0]};
1268}
1269
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001270sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001271 if (!show_type($_[1]) ||
1272 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001273 return 0;
1274 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001275 my $line;
1276 if ($show_types) {
1277 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1278 } else {
1279 $line = "$prefix$_[0]: $_[2]\n";
1280 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001281 $line = (split('\n', $line))[0] . "\n" if ($terse);
1282
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001283 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001284
1285 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001286}
1287sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001288 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001289}
Joe Perches000d1cc12011-07-25 17:13:25 -07001290
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001291sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001292 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001293 our $clean = 0;
1294 our $cnt_error++;
1295 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001296}
1297sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001298 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001299 our $clean = 0;
1300 our $cnt_warn++;
1301 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001302}
1303sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001304 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001305 our $clean = 0;
1306 our $cnt_chk++;
1307 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001308}
1309
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001310sub check_absolute_file {
1311 my ($absolute, $herecurr) = @_;
1312 my $file = $absolute;
1313
1314 ##print "absolute<$absolute>\n";
1315
1316 # See if any suffix of this path is a path within the tree.
1317 while ($file =~ s@^[^/]*/@@) {
1318 if (-f "$root/$file") {
1319 ##print "file<$file>\n";
1320 last;
1321 }
1322 }
1323 if (! -f _) {
1324 return 0;
1325 }
1326
1327 # It is, so see if the prefix is acceptable.
1328 my $prefix = $absolute;
1329 substr($prefix, -length($file)) = '';
1330
1331 ##print "prefix<$prefix>\n";
1332 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001333 WARN("USE_RELATIVE_PATH",
1334 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001335 }
1336}
1337
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001338sub pos_last_openparen {
1339 my ($line) = @_;
1340
1341 my $pos = 0;
1342
1343 my $opens = $line =~ tr/\(/\(/;
1344 my $closes = $line =~ tr/\)/\)/;
1345
1346 my $last_openparen = 0;
1347
1348 if (($opens == 0) || ($closes >= $opens)) {
1349 return -1;
1350 }
1351
1352 my $len = length($line);
1353
1354 for ($pos = 0; $pos < $len; $pos++) {
1355 my $string = substr($line, $pos);
1356 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1357 $pos += length($1) - 1;
1358 } elsif (substr($line, $pos, 1) eq '(') {
1359 $last_openparen = $pos;
1360 } elsif (index($string, '(') == -1) {
1361 last;
1362 }
1363 }
1364
1365 return $last_openparen + 1;
1366}
1367
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001368sub process {
1369 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001370
1371 my $linenr=0;
1372 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001373 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001374 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001375 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001376
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001377 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001378 my $indent;
1379 my $previndent=0;
1380 my $stashindent=0;
1381
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001382 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001383 my $signoff = 0;
1384 my $is_patch = 0;
1385
Joe Perches15662b32011-10-31 17:13:12 -07001386 my $in_header_lines = 1;
1387 my $in_commit_log = 0; #Scanning lines before patch
1388
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001389 my $non_utf8_charset = 0;
1390
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001391 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001392 our $cnt_lines = 0;
1393 our $cnt_error = 0;
1394 our $cnt_warn = 0;
1395 our $cnt_chk = 0;
1396
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001397 # Trace the real file/line as we go.
1398 my $realfile = '';
1399 my $realline = 0;
1400 my $realcnt = 0;
1401 my $here = '';
1402 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001403 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001404 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001405 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001406
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001407 my $prev_values = 'E';
1408
1409 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001410 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001411 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001412 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001413 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001414
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001415 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001416 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001417 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001418 my @setup_docs = ();
1419 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001420
1421 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001422 my $line;
1423 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001424 $linenr++;
1425 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001426
Andy Whitcroft773647a2008-03-28 14:15:58 -07001427 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001428 $setup_docs = 0;
1429 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1430 $setup_docs = 1;
1431 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001432 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001433 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001434 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1435 $realline=$1-1;
1436 if (defined $2) {
1437 $realcnt=$3+1;
1438 } else {
1439 $realcnt=1+1;
1440 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001441 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001442
1443 # Guestimate if this is a continuing comment. Run
1444 # the context looking for a comment "edge". If this
1445 # edge is a close comment then we must be in a comment
1446 # at context start.
1447 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001448 my $cnt = $realcnt;
1449 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1450 next if (defined $rawlines[$ln - 1] &&
1451 $rawlines[$ln - 1] =~ /^-/);
1452 $cnt--;
1453 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001454 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001455 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1456 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1457 ($edge) = $1;
1458 last;
1459 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001460 }
1461 if (defined $edge && $edge eq '*/') {
1462 $in_comment = 1;
1463 }
1464
1465 # Guestimate if this is a continuing comment. If this
1466 # is the start of a diff block and this line starts
1467 # ' *' then it is very likely a comment.
1468 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001469 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001470 {
1471 $in_comment = 1;
1472 }
1473
1474 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1475 sanitise_line_reset($in_comment);
1476
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001477 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001478 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001479 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001480 $line = sanitise_line($rawline);
1481 }
1482 push(@lines, $line);
1483
1484 if ($realcnt > 1) {
1485 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1486 } else {
1487 $realcnt = 0;
1488 }
1489
1490 #print "==>$rawline\n";
1491 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001492
1493 if ($setup_docs && $line =~ /^\+/) {
1494 push(@setup_docs, $line);
1495 }
1496 }
1497
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001498 $prefix = '';
1499
Andy Whitcroft773647a2008-03-28 14:15:58 -07001500 $realcnt = 0;
1501 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001502 foreach my $line (@lines) {
1503 $linenr++;
1504
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001505 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001506
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001507#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001508 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001509 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001510 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001511 $realline=$1-1;
1512 if (defined $2) {
1513 $realcnt=$3+1;
1514 } else {
1515 $realcnt=1+1;
1516 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001517 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001518 $prev_values = 'E';
1519
Andy Whitcroft773647a2008-03-28 14:15:58 -07001520 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001521 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001522 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001523 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001524 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001525
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001526# track the line number as we move through the hunk, note that
1527# new versions of GNU diff omit the leading space on completely
1528# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001529 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001530 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001531 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001532
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001533 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001534 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001535
1536 # Track the previous line.
1537 ($prevline, $stashline) = ($stashline, $line);
1538 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001539 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1540
Andy Whitcroft773647a2008-03-28 14:15:58 -07001541 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001542
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001543 } elsif ($realcnt == 1) {
1544 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001545 }
1546
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001547 my $hunk_line = ($realcnt != 0);
1548
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001549#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001550 $prefix = "$filename:$realline: " if ($emacs && $file);
1551 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1552
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001553 $here = "#$linenr: " if (!$file);
1554 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001555
1556 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001557 if ($line =~ /^diff --git.*?(\S+)$/) {
1558 $realfile = $1;
1559 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001560 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001561 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001562 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001563 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001564 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001565
1566 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001567 if (!$file && $tree && $p1_prefix ne '' &&
1568 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001569 WARN("PATCH_PREFIX",
1570 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001571 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001572
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001573 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001574 ERROR("MODIFIED_INCLUDE_ASM",
1575 "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 -07001576 }
1577 next;
1578 }
1579
Randy Dunlap389834b2007-06-08 13:47:03 -07001580 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001581
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001582 my $hereline = "$here\n$rawline\n";
1583 my $herecurr = "$here\n$rawline\n";
1584 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001585
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001586 $cnt_lines++ if ($realcnt != 0);
1587
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001588# Check for incorrect file permissions
1589 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1590 my $permhere = $here . "FILE: $realfile\n";
1591 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001592 ERROR("EXECUTE_PERMISSIONS",
1593 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001594 }
1595 }
1596
Joe Perches20112472011-07-25 17:13:23 -07001597# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001598 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001599 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001600 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001601 }
1602
1603# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001604 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001605 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001606 my $space_before = $1;
1607 my $sign_off = $2;
1608 my $space_after = $3;
1609 my $email = $4;
1610 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1611
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001612 if ($sign_off !~ /$signature_tags/) {
1613 WARN("BAD_SIGN_OFF",
1614 "Non-standard signature: $sign_off\n" . $herecurr);
1615 }
Joe Perches20112472011-07-25 17:13:23 -07001616 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001617 WARN("BAD_SIGN_OFF",
1618 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001619 }
Joe Perches20112472011-07-25 17:13:23 -07001620 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001621 WARN("BAD_SIGN_OFF",
1622 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001623 }
1624 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001625 WARN("BAD_SIGN_OFF",
1626 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001627 }
1628
1629 my ($email_name, $email_address, $comment) = parse_email($email);
1630 my $suggested_email = format_email(($email_name, $email_address));
1631 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001632 ERROR("BAD_SIGN_OFF",
1633 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001634 } else {
1635 my $dequoted = $suggested_email;
1636 $dequoted =~ s/^"//;
1637 $dequoted =~ s/" </ </;
1638 # Don't force email to have quotes
1639 # Allow just an angle bracketed address
1640 if ("$dequoted$comment" ne $email &&
1641 "<$email_address>$comment" ne $email &&
1642 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001643 WARN("BAD_SIGN_OFF",
1644 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001645 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001646 }
1647 }
1648
Andy Whitcroft00df3442007-06-08 13:47:06 -07001649# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001650 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001651 ERROR("CORRUPTED_PATCH",
1652 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001653 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001654 }
1655
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001656# Check for absolute kernel paths.
1657 if ($tree) {
1658 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1659 my $file = $1;
1660
1661 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1662 check_absolute_file($1, $herecurr)) {
1663 #
1664 } else {
1665 check_absolute_file($file, $herecurr);
1666 }
1667 }
1668 }
1669
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001670# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1671 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001672 $rawline !~ m/^$UTF8*$/) {
1673 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1674
1675 my $blank = copy_spacing($rawline);
1676 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1677 my $hereptr = "$hereline$ptr\n";
1678
Joe Perches34d99212011-07-25 17:13:26 -07001679 CHK("INVALID_UTF8",
1680 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001681 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001682
Joe Perches15662b32011-10-31 17:13:12 -07001683# Check if it's the start of a commit log
1684# (not a header line and we haven't seen the patch filename)
1685 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001686 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001687 $in_header_lines = 0;
1688 $in_commit_log = 1;
1689 }
1690
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001691# Check if there is UTF-8 in a commit log when a mail header has explicitly
1692# declined it, i.e defined some charset where it is missing.
1693 if ($in_header_lines &&
1694 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1695 $1 !~ /utf-8/i) {
1696 $non_utf8_charset = 1;
1697 }
1698
1699 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001700 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001701 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001702 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1703 }
1704
Andy Whitcroft306708542008-10-15 22:02:28 -07001705# ignore non-hunk lines and lines being removed
1706 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001707
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001708#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001709 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001710 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001711 ERROR("DOS_LINE_ENDINGS",
1712 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001713
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001714 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1715 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001716 ERROR("TRAILING_WHITESPACE",
1717 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001718 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001719 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001720
Andi Kleen33549572010-05-24 14:33:29 -07001721# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001722# Only applies when adding the entry originally, after that we do not have
1723# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001724 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001725 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001726 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001727 my $cnt = $realcnt;
1728 my $ln = $linenr + 1;
1729 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001730 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001731 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001732 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001733 $f = $lines[$ln - 1];
1734 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1735 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001736
1737 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001738
1739 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1740 $is_start = 1;
1741 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1742 $length = -1;
1743 }
1744
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001745 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001746 $f =~ s/#.*//;
1747 $f =~ s/^\s+//;
1748 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001749 if ($f =~ /^\s*config\s/) {
1750 $is_end = 1;
1751 last;
1752 }
Andi Kleen33549572010-05-24 14:33:29 -07001753 $length++;
1754 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001755 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001756 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1757 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001758 }
1759
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001760 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1761 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1762 my $flag = $1;
1763 my $replacement = {
1764 'EXTRA_AFLAGS' => 'asflags-y',
1765 'EXTRA_CFLAGS' => 'ccflags-y',
1766 'EXTRA_CPPFLAGS' => 'cppflags-y',
1767 'EXTRA_LDFLAGS' => 'ldflags-y',
1768 };
1769
1770 WARN("DEPRECATED_VARIABLE",
1771 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1772 }
1773
Andy Whitcroft5368df22008-10-15 22:02:27 -07001774# check we are in a valid source file if not then ignore this hunk
1775 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1776
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001777#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001778 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001779 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001780 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001781 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001782 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001783 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001784 WARN("LONG_LINE",
1785 "line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001786 }
1787
Josh Triplettca56dc02012-03-23 15:02:21 -07001788# Check for user-visible strings broken across lines, which breaks the ability
1789# to grep for the string. Limited to strings used as parameters (those
1790# following an open parenthesis), which almost completely eliminates false
1791# positives, as well as warning only once per parameter rather than once per
1792# line of the string. Make an exception when the previous string ends in a
1793# newline (multiple lines in one string constant) or \n\t (common in inline
1794# assembly to indent the instruction on the following line).
1795 if ($line =~ /^\+\s*"/ &&
1796 $prevline =~ /"\s*$/ &&
1797 $prevline =~ /\(/ &&
1798 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1799 WARN("SPLIT_STRING",
1800 "quoted string split across lines\n" . $hereprev);
1801 }
1802
Joe Perches5e79d962010-03-05 13:43:55 -08001803# check for spaces before a quoted newline
1804 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001805 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1806 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001807 }
1808
Andy Whitcroft8905a672007-11-28 16:21:06 -08001809# check for adding lines without a newline.
1810 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001811 WARN("MISSING_EOF_NEWLINE",
1812 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001813 }
1814
Mike Frysinger42e41c52009-09-21 17:04:40 -07001815# Blackfin: use hi/lo macros
1816 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1817 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1818 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001819 ERROR("LO_MACRO",
1820 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001821 }
1822 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1823 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001824 ERROR("HI_MACRO",
1825 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001826 }
1827 }
1828
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001829# check we are in a valid source file C or perl if not then ignore this hunk
1830 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001831
1832# at the beginning of a line any tabs must come first and anything
1833# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001834 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1835 $rawline =~ /^\+\s* \s*/) {
1836 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001837 ERROR("CODE_INDENT",
1838 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001839 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001840 }
1841
Alberto Panizzo08e44362010-03-05 13:43:54 -08001842# check for space before tabs.
1843 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1844 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001845 WARN("SPACE_BEFORE_TAB",
1846 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001847 }
1848
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001849# check for && or || at the start of a line
1850 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1851 CHK("LOGICAL_CONTINUATIONS",
1852 "Logical continuations should be on the previous line\n" . $hereprev);
1853 }
1854
1855# check multi-line statement indentation matches previous line
1856 if ($^V && $^V ge 5.10.0 &&
1857 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1858 $prevline =~ /^\+(\t*)(.*)$/;
1859 my $oldindent = $1;
1860 my $rest = $2;
1861
1862 my $pos = pos_last_openparen($rest);
1863 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07001864 $line =~ /^(\+| )([ \t]*)/;
1865 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001866
1867 my $goodtabindent = $oldindent .
1868 "\t" x ($pos / 8) .
1869 " " x ($pos % 8);
1870 my $goodspaceindent = $oldindent . " " x $pos;
1871
1872 if ($newindent ne $goodtabindent &&
1873 $newindent ne $goodspaceindent) {
1874 CHK("PARENTHESIS_ALIGNMENT",
1875 "Alignment should match open parenthesis\n" . $hereprev);
1876 }
1877 }
1878 }
1879
Joe Perchesaad4f612012-03-23 15:02:19 -07001880 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1881 CHK("SPACING",
1882 "No space is necessary after a cast\n" . $hereprev);
1883 }
1884
Joe Perches05880602012-10-04 17:13:35 -07001885 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1886 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1887 $prevrawline =~ /^\+[ \t]*$/) {
1888 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1889 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1890 }
1891
1892 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08001893 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1894 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1895 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1896 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07001897 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1898 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1899 }
1900
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001901# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001902# Exceptions:
1903# 1) within comments
1904# 2) indented preprocessor commands
1905# 3) hanging labels
1906 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001907 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001908 WARN("LEADING_SPACE",
1909 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001910 }
1911
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001912# check we are in a valid C source file if not then ignore this hunk
1913 next if ($realfile !~ /\.(h|c)$/);
1914
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001915# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001916 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001917 WARN("CVS_KEYWORD",
1918 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001919 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001920
Mike Frysinger42e41c52009-09-21 17:04:40 -07001921# Blackfin: don't use __builtin_bfin_[cs]sync
1922 if ($line =~ /__builtin_bfin_csync/) {
1923 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001924 ERROR("CSYNC",
1925 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001926 }
1927 if ($line =~ /__builtin_bfin_ssync/) {
1928 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001929 ERROR("SSYNC",
1930 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001931 }
1932
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001933# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001934 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1935 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001936#print "LINE<$line>\n";
1937 if ($linenr >= $suppress_statement &&
1938 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001939 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001940 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001941 $stat =~ s/\n./\n /g;
1942 $cond =~ s/\n./\n /g;
1943
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001944#print "linenr<$linenr> <$stat>\n";
1945 # If this statement has no statement boundaries within
1946 # it there is no point in retrying a statement scan
1947 # until we hit end of it.
1948 my $frag = $stat; $frag =~ s/;+\s*$//;
1949 if ($frag !~ /(?:{|;)/) {
1950#print "skip<$line_nr_next>\n";
1951 $suppress_statement = $line_nr_next;
1952 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001953
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001954 # Find the real next line.
1955 $realline_next = $line_nr_next;
1956 if (defined $realline_next &&
1957 (!defined $lines[$realline_next - 1] ||
1958 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1959 $realline_next++;
1960 }
1961
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001962 my $s = $stat;
1963 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001964
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001965 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001966 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001967
1968 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001969 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001970
Andy Whitcroft463f2862009-09-21 17:04:34 -07001971 } elsif ($s =~ /^.\s*else\b/s) {
1972
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001973 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001974 } 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 -07001975 my $type = $1;
1976 $type =~ s/\s+/ /g;
1977 possible($type, "A:" . $s);
1978
Andy Whitcroft8905a672007-11-28 16:21:06 -08001979 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001980 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001981 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001982 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001983
1984 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001985 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001986 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001987 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001988
1989 # Check for any sort of function declaration.
1990 # int foo(something bar, other baz);
1991 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001992 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 -08001993 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001994
Andy Whitcroftcf655042008-03-04 14:28:20 -08001995 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001996 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001997 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001998
Andy Whitcroft8905a672007-11-28 16:21:06 -08001999 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002000 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002001
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002002 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002003 }
2004 }
2005 }
2006
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002007 }
2008
Andy Whitcroft653d4872007-06-23 17:16:34 -07002009#
2010# Checks which may be anchored in the context.
2011#
2012
2013# Check for switch () and associated case and default
2014# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002015 if ($line=~/\bswitch\s*\(.*\)/) {
2016 my $err = '';
2017 my $sep = '';
2018 my @ctx = ctx_block_outer($linenr, $realcnt);
2019 shift(@ctx);
2020 for my $ctx (@ctx) {
2021 my ($clen, $cindent) = line_stats($ctx);
2022 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2023 $indent != $cindent) {
2024 $err .= "$sep$ctx\n";
2025 $sep = '';
2026 } else {
2027 $sep = "[...]\n";
2028 }
2029 }
2030 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002031 ERROR("SWITCH_CASE_INDENT_LEVEL",
2032 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002033 }
2034 }
2035
2036# if/while/etc brace do not go on next line, unless defining a do while loop,
2037# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002038 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002039 my $pre_ctx = "$1$2";
2040
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002041 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002042
2043 if ($line =~ /^\+\t{6,}/) {
2044 WARN("DEEP_INDENTATION",
2045 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2046 }
2047
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002048 my $ctx_cnt = $realcnt - $#ctx - 1;
2049 my $ctx = join("\n", @ctx);
2050
Andy Whitcroft548596d2008-07-23 21:29:01 -07002051 my $ctx_ln = $linenr;
2052 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002053
Andy Whitcroft548596d2008-07-23 21:29:01 -07002054 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2055 defined $lines[$ctx_ln - 1] &&
2056 $lines[$ctx_ln - 1] =~ /^-/)) {
2057 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2058 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002059 $ctx_ln++;
2060 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002061
Andy Whitcroft53210162008-07-23 21:29:03 -07002062 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2063 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002064
2065 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002066 ERROR("OPEN_BRACE",
2067 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002068 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002069 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002070 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2071 $ctx =~ /\)\s*\;\s*$/ &&
2072 defined $lines[$ctx_ln - 1])
2073 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002074 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2075 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002076 WARN("TRAILING_SEMICOLON",
2077 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002078 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002079 }
2080 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002081 }
2082
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002083# Check relative indent for conditionals and blocks.
2084 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002085 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2086 ctx_statement_block($linenr, $realcnt, 0)
2087 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002088 my ($s, $c) = ($stat, $cond);
2089
2090 substr($s, 0, length($c), '');
2091
2092 # Make sure we remove the line prefixes as we have
2093 # none on the first line, and are going to readd them
2094 # where necessary.
2095 $s =~ s/\n./\n/gs;
2096
2097 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002098 my @newlines = ($c =~ /\n/gs);
2099 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002100
2101 # We want to check the first line inside the block
2102 # starting at the end of the conditional, so remove:
2103 # 1) any blank line termination
2104 # 2) any opening brace { on end of the line
2105 # 3) any do (...) {
2106 my $continuation = 0;
2107 my $check = 0;
2108 $s =~ s/^.*\bdo\b//;
2109 $s =~ s/^\s*{//;
2110 if ($s =~ s/^\s*\\//) {
2111 $continuation = 1;
2112 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002113 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002114 $check = 1;
2115 $cond_lines++;
2116 }
2117
2118 # Also ignore a loop construct at the end of a
2119 # preprocessor statement.
2120 if (($prevline =~ /^.\s*#\s*define\s/ ||
2121 $prevline =~ /\\\s*$/) && $continuation == 0) {
2122 $check = 0;
2123 }
2124
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002125 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002126 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002127 while ($cond_ptr != $cond_lines) {
2128 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002129
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002130 # If we see an #else/#elif then the code
2131 # is not linear.
2132 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2133 $check = 0;
2134 }
2135
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002136 # Ignore:
2137 # 1) blank lines, they should be at 0,
2138 # 2) preprocessor lines, and
2139 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002140 if ($continuation ||
2141 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002142 $s =~ /^\s*#\s*?/ ||
2143 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002144 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002145 if ($s =~ s/^.*?\n//) {
2146 $cond_lines++;
2147 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002148 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002149 }
2150
2151 my (undef, $sindent) = line_stats("+" . $s);
2152 my $stat_real = raw_line($linenr, $cond_lines);
2153
2154 # Check if either of these lines are modified, else
2155 # this is not this patch's fault.
2156 if (!defined($stat_real) ||
2157 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2158 $check = 0;
2159 }
2160 if (defined($stat_real) && $cond_lines > 1) {
2161 $stat_real = "[...]\n$stat_real";
2162 }
2163
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002164 #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 -07002165
2166 if ($check && (($sindent % 8) != 0 ||
2167 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002168 WARN("SUSPECT_CODE_INDENT",
2169 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002170 }
2171 }
2172
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002173 # Track the 'values' across context and added lines.
2174 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002175 my ($curr_values, $curr_vars) =
2176 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002177 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002178 if ($dbg_values) {
2179 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002180 print "$linenr > .$outline\n";
2181 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002182 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002183 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002184 $prev_values = substr($curr_values, -1);
2185
Andy Whitcroft00df3442007-06-08 13:47:06 -07002186#ignore lines not being added
2187 if ($line=~/^[^\+]/) {next;}
2188
Andy Whitcroft653d4872007-06-23 17:16:34 -07002189# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002190 if ($dbg_type) {
2191 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002192 ERROR("TEST_TYPE",
2193 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002194 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002195 ERROR("TEST_NOT_TYPE",
2196 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002197 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002198 next;
2199 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002200# TEST: allow direct testing of the attribute matcher.
2201 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002202 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002203 ERROR("TEST_ATTR",
2204 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002205 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002206 ERROR("TEST_NOT_ATTR",
2207 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002208 }
2209 next;
2210 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002211
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002212# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002213 if ($line =~ /^.\s*{/ &&
2214 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002215 ERROR("OPEN_BRACE",
2216 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002217 }
2218
Andy Whitcroft653d4872007-06-23 17:16:34 -07002219#
2220# Checks which are anchored on the added line.
2221#
2222
2223# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002224 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002225 my $path = $1;
2226 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002227 ERROR("MALFORMED_INCLUDE",
2228 "malformed #include filename\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002229 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002230 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002231 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002232
2233# no C99 // comments
2234 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002235 ERROR("C99_COMMENTS",
2236 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002237 }
2238 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002239 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002240 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002241
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002242# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2243# the whole statement.
2244#print "APW <$lines[$realline_next - 1]>\n";
2245 if (defined $realline_next &&
2246 exists $lines[$realline_next - 1] &&
2247 !defined $suppress_export{$realline_next} &&
2248 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2249 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002250 # Handle definitions which produce identifiers with
2251 # a prefix:
2252 # XXX(foo);
2253 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002254 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002255 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002256 $name =~ /^${Ident}_$2/) {
2257#print "FOO C name<$name>\n";
2258 $suppress_export{$realline_next} = 1;
2259
2260 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002261 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002262 ^.DEFINE_$Ident\(\Q$name\E\)|
2263 ^.DECLARE_$Ident\(\Q$name\E\)|
2264 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002265 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2266 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002267 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002268#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2269 $suppress_export{$realline_next} = 2;
2270 } else {
2271 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002272 }
2273 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002274 if (!defined $suppress_export{$linenr} &&
2275 $prevline =~ /^.\s*$/ &&
2276 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2277 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2278#print "FOO B <$lines[$linenr - 1]>\n";
2279 $suppress_export{$linenr} = 2;
2280 }
2281 if (defined $suppress_export{$linenr} &&
2282 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002283 WARN("EXPORT_SYMBOL",
2284 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002285 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002286
Joe Eloff5150bda2010-08-09 17:21:00 -07002287# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002288 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002289 ERROR("GLOBAL_INITIALISERS",
2290 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002291 $herecurr);
2292 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002293# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002294 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002295 ERROR("INITIALISED_STATIC",
2296 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002297 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002298 }
2299
Joe Perchescb710ec2010-10-26 14:23:20 -07002300# check for static const char * arrays.
2301 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002302 WARN("STATIC_CONST_CHAR_ARRAY",
2303 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002304 $herecurr);
2305 }
2306
2307# check for static char foo[] = "bar" declarations.
2308 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002309 WARN("STATIC_CONST_CHAR_ARRAY",
2310 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002311 $herecurr);
2312 }
2313
Joe Perches93ed0e22010-10-26 14:23:21 -07002314# check for declarations of struct pci_device_id
2315 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002316 WARN("DEFINE_PCI_DEVICE_TABLE",
2317 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002318 }
2319
Andy Whitcroft653d4872007-06-23 17:16:34 -07002320# check for new typedefs, only function parameters and sparse annotations
2321# make sense.
2322 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002323 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002324 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002325 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002326 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002327 WARN("NEW_TYPEDEFS",
2328 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002329 }
2330
2331# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002332 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002333 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2334 #print "AA<$1>\n";
2335 my ($from, $to) = ($2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002336
Andy Whitcroft65863862009-01-06 14:41:21 -08002337 # Should start with a space.
2338 $to =~ s/^(\S)/ $1/;
2339 # Should not end with a space.
2340 $to =~ s/\s+$//;
2341 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002342 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002343 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002344
Andy Whitcroft65863862009-01-06 14:41:21 -08002345 #print "from<$from> to<$to>\n";
2346 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002347 ERROR("POINTER_LOCATION",
2348 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002349 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002350 }
2351 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2352 #print "BB<$1>\n";
2353 my ($from, $to, $ident) = ($2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002354
Andy Whitcroft65863862009-01-06 14:41:21 -08002355 # Should start with a space.
2356 $to =~ s/^(\S)/ $1/;
2357 # Should not end with a space.
2358 $to =~ s/\s+$//;
2359 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002360 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002361 }
2362 # Modifiers should have spaces.
2363 $to =~ s/(\b$Modifier$)/$1 /;
2364
Andy Whitcroft667026e2009-02-27 14:03:08 -08002365 #print "from<$from> to<$to> ident<$ident>\n";
2366 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002367 ERROR("POINTER_LOCATION",
2368 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002369 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002370 }
2371
2372# # no BUG() or BUG_ON()
2373# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2374# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2375# print "$herecurr";
2376# $clean = 0;
2377# }
2378
Andy Whitcroft8905a672007-11-28 16:21:06 -08002379 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002380 WARN("LINUX_VERSION_CODE",
2381 "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 -08002382 }
2383
Joe Perches17441222011-06-15 15:08:17 -07002384# check for uses of printk_ratelimit
2385 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002386 WARN("PRINTK_RATELIMITED",
2387"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002388 }
2389
Andy Whitcroft00df3442007-06-08 13:47:06 -07002390# printk should use KERN_* levels. Note that follow on printk's on the
2391# same line do not need a level, so we use the current block context
2392# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002393# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002394# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002395 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002396 my $ok = 0;
2397 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2398 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002399 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002400 # with "\n" ignore it, else it is to blame
2401 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2402 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2403 $ok = 1;
2404 }
2405 last;
2406 }
2407 }
2408 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002409 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2410 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002411 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002412 }
2413
Joe Perches243f3802012-05-31 16:26:09 -07002414 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2415 my $orig = $1;
2416 my $level = lc($orig);
2417 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002418 my $level2 = $level;
2419 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002420 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002421 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002422 }
2423
2424 if ($line =~ /\bpr_warning\s*\(/) {
2425 WARN("PREFER_PR_LEVEL",
2426 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2427 }
2428
Andy Whitcroft653d4872007-06-23 17:16:34 -07002429# function brace can't be on same line, except for #defines of do while,
2430# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002431 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2432 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002433 ERROR("OPEN_BRACE",
2434 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002435 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002436
Andy Whitcroft8905a672007-11-28 16:21:06 -08002437# open braces for enum, union and struct go on the same line.
2438 if ($line =~ /^.\s*{/ &&
2439 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002440 ERROR("OPEN_BRACE",
2441 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002442 }
2443
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002444# missing space after union, struct or enum definition
2445 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002446 WARN("SPACING",
2447 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002448 }
2449
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002450# check for spacing round square brackets; allowed:
2451# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002452# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2453# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002454 while ($line =~ /(.*?\s)\[/g) {
2455 my ($where, $prefix) = ($-[1], $1);
2456 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002457 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002458 $prefix !~ /[{,]\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002459 ERROR("BRACKET_SPACE",
2460 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002461 }
2462 }
2463
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002464# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002465 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002466 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002467 my $ctx_before = substr($line, 0, $-[1]);
2468 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002469
2470 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002471 if ($name =~ /^(?:
2472 if|for|while|switch|return|case|
2473 volatile|__volatile__|
2474 __attribute__|format|__extension__|
2475 asm|__asm__)$/x)
2476 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002477
2478 # cpp #define statements have non-optional spaces, ie
2479 # if there is a space between the name and the open
2480 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002481 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002482
2483 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002484 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002485
2486 # If this whole things ends with a type its most
2487 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002488 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002489
2490 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002491 WARN("SPACING",
2492 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002493 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002494 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002495
2496# check for whitespace before a non-naked semicolon
2497 if ($line =~ /^\+.*\S\s+;/) {
2498 CHK("SPACING",
2499 "space prohibited before semicolon\n" . $herecurr);
2500 }
2501
Andy Whitcroft653d4872007-06-23 17:16:34 -07002502# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002503 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002504 my $ops = qr{
2505 <<=|>>=|<=|>=|==|!=|
2506 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2507 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002508 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2509 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002510 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002511 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002512 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002513
2514 my $blank = copy_spacing($opline);
2515
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002516 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002517 $off += length($elements[$n]);
2518
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002519 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002520 my $ca = substr($opline, 0, $off);
2521 my $cc = '';
2522 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2523 $cc = substr($opline, $off + length($elements[$n + 1]));
2524 }
2525 my $cb = "$ca$;$cc";
2526
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002527 my $a = '';
2528 $a = 'V' if ($elements[$n] ne '');
2529 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002530 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002531 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2532 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002533 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002534
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002535 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002536
2537 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002538 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002539 $c = 'V' if ($elements[$n + 2] ne '');
2540 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002541 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002542 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2543 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002544 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002545 } else {
2546 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002547 }
2548
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002549 my $ctx = "${a}x${c}";
2550
2551 my $at = "(ctx:$ctx)";
2552
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002553 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002554 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002555
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002556 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002557 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002558
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002559 # Get the full operator variant.
2560 my $opv = $op . substr($curr_vars, $off, 1);
2561
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002562 # Ignore operators passed as parameters.
2563 if ($op_type ne 'V' &&
2564 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2565
Andy Whitcroftcf655042008-03-04 14:28:20 -08002566# # Ignore comments
2567# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002568
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002569 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002570 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002571 if ($ctx !~ /.x[WEBC]/ &&
2572 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002573 ERROR("SPACING",
2574 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002575 }
2576
2577 # // is a comment
2578 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002579
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002580 # No spaces for:
2581 # ->
2582 # : when part of a bitfield
2583 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002584 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002585 ERROR("SPACING",
2586 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002587 }
2588
2589 # , must have a space on the right.
2590 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002591 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002592 ERROR("SPACING",
2593 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002594 }
2595
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002596 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002597 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002598 #warn "'*' is part of type\n";
2599
2600 # unary operators should have a space before and
2601 # none after. May be left adjacent to another
2602 # unary operator, or a cast
2603 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002604 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002605 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002606 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002607 ERROR("SPACING",
2608 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002609 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002610 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002611 # A unary '*' may be const
2612
2613 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002614 ERROR("SPACING",
2615 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002616 }
2617
2618 # unary ++ and unary -- are allowed no space on one side.
2619 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002620 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002621 ERROR("SPACING",
2622 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002623 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002624 if ($ctx =~ /Wx[BE]/ ||
2625 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002626 ERROR("SPACING",
2627 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002628 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002629 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002630 ERROR("SPACING",
2631 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002632 }
2633
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002634
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002635 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002636 } elsif ($op eq '<<' or $op eq '>>' or
2637 $op eq '&' or $op eq '^' or $op eq '|' or
2638 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002639 $op eq '*' or $op eq '/' or
2640 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002641 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002642 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002643 ERROR("SPACING",
2644 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002645 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002646 }
2647
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002648 # A colon needs no spaces before when it is
2649 # terminating a case value or a label.
2650 } elsif ($opv eq ':C' || $opv eq ':L') {
2651 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002652 ERROR("SPACING",
2653 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002654 }
2655
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002656 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002657 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002658 my $ok = 0;
2659
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002660 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002661 if (($op eq '<' &&
2662 $cc =~ /^\S+\@\S+>/) ||
2663 ($op eq '>' &&
2664 $ca =~ /<\S+\@\S+$/))
2665 {
2666 $ok = 1;
2667 }
2668
2669 # Ignore ?:
2670 if (($opv eq ':O' && $ca =~ /\?$/) ||
2671 ($op eq '?' && $cc =~ /^:/)) {
2672 $ok = 1;
2673 }
2674
2675 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002676 ERROR("SPACING",
2677 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002678 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002679 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002680 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002681 }
2682 }
2683
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002684# check for multiple assignments
2685 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002686 CHK("MULTIPLE_ASSIGNMENTS",
2687 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002688 }
2689
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002690## # check for multiple declarations, allowing for a function declaration
2691## # continuation.
2692## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2693## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2694##
2695## # Remove any bracketed sections to ensure we do not
2696## # falsly report the parameters of functions.
2697## my $ln = $line;
2698## while ($ln =~ s/\([^\(\)]*\)//g) {
2699## }
2700## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002701## WARN("MULTIPLE_DECLARATION",
2702## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002703## }
2704## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002705
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002706#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002707 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2708 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002709 ERROR("SPACING",
2710 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002711 }
2712
2713# closing brace should have a space following it when it has anything
2714# on the line
2715 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002716 ERROR("SPACING",
2717 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002718 }
2719
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002720# check spacing on square brackets
2721 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002722 ERROR("SPACING",
2723 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002724 }
2725 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002726 ERROR("SPACING",
2727 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002728 }
2729
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002730# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002731 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2732 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002733 ERROR("SPACING",
2734 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002735 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002736 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002737 $line !~ /for\s*\(.*;\s+\)/ &&
2738 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002739 ERROR("SPACING",
2740 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002741 }
2742
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002743#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002744 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002745 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002746 WARN("INDENTED_LABEL",
2747 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002748 }
2749
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002750# Return is not a function.
2751 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2752 my $spacing = $1;
2753 my $value = $2;
2754
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002755 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002756 $value =~ s/\(/ \(/g;
2757 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08002758 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002759 $value !~ /(?:$Ident|-?$Constant)\s*
2760 $Compare\s*
2761 (?:$Ident|-?$Constant)/x &&
2762 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002763 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002764#print "value<$value>\n";
2765 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002766 ERROR("RETURN_PARENTHESES",
2767 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002768
2769 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002770 ERROR("SPACING",
2771 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002772 }
2773 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002774# Return of what appears to be an errno should normally be -'ve
2775 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2776 my $name = $1;
2777 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002778 WARN("USE_NEGATIVE_ERRNO",
2779 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002780 }
2781 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002782
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002783# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002784 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002785 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002786 }
2787
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002788# Check for illegal assignment in if conditional -- and check for trailing
2789# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002790 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002791 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2792 ctx_statement_block($linenr, $realcnt, 0)
2793 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002794 my ($stat_next) = ctx_statement_block($line_nr_next,
2795 $remain_next, $off_next);
2796 $stat_next =~ s/\n./\n /g;
2797 ##print "stat<$stat> stat_next<$stat_next>\n";
2798
2799 if ($stat_next =~ /^\s*while\b/) {
2800 # If the statement carries leading newlines,
2801 # then count those as offsets.
2802 my ($whitespace) =
2803 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2804 my $offset =
2805 statement_rawlines($whitespace) - 1;
2806
2807 $suppress_whiletrailers{$line_nr_next +
2808 $offset} = 1;
2809 }
2810 }
2811 if (!defined $suppress_whiletrailers{$linenr} &&
2812 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002813 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002814
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002815 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002816 ERROR("ASSIGN_IN_IF",
2817 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002818 }
2819
2820 # Find out what is on the end of the line after the
2821 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002822 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002823 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002824 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002825 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2826 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002827 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002828 # Find out how long the conditional actually is.
2829 my @newlines = ($c =~ /\n/gs);
2830 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002831 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002832
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002833 $stat_real = raw_line($linenr, $cond_lines)
2834 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002835 if (defined($stat_real) && $cond_lines > 1) {
2836 $stat_real = "[...]\n$stat_real";
2837 }
2838
Joe Perches000d1cc12011-07-25 17:13:25 -07002839 ERROR("TRAILING_STATEMENTS",
2840 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002841 }
2842 }
2843
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002844# Check for bitwise tests written as boolean
2845 if ($line =~ /
2846 (?:
2847 (?:\[|\(|\&\&|\|\|)
2848 \s*0[xX][0-9]+\s*
2849 (?:\&\&|\|\|)
2850 |
2851 (?:\&\&|\|\|)
2852 \s*0[xX][0-9]+\s*
2853 (?:\&\&|\|\||\)|\])
2854 )/x)
2855 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002856 WARN("HEXADECIMAL_BOOLEAN_TEST",
2857 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002858 }
2859
Andy Whitcroft8905a672007-11-28 16:21:06 -08002860# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002861 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2862 my $s = $1;
2863 $s =~ s/$;//g; # Remove any comments
2864 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002865 ERROR("TRAILING_STATEMENTS",
2866 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002867 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002868 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002869# if should not continue a brace
2870 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002871 ERROR("TRAILING_STATEMENTS",
2872 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002873 $herecurr);
2874 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002875# case and default should not have general statements after them
2876 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2877 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002878 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002879 \s*return\s+
2880 )/xg)
2881 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002882 ERROR("TRAILING_STATEMENTS",
2883 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002884 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002885
2886 # Check for }<nl>else {, these must be at the same
2887 # indent level to be relevant to each other.
2888 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2889 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002890 ERROR("ELSE_AFTER_BRACE",
2891 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002892 }
2893
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002894 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2895 $previndent == $indent) {
2896 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2897
2898 # Find out what is on the end of the line after the
2899 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002900 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002901 $s =~ s/\n.*//g;
2902
2903 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002904 ERROR("WHILE_AFTER_BRACE",
2905 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002906 }
2907 }
2908
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002909#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2910# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2911# print "No studly caps, use _\n";
2912# print "$herecurr";
2913# $clean = 0;
2914# }
2915
2916#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002917 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002918 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2919 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002920 }
2921
Andy Whitcroft653d4872007-06-23 17:16:34 -07002922#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002923 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002924 my $file = "$1.h";
2925 my $checkfile = "include/linux/$file";
2926 if (-f "$root/$checkfile" &&
2927 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002928 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002929 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002930 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002931 CHK("ARCH_INCLUDE_LINUX",
2932 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002933 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002934 WARN("INCLUDE_LINUX",
2935 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002936 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002937 }
2938 }
2939
Andy Whitcroft653d4872007-06-23 17:16:34 -07002940# multi-statement macros should be enclosed in a do while loop, grab the
2941# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002942# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002943 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2944 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002945 my $ln = $linenr;
2946 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002947 my ($off, $dstat, $dcond, $rest);
2948 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002949 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002950 ctx_statement_block($linenr, $realcnt, 0);
2951 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002952 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002953 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002954
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002955 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002956 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002957 $dstat =~ s/\\\n.//g;
2958 $dstat =~ s/^\s*//s;
2959 $dstat =~ s/\s*$//s;
2960
2961 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002962 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2963 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08002964 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002965 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002966 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002967
Andy Whitcrofte45bab82012-03-23 15:02:18 -07002968 # Flatten any obvious string concatentation.
2969 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
2970 $dstat =~ s/$Ident\s*("X*")/$1/)
2971 {
2972 }
2973
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002974 my $exceptions = qr{
2975 $Declare|
2976 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07002977 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002978 DECLARE_PER_CPU|
2979 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002980 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002981 union|
2982 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002983 \.$Ident\s*=\s*|
2984 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002985 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07002986 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002987 if ($dstat ne '' &&
2988 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2989 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Andy Whitcroftfd1b57a2012-03-23 15:02:18 -07002990 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07002991 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002992 $dstat !~ /$exceptions/ &&
2993 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Andy Whitcroft72f115f2012-01-10 15:10:06 -08002994 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002995 $dstat !~ /^for\s*$Constant$/ && # for (...)
2996 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2997 $dstat !~ /^do\s*{/ && # do {...
2998 $dstat !~ /^\({/) # ({...
2999 {
3000 $ctx =~ s/\n*$//;
3001 my $herectx = $here . "\n";
3002 my $cnt = statement_rawlines($ctx);
3003
3004 for (my $n = 0; $n < $cnt; $n++) {
3005 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003006 }
3007
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003008 if ($dstat =~ /;/) {
3009 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3010 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3011 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003012 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003013 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003014 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003015 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003016 }
3017
Joe Perchesb13edf72012-07-30 14:41:24 -07003018# do {} while (0) macro tests:
3019# single-statement macros do not need to be enclosed in do while (0) loop,
3020# macro should not end with a semicolon
3021 if ($^V && $^V ge 5.10.0 &&
3022 $realfile !~ m@/vmlinux.lds.h$@ &&
3023 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3024 my $ln = $linenr;
3025 my $cnt = $realcnt;
3026 my ($off, $dstat, $dcond, $rest);
3027 my $ctx = '';
3028 ($dstat, $dcond, $ln, $cnt, $off) =
3029 ctx_statement_block($linenr, $realcnt, 0);
3030 $ctx = $dstat;
3031
3032 $dstat =~ s/\\\n.//g;
3033
3034 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3035 my $stmts = $2;
3036 my $semis = $3;
3037
3038 $ctx =~ s/\n*$//;
3039 my $cnt = statement_rawlines($ctx);
3040 my $herectx = $here . "\n";
3041
3042 for (my $n = 0; $n < $cnt; $n++) {
3043 $herectx .= raw_line($linenr, $n) . "\n";
3044 }
3045
Joe Perchesac8e97f2012-08-21 16:15:53 -07003046 if (($stmts =~ tr/;/;/) == 1 &&
3047 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003048 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3049 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3050 }
3051 if (defined $semis && $semis ne "") {
3052 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3053 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3054 }
3055 }
3056 }
3057
Mike Frysinger080ba922009-01-06 14:41:25 -08003058# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3059# all assignments may have only one of the following with an assignment:
3060# .
3061# ALIGN(...)
3062# VMLINUX_SYMBOL(...)
3063 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003064 WARN("MISSING_VMLINUX_SYMBOL",
3065 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003066 }
3067
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003068# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003069 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3070 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003071 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003072 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003073 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3074 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003075 my @allowed = ();
3076 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003077 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003078 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003079 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003080 for my $chunk (@chunks) {
3081 my ($cond, $block) = @{$chunk};
3082
Andy Whitcroft773647a2008-03-28 14:15:58 -07003083 # If the condition carries leading newlines, then count those as offsets.
3084 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3085 my $offset = statement_rawlines($whitespace) - 1;
3086
Joe Perchesaad4f612012-03-23 15:02:19 -07003087 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003088 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3089
3090 # We have looked at and allowed this specific line.
3091 $suppress_ifbraces{$ln + $offset} = 1;
3092
3093 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003094 $ln += statement_rawlines($block) - 1;
3095
Andy Whitcroft773647a2008-03-28 14:15:58 -07003096 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003097
3098 $seen++ if ($block =~ /^\s*{/);
3099
Joe Perchesaad4f612012-03-23 15:02:19 -07003100 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003101 if (statement_lines($cond) > 1) {
3102 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003103 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003104 }
3105 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003106 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003107 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003108 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003109 if (statement_block_size($block) > 1) {
3110 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003111 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003112 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003113 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003114 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003115 if ($seen) {
3116 my $sum_allowed = 0;
3117 foreach (@allowed) {
3118 $sum_allowed += $_;
3119 }
3120 if ($sum_allowed == 0) {
3121 WARN("BRACES",
3122 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3123 } elsif ($sum_allowed != $allow &&
3124 $seen != $allow) {
3125 CHK("BRACES",
3126 "braces {} should be used on all arms of this statement\n" . $herectx);
3127 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003128 }
3129 }
3130 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003131 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003132 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003133 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003134
Andy Whitcroftcf655042008-03-04 14:28:20 -08003135 # Check the pre-context.
3136 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3137 #print "APW: ALLOWED: pre<$1>\n";
3138 $allowed = 1;
3139 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003140
3141 my ($level, $endln, @chunks) =
3142 ctx_statement_full($linenr, $realcnt, $-[0]);
3143
Andy Whitcroftcf655042008-03-04 14:28:20 -08003144 # Check the condition.
3145 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003146 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003147 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003148 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003149 }
3150 if (statement_lines($cond) > 1) {
3151 #print "APW: ALLOWED: cond<$cond>\n";
3152 $allowed = 1;
3153 }
3154 if ($block =~/\b(?:if|for|while)\b/) {
3155 #print "APW: ALLOWED: block<$block>\n";
3156 $allowed = 1;
3157 }
3158 if (statement_block_size($block) > 1) {
3159 #print "APW: ALLOWED: lines block<$block>\n";
3160 $allowed = 1;
3161 }
3162 # Check the post-context.
3163 if (defined $chunks[1]) {
3164 my ($cond, $block) = @{$chunks[1]};
3165 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003166 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003167 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003168 if ($block =~ /^\s*\{/) {
3169 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3170 $allowed = 1;
3171 }
3172 }
3173 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003174 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003175 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003176
Andy Whitcroftf0556632008-10-15 22:02:23 -07003177 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003178 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003179 }
3180
Joe Perches000d1cc12011-07-25 17:13:25 -07003181 WARN("BRACES",
3182 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003183 }
3184 }
3185
Andy Whitcroft653d4872007-06-23 17:16:34 -07003186# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003187 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003188 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003189 ERROR("DEPRECATED_INCLUDE",
3190 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003191 }
3192 }
3193
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003194# don't use deprecated functions
3195 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003196 if ($line =~ /\b$func\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003197 ERROR("DEPRECATED_FUNCTION",
3198 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003199 }
3200 }
3201
3202# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003203 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3204 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003205 WARN("VOLATILE",
3206 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003207 }
3208
Andy Whitcroft00df3442007-06-08 13:47:06 -07003209# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003210 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003211 CHK("REDUNDANT_CODE",
3212 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003213 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003214 }
3215
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003216# check for needless kfree() checks
3217 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3218 my $expr = $1;
3219 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003220 WARN("NEEDLESS_KFREE",
3221 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003222 }
3223 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003224# check for needless usb_free_urb() checks
3225 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3226 my $expr = $1;
3227 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003228 WARN("NEEDLESS_USB_FREE_URB",
3229 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003230 }
3231 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003232
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003233# prefer usleep_range over udelay
3234 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3235 # ignore udelay's < 10, however
3236 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003237 CHK("USLEEP_RANGE",
3238 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003239 }
3240 }
3241
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003242# warn about unexpectedly long msleep's
3243 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3244 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003245 WARN("MSLEEP",
3246 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003247 }
3248 }
3249
Andy Whitcroft00df3442007-06-08 13:47:06 -07003250# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003251# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003252# print "#ifdef in C files should be avoided\n";
3253# print "$herecurr";
3254# $clean = 0;
3255# }
3256
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003257# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003258 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003259 ERROR("SPACING",
3260 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003261 }
3262
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003263# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003264 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3265 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003266 my $which = $1;
3267 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003268 CHK("UNCOMMENTED_DEFINITION",
3269 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003270 }
3271 }
3272# check for memory barriers without a comment.
3273 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3274 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003275 CHK("MEMORY_BARRIER",
3276 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003277 }
3278 }
3279# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003280 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003281 CHK("ARCH_DEFINES",
3282 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003283 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003284
Tobias Klauserd4977c72010-05-24 14:33:30 -07003285# Check that the storage class is at the beginning of a declaration
3286 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003287 WARN("STORAGE_CLASS",
3288 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003289 }
3290
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003291# check the location of the inline attribute, that it is between
3292# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003293 if ($line =~ /\b$Type\s+$Inline\b/ ||
3294 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003295 ERROR("INLINE_LOCATION",
3296 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003297 }
3298
Andy Whitcroft8905a672007-11-28 16:21:06 -08003299# Check for __inline__ and __inline, prefer inline
3300 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003301 WARN("INLINE",
3302 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003303 }
3304
Joe Perches3d130fd2011-01-12 17:00:00 -08003305# Check for __attribute__ packed, prefer __packed
3306 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003307 WARN("PREFER_PACKED",
3308 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003309 }
3310
Joe Perches39b7e282011-07-25 17:13:24 -07003311# Check for __attribute__ aligned, prefer __aligned
3312 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003313 WARN("PREFER_ALIGNED",
3314 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003315 }
3316
Joe Perches5f14d3b2012-01-10 15:09:52 -08003317# Check for __attribute__ format(printf, prefer __printf
3318 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3319 WARN("PREFER_PRINTF",
3320 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3321 }
3322
Joe Perches6061d942012-03-23 15:02:16 -07003323# Check for __attribute__ format(scanf, prefer __scanf
3324 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3325 WARN("PREFER_SCANF",
3326 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3327 }
3328
Joe Perches8f53a9b2010-03-05 13:43:48 -08003329# check for sizeof(&)
3330 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003331 WARN("SIZEOF_ADDRESS",
3332 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003333 }
3334
Joe Perches66c80b62012-07-30 14:41:22 -07003335# check for sizeof without parenthesis
3336 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3337 WARN("SIZEOF_PARENTHESIS",
3338 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3339 }
3340
Joe Perches428e2fd2011-05-24 17:13:39 -07003341# check for line continuations in quoted strings with odd counts of "
3342 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003343 WARN("LINE_CONTINUATIONS",
3344 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003345 }
3346
Andy Whitcroft554e1652012-01-10 15:09:57 -08003347# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003348 if ($^V && $^V ge 5.10.0 &&
3349 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003350 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003351
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003352 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003353 my $ms_val = $7;
3354 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003355
Andy Whitcroft554e1652012-01-10 15:09:57 -08003356 if ($ms_size =~ /^(0x|)0$/i) {
3357 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003358 "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 -08003359 } elsif ($ms_size =~ /^(0x|)1$/i) {
3360 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003361 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3362 }
3363 }
3364
3365# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003366 if ($^V && $^V ge 5.10.0 &&
3367 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003368 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003369 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003370 my $call = $1;
3371 my $cast1 = deparenthesize($2);
3372 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003373 my $cast2 = deparenthesize($7);
3374 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003375 my $cast;
3376
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003377 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003378 $cast = "$cast1 or $cast2";
3379 } elsif ($cast1 ne "") {
3380 $cast = $cast1;
3381 } else {
3382 $cast = $cast2;
3383 }
3384 WARN("MINMAX",
3385 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003386 }
3387 }
3388
Joe Perches4a273192012-07-30 14:41:20 -07003389# check usleep_range arguments
3390 if ($^V && $^V ge 5.10.0 &&
3391 defined $stat &&
3392 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3393 my $min = $1;
3394 my $max = $7;
3395 if ($min eq $max) {
3396 WARN("USLEEP_RANGE",
3397 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3398 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3399 $min > $max) {
3400 WARN("USLEEP_RANGE",
3401 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3402 }
3403 }
3404
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003405# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003406 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003407 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003408 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003409 my $function_name = $1;
3410 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003411
3412 my $s = $stat;
3413 if (defined $cond) {
3414 substr($s, 0, length($cond), '');
3415 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003416 if ($s =~ /^\s*;/ &&
3417 $function_name ne 'uninitialized_var')
3418 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003419 WARN("AVOID_EXTERNS",
3420 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003421 }
3422
3423 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003424 WARN("FUNCTION_ARGUMENTS",
3425 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003426 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003427
3428 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3429 $stat =~ /^.\s*extern\s+/)
3430 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003431 WARN("AVOID_EXTERNS",
3432 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003433 }
3434
3435# checks for new __setup's
3436 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3437 my $name = $1;
3438
3439 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003440 CHK("UNDOCUMENTED_SETUP",
3441 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003442 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003443 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003444
3445# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003446 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003447 WARN("UNNECESSARY_CASTS",
3448 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003449 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003450
Joe Perchescaf2a542011-01-12 16:59:56 -08003451# check for multiple semicolons
3452 if ($line =~ /;\s*;\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003453 WARN("ONE_SEMICOLON",
3454 "Statements terminations use 1 semicolon\n" . $herecurr);
Joe Perchescaf2a542011-01-12 16:59:56 -08003455 }
3456
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003457# check for gcc specific __FUNCTION__
3458 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003459 WARN("USE_FUNC",
3460 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003461 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003462
Joe Perches2c924882012-03-23 15:02:20 -07003463# check for use of yield()
3464 if ($line =~ /\byield\s*\(\s*\)/) {
3465 WARN("YIELD",
3466 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3467 }
3468
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003469# check for semaphores initialized locked
3470 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003471 WARN("CONSIDER_COMPLETION",
3472 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003473 }
Joe Perches6712d852012-03-23 15:02:20 -07003474
Joe Perches67d0a072011-10-31 17:13:10 -07003475# recommend kstrto* over simple_strto* and strict_strto*
3476 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003477 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003478 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003479 }
Joe Perches6712d852012-03-23 15:02:20 -07003480
Michael Ellermanf3db6632008-07-23 21:28:57 -07003481# check for __initcall(), use device_initcall() explicitly please
3482 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003483 WARN("USE_DEVICE_INITCALL",
3484 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003485 }
Joe Perches6712d852012-03-23 15:02:20 -07003486
Emese Revfy79404842010-03-05 13:43:53 -08003487# check for various ops structs, ensure they are const.
3488 my $struct_ops = qr{acpi_dock_ops|
3489 address_space_operations|
3490 backlight_ops|
3491 block_device_operations|
3492 dentry_operations|
3493 dev_pm_ops|
3494 dma_map_ops|
3495 extent_io_ops|
3496 file_lock_operations|
3497 file_operations|
3498 hv_ops|
3499 ide_dma_ops|
3500 intel_dvo_dev_ops|
3501 item_operations|
3502 iwl_ops|
3503 kgdb_arch|
3504 kgdb_io|
3505 kset_uevent_ops|
3506 lock_manager_operations|
3507 microcode_ops|
3508 mtrr_ops|
3509 neigh_ops|
3510 nlmsvc_binding|
3511 pci_raw_ops|
3512 pipe_buf_operations|
3513 platform_hibernation_ops|
3514 platform_suspend_ops|
3515 proto_ops|
3516 rpc_pipe_ops|
3517 seq_operations|
3518 snd_ac97_build_ops|
3519 soc_pcmcia_socket_ops|
3520 stacktrace_ops|
3521 sysfs_ops|
3522 tty_operations|
3523 usb_mon_operations|
3524 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003525 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003526 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003527 WARN("CONST_STRUCT",
3528 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003529 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003530 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003531
3532# use of NR_CPUS is usually wrong
3533# ignore definitions of NR_CPUS and usage to define arrays as likely right
3534 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003535 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3536 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003537 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3538 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3539 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003540 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003541 WARN("NR_CPUS",
3542 "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 -07003543 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003544
3545# check for %L{u,d,i} in strings
3546 my $string;
3547 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3548 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003549 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003550 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003551 WARN("PRINTF_L",
3552 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003553 last;
3554 }
3555 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003556
3557# whine mightly about in_atomic
3558 if ($line =~ /\bin_atomic\s*\(/) {
3559 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003560 ERROR("IN_ATOMIC",
3561 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003562 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003563 WARN("IN_ATOMIC",
3564 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003565 }
3566 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003567
3568# check for lockdep_set_novalidate_class
3569 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3570 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3571 if ($realfile !~ m@^kernel/lockdep@ &&
3572 $realfile !~ m@^include/linux/lockdep@ &&
3573 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003574 ERROR("LOCKDEP",
3575 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003576 }
3577 }
Dave Jones88f88312011-01-12 16:59:59 -08003578
3579 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3580 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003581 WARN("EXPORTED_WORLD_WRITABLE",
3582 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003583 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003584 }
3585
3586 # If we have no input at all, then there is nothing to report on
3587 # so just keep quiet.
3588 if ($#rawlines == -1) {
3589 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003590 }
3591
Andy Whitcroft8905a672007-11-28 16:21:06 -08003592 # In mailback mode only produce a report in the negative, for
3593 # things that appear to be patches.
3594 if ($mailback && ($clean == 1 || !$is_patch)) {
3595 exit(0);
3596 }
3597
3598 # This is not a patch, and we are are in 'no-patch' mode so
3599 # just keep quiet.
3600 if (!$chk_patch && !$is_patch) {
3601 exit(0);
3602 }
3603
3604 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003605 ERROR("NOT_UNIFIED_DIFF",
3606 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003607 }
3608 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003609 ERROR("MISSING_SIGN_OFF",
3610 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003611 }
3612
Andy Whitcroft8905a672007-11-28 16:21:06 -08003613 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003614 if ($summary && !($clean == 1 && $quiet == 1)) {
3615 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003616 print "total: $cnt_error errors, $cnt_warn warnings, " .
3617 (($check)? "$cnt_chk checks, " : "") .
3618 "$cnt_lines lines checked\n";
3619 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003620 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003621
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003622 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003623
3624 if ($^V lt 5.10.0) {
3625 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3626 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3627 }
3628
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003629 # If there were whitespace errors which cleanpatch can fix
3630 # then suggest that.
3631 if ($rpt_cleaners) {
3632 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3633 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003634 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003635 }
3636 }
3637
Artem Bityutskiy11232682012-03-23 15:02:17 -07003638 if ($quiet == 0 && keys %ignore_type) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003639 print "NOTE: Ignored message types:";
3640 foreach my $ignore (sort keys %ignore_type) {
3641 print " $ignore";
3642 }
Artem Bityutskiy11232682012-03-23 15:02:17 -07003643 print "\n\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003644 }
3645
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003646 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003647 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003648 }
3649 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003650 print << "EOM";
3651$vname has style problems, please review.
3652
3653If any of these errors are false positives, please report
3654them to the maintainer, see CHECKPATCH in MAINTAINERS.
3655EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003656 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003657
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003658 return $clean;
3659}