blob: 9d761c95eca2988e0ff227baa8619b684d6eb33a [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070012
Joe Perches000d1cc12011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070029my $show_types = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080031my %debug;
Joe Perches000d1cc12011-07-25 17:13:25 -070032my %ignore_type = ();
33my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070034my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070035my $configuration_file = ".checkpatch.conf";
Hannes Eder77f5b102009-09-21 17:04:37 -070036
37sub help {
38 my ($exitcode) = @_;
39
40 print << "EOM";
41Usage: $P [OPTION]... [FILE]...
42Version: $V
43
44Options:
45 -q, --quiet quiet
46 --no-tree run without a kernel tree
47 --no-signoff do not check for 'Signed-off-by' line
48 --patch treat FILE as patchfile (default)
49 --emacs emacs compile window format
50 --terse one line per report
51 -f, --file treat FILE as regular source file
52 --subjective, --strict enable more subjective tests
Joe Perches000d1cc12011-07-25 17:13:25 -070053 --ignore TYPE(,TYPE2...) ignore various comma separated message types
54 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070055 --root=PATH PATH to the kernel tree root
56 --no-summary suppress the per-file summary
57 --mailback only produce a report in case of warnings/errors
58 --summary-file include the filename in summary
59 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
60 'values', 'possible', 'type', and 'attr' (default
61 is all off)
62 --test-only=WORD report only warnings/errors containing WORD
63 literally
64 -h, --help, --version display this help and exit
65
66When FILE is - read standard input.
67EOM
68
69 exit($exitcode);
70}
71
Joe Perches000d1cc12011-07-25 17:13:25 -070072my $conf = which_conf($configuration_file);
73if (-f $conf) {
74 my @conf_args;
75 open(my $conffile, '<', "$conf")
76 or warn "$P: Can't find a readable $configuration_file file $!\n";
77
78 while (<$conffile>) {
79 my $line = $_;
80
81 $line =~ s/\s*\n?$//g;
82 $line =~ s/^\s*//g;
83 $line =~ s/\s+/ /g;
84
85 next if ($line =~ m/^\s*#/);
86 next if ($line =~ m/^\s*$/);
87
88 my @words = split(" ", $line);
89 foreach my $word (@words) {
90 last if ($word =~ m/^#/);
91 push (@conf_args, $word);
92 }
93 }
94 close($conffile);
95 unshift(@ARGV, @conf_args) if @conf_args;
96}
97
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070098GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700100 'tree!' => \$tree,
101 'signoff!' => \$chk_signoff,
102 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700103 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800104 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700105 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700106 'subjective!' => \$check,
107 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700108 'ignore=s' => \@ignore,
109 'show-types!' => \$show_types,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700110 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800111 'summary!' => \$summary,
112 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800113 'summary-file!' => \$summary_file,
114
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800115 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700116 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700117 'h|help' => \$help,
118 'version' => \$help
119) or help(1);
120
121help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700122
123my $exit = 0;
124
125if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700126 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700127 exit(1);
128}
129
Joe Perches000d1cc12011-07-25 17:13:25 -0700130@ignore = split(/,/, join(',',@ignore));
131foreach my $word (@ignore) {
132 $word =~ s/\s*\n?$//g;
133 $word =~ s/^\s*//g;
134 $word =~ s/\s+/ /g;
135 $word =~ tr/[a-z]/[A-Z]/;
136
137 next if ($word =~ m/^\s*#/);
138 next if ($word =~ m/^\s*$/);
139
140 $ignore_type{$word}++;
141}
142
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800143my $dbg_values = 0;
144my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700145my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700146my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800147for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800148 ## no critic
149 eval "\${dbg_$key} = '$debug{$key}';";
150 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800151}
152
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700153my $rpt_cleaners = 0;
154
Andy Whitcroft8905a672007-11-28 16:21:06 -0800155if ($terse) {
156 $emacs = 1;
157 $quiet++;
158}
159
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700160if ($tree) {
161 if (defined $root) {
162 if (!top_of_kernel_tree($root)) {
163 die "$P: $root: --root does not point at a valid tree\n";
164 }
165 } else {
166 if (top_of_kernel_tree('.')) {
167 $root = '.';
168 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
169 top_of_kernel_tree($1)) {
170 $root = $1;
171 }
172 }
173
174 if (!defined $root) {
175 print "Must be run from the top-level dir. of a kernel tree\n";
176 exit(2);
177 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700178}
179
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700180my $emitted_corrupt = 0;
181
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700182our $Ident = qr{
183 [A-Za-z_][A-Za-z\d_]*
184 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
185 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700186our $Storage = qr{extern|static|asmlinkage};
187our $Sparse = qr{
188 __user|
189 __kernel|
190 __force|
191 __iomem|
192 __must_check|
193 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800194 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700195 __ref|
196 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700197 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800198
199# Notes to $Attribute:
200# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700201our $Attribute = qr{
202 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700203 __percpu|
204 __nocast|
205 __safe|
206 __bitwise__|
207 __packed__|
208 __packed2__|
209 __naked|
210 __maybe_unused|
211 __always_unused|
212 __noreturn|
213 __used|
214 __cold|
215 __noclone|
216 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700217 __read_mostly|
218 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800219 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700220 ____cacheline_aligned|
221 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800222 ____cacheline_internodealigned_in_smp|
223 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700224 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700225our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700227our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
228our $Lval = qr{$Ident(?:$Member)*};
229
230our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
231our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800232our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233our $Operators = qr{
234 <=|>=|==|!=|
235 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800236 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700237 }x;
238
Andy Whitcroft8905a672007-11-28 16:21:06 -0800239our $NonptrType;
240our $Type;
241our $Declare;
242
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700243our $UTF8 = qr {
244 [\x09\x0A\x0D\x20-\x7E] # ASCII
245 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
246 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
247 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
248 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
249 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
250 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
251 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
252}x;
253
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700254our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700255 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700256 atomic_t
257)};
258
Joe Perches691e6692010-03-05 13:43:51 -0800259our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700260 printk(?:_ratelimited|_once|)|
261 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
262 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700263 panic|
264 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800265)};
266
Joe Perches20112472011-07-25 17:13:23 -0700267our $signature_tags = qr{(?xi:
268 Signed-off-by:|
269 Acked-by:|
270 Tested-by:|
271 Reviewed-by:|
272 Reported-by:|
273 To:|
274 Cc:
275)};
276
Andy Whitcroft8905a672007-11-28 16:21:06 -0800277our @typeList = (
278 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700279 qr{(?:unsigned\s+)?char},
280 qr{(?:unsigned\s+)?short},
281 qr{(?:unsigned\s+)?int},
282 qr{(?:unsigned\s+)?long},
283 qr{(?:unsigned\s+)?long\s+int},
284 qr{(?:unsigned\s+)?long\s+long},
285 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800286 qr{unsigned},
287 qr{float},
288 qr{double},
289 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800290 qr{struct\s+$Ident},
291 qr{union\s+$Ident},
292 qr{enum\s+$Ident},
293 qr{${Ident}_t},
294 qr{${Ident}_handler},
295 qr{${Ident}_handler_fn},
296);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700297our @modifierList = (
298 qr{fastcall},
299);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800300
Wolfram Sang7840a942010-08-09 17:20:57 -0700301our $allowed_asm_includes = qr{(?x:
302 irq|
303 memory
304)};
305# memory.h: ARM has a custom one
306
Andy Whitcroft8905a672007-11-28 16:21:06 -0800307sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700308 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
309 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700310 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700312 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800313 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700314 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700315 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700316 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800317 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700318 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800319 }x;
320 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700321 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800322 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700323 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800324 }x;
325 $Declare = qr{(?:$Storage\s+)?$Type};
326}
327build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700328
Joe Perches7d2367a2011-07-25 17:13:22 -0700329our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
330
331our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
332our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
333
334sub deparenthesize {
335 my ($string) = @_;
336 return "" if (!defined($string));
337 $string =~ s@^\s*\(\s*@@g;
338 $string =~ s@\s*\)\s*$@@g;
339 $string =~ s@\s+@ @g;
340 return $string;
341}
342
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700343$chk_signoff = 0 if ($file);
344
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700345my @dep_includes = ();
346my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700347my $removal = "Documentation/feature-removal-schedule.txt";
348if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800349 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700350 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800351 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700352 if (/^Check:\s+(.*\S)/) {
353 for my $entry (split(/[, ]+/, $1)) {
354 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700355 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700356
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700357 } elsif ($entry !~ m@/@) {
358 push(@dep_functions, $entry);
359 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700360 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700361 }
362 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800363 close($REMOVE);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700364}
365
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700366my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800367my @lines = ();
368my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700369for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800370 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700371 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800372 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700373 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800374 } elsif ($filename eq '-') {
375 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700376 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800377 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700378 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700379 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800380 if ($filename eq '-') {
381 $vname = 'Your patch';
382 } else {
383 $vname = $filename;
384 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800385 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700386 chomp;
387 push(@rawlines, $_);
388 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800389 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800390 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700391 $exit = 1;
392 }
393 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800394 @lines = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700395}
396
397exit($exit);
398
399sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700400 my ($root) = @_;
401
402 my @tree_check = (
403 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
404 "README", "Documentation", "arch", "include", "drivers",
405 "fs", "init", "ipc", "kernel", "lib", "scripts",
406 );
407
408 foreach my $check (@tree_check) {
409 if (! -e $root . '/' . $check) {
410 return 0;
411 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700412 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700413 return 1;
Joe Perches000d1cc12011-07-25 17:13:25 -0700414 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700415
Joe Perches20112472011-07-25 17:13:23 -0700416sub parse_email {
417 my ($formatted_email) = @_;
418
419 my $name = "";
420 my $address = "";
421 my $comment = "";
422
423 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
424 $name = $1;
425 $address = $2;
426 $comment = $3 if defined $3;
427 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
428 $address = $1;
429 $comment = $2 if defined $2;
430 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
431 $address = $1;
432 $comment = $2 if defined $2;
433 $formatted_email =~ s/$address.*$//;
434 $name = $formatted_email;
435 $name =~ s/^\s+|\s+$//g;
436 $name =~ s/^\"|\"$//g;
437 # If there's a name left after stripping spaces and
438 # leading quotes, and the address doesn't have both
439 # leading and trailing angle brackets, the address
440 # is invalid. ie:
441 # "joe smith joe@smith.com" bad
442 # "joe smith <joe@smith.com" bad
443 if ($name ne "" && $address !~ /^<[^>]+>$/) {
444 $name = "";
445 $address = "";
446 $comment = "";
447 }
448 }
449
450 $name =~ s/^\s+|\s+$//g;
451 $name =~ s/^\"|\"$//g;
452 $address =~ s/^\s+|\s+$//g;
453 $address =~ s/^\<|\>$//g;
454
455 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
456 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
457 $name = "\"$name\"";
458 }
459
460 return ($name, $address, $comment);
461}
462
463sub format_email {
464 my ($name, $address) = @_;
465
466 my $formatted_email;
467
468 $name =~ s/^\s+|\s+$//g;
469 $name =~ s/^\"|\"$//g;
470 $address =~ s/^\s+|\s+$//g;
471
472 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
473 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
474 $name = "\"$name\"";
475 }
476
477 if ("$name" eq "") {
478 $formatted_email = "$address";
479 } else {
480 $formatted_email = "$name <$address>";
481 }
482
483 return $formatted_email;
484}
485
Joe Perches000d1cc12011-07-25 17:13:25 -0700486sub which_conf {
487 my ($conf) = @_;
488
489 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
490 if (-e "$path/$conf") {
491 return "$path/$conf";
492 }
493 }
494
495 return "";
496}
497
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700498sub expand_tabs {
499 my ($str) = @_;
500
501 my $res = '';
502 my $n = 0;
503 for my $c (split(//, $str)) {
504 if ($c eq "\t") {
505 $res .= ' ';
506 $n++;
507 for (; ($n % 8) != 0; $n++) {
508 $res .= ' ';
509 }
510 next;
511 }
512 $res .= $c;
513 $n++;
514 }
515
516 return $res;
517}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700518sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700519 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700520 return $res;
521}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700522
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700523sub line_stats {
524 my ($line) = @_;
525
526 # Drop the diff line leader and expand tabs
527 $line =~ s/^.//;
528 $line = expand_tabs($line);
529
530 # Pick the indent from the front of the line.
531 my ($white) = ($line =~ /^(\s*)/);
532
533 return (length($line), length($white));
534}
535
Andy Whitcroft773647a2008-03-28 14:15:58 -0700536my $sanitise_quote = '';
537
538sub sanitise_line_reset {
539 my ($in_comment) = @_;
540
541 if ($in_comment) {
542 $sanitise_quote = '*/';
543 } else {
544 $sanitise_quote = '';
545 }
546}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700547sub sanitise_line {
548 my ($line) = @_;
549
550 my $res = '';
551 my $l = '';
552
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800553 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700554 my $off = 0;
555 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700556
Andy Whitcroft773647a2008-03-28 14:15:58 -0700557 # Always copy over the diff marker.
558 $res = substr($line, 0, 1);
559
560 for ($off = 1; $off < length($line); $off++) {
561 $c = substr($line, $off, 1);
562
563 # Comments we are wacking completly including the begin
564 # and end, all to $;.
565 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
566 $sanitise_quote = '*/';
567
568 substr($res, $off, 2, "$;$;");
569 $off++;
570 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800571 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700572 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700573 $sanitise_quote = '';
574 substr($res, $off, 2, "$;$;");
575 $off++;
576 next;
577 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700578 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
579 $sanitise_quote = '//';
580
581 substr($res, $off, 2, $sanitise_quote);
582 $off++;
583 next;
584 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700585
586 # A \ in a string means ignore the next character.
587 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
588 $c eq "\\") {
589 substr($res, $off, 2, 'XX');
590 $off++;
591 next;
592 }
593 # Regular quotes.
594 if ($c eq "'" || $c eq '"') {
595 if ($sanitise_quote eq '') {
596 $sanitise_quote = $c;
597
598 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700599 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700600 } elsif ($sanitise_quote eq $c) {
601 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700602 }
603 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700604
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800605 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700606 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
607 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700608 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
609 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700610 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
611 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700612 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700613 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700614 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800615 }
616
Daniel Walker113f04a2009-09-21 17:04:35 -0700617 if ($sanitise_quote eq '//') {
618 $sanitise_quote = '';
619 }
620
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800621 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700622 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800623 my $clean = 'X' x length($1);
624 $res =~ s@\<.*\>@<$clean>@;
625
626 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700627 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800628 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700629 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800630 }
631
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700632 return $res;
633}
634
Andy Whitcroft8905a672007-11-28 16:21:06 -0800635sub ctx_statement_block {
636 my ($linenr, $remain, $off) = @_;
637 my $line = $linenr - 1;
638 my $blk = '';
639 my $soff = $off;
640 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700641 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800642
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800643 my $loff = 0;
644
Andy Whitcroft8905a672007-11-28 16:21:06 -0800645 my $type = '';
646 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800647 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800648 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800649 my $c;
650 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800651
652 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800653 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800654 @stack = (['', 0]) if ($#stack == -1);
655
Andy Whitcroft773647a2008-03-28 14:15:58 -0700656 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800657 # If we are about to drop off the end, pull in more
658 # context.
659 if ($off >= $len) {
660 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700661 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800662 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800663 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800664 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800665 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800666 $len = length($blk);
667 $line++;
668 last;
669 }
670 # Bail if there is no further context.
671 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800672 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800673 last;
674 }
675 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800676 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800677 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800678 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800679
Andy Whitcroft773647a2008-03-28 14:15:58 -0700680 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800681
682 # Handle nested #if/#else.
683 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
684 push(@stack, [ $type, $level ]);
685 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
686 ($type, $level) = @{$stack[$#stack - 1]};
687 } elsif ($remainder =~ /^#\s*endif\b/) {
688 ($type, $level) = @{pop(@stack)};
689 }
690
Andy Whitcroft8905a672007-11-28 16:21:06 -0800691 # Statement ends at the ';' or a close '}' at the
692 # outermost level.
693 if ($level == 0 && $c eq ';') {
694 last;
695 }
696
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800697 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700698 if ($level == 0 && $coff_set == 0 &&
699 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
700 $remainder =~ /^(else)(?:\s|{)/ &&
701 $remainder !~ /^else\s+if\b/) {
702 $coff = $off + length($1) - 1;
703 $coff_set = 1;
704 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
705 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800706 }
707
Andy Whitcroft8905a672007-11-28 16:21:06 -0800708 if (($type eq '' || $type eq '(') && $c eq '(') {
709 $level++;
710 $type = '(';
711 }
712 if ($type eq '(' && $c eq ')') {
713 $level--;
714 $type = ($level != 0)? '(' : '';
715
716 if ($level == 0 && $coff < $soff) {
717 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700718 $coff_set = 1;
719 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800720 }
721 }
722 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) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700731 if (substr($blk, $off + 1, 1) eq ';') {
732 $off++;
733 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800734 last;
735 }
736 }
737 $off++;
738 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700739 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800740 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700741 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800742 $line++;
743 $remain--;
744 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800745
746 my $statement = substr($blk, $soff, $off - $soff + 1);
747 my $condition = substr($blk, $soff, $coff - $soff + 1);
748
749 #warn "STATEMENT<$statement>\n";
750 #warn "CONDITION<$condition>\n";
751
Andy Whitcroft773647a2008-03-28 14:15:58 -0700752 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800753
754 return ($statement, $condition,
755 $line, $remain + 1, $off - $loff + 1, $level);
756}
757
Andy Whitcroftcf655042008-03-04 14:28:20 -0800758sub statement_lines {
759 my ($stmt) = @_;
760
761 # Strip the diff line prefixes and rip blank lines at start and end.
762 $stmt =~ s/(^|\n)./$1/g;
763 $stmt =~ s/^\s*//;
764 $stmt =~ s/\s*$//;
765
766 my @stmt_lines = ($stmt =~ /\n/g);
767
768 return $#stmt_lines + 2;
769}
770
771sub statement_rawlines {
772 my ($stmt) = @_;
773
774 my @stmt_lines = ($stmt =~ /\n/g);
775
776 return $#stmt_lines + 2;
777}
778
779sub statement_block_size {
780 my ($stmt) = @_;
781
782 $stmt =~ s/(^|\n)./$1/g;
783 $stmt =~ s/^\s*{//;
784 $stmt =~ s/}\s*$//;
785 $stmt =~ s/^\s*//;
786 $stmt =~ s/\s*$//;
787
788 my @stmt_lines = ($stmt =~ /\n/g);
789 my @stmt_statements = ($stmt =~ /;/g);
790
791 my $stmt_lines = $#stmt_lines + 2;
792 my $stmt_statements = $#stmt_statements + 1;
793
794 if ($stmt_lines > $stmt_statements) {
795 return $stmt_lines;
796 } else {
797 return $stmt_statements;
798 }
799}
800
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800801sub ctx_statement_full {
802 my ($linenr, $remain, $off) = @_;
803 my ($statement, $condition, $level);
804
805 my (@chunks);
806
Andy Whitcroftcf655042008-03-04 14:28:20 -0800807 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800808 ($statement, $condition, $linenr, $remain, $off, $level) =
809 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700810 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800811 push(@chunks, [ $condition, $statement ]);
812 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
813 return ($level, $linenr, @chunks);
814 }
815
816 # Pull in the following conditional/block pairs and see if they
817 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800818 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800819 ($statement, $condition, $linenr, $remain, $off, $level) =
820 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800821 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700822 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800823 #print "C: push\n";
824 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800825 }
826
827 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800828}
829
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700830sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700831 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700832 my $line;
833 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700834 my $blk = '';
835 my @o;
836 my @c;
837 my @res = ();
838
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700839 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800840 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700841 for ($line = $start; $remain > 0; $line++) {
842 next if ($rawlines[$line] =~ /^-/);
843 $remain--;
844
845 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800846
847 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700848 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800849 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700850 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800851 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700852 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800853 $level = pop(@stack);
854 }
855
Andy Whitcroft01464f32010-10-26 14:23:19 -0700856 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700857 ##print "C<$c>L<$level><$open$close>O<$off>\n";
858 if ($off > 0) {
859 $off--;
860 next;
861 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700862
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700863 if ($c eq $close && $level > 0) {
864 $level--;
865 last if ($level == 0);
866 } elsif ($c eq $open) {
867 $level++;
868 }
869 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700870
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700871 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700872 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700873 }
874
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700875 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700876 }
877
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700878 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700879}
880sub ctx_block_outer {
881 my ($linenr, $remain) = @_;
882
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700883 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
884 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700885}
886sub ctx_block {
887 my ($linenr, $remain) = @_;
888
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700889 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
890 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700891}
892sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700893 my ($linenr, $remain, $off) = @_;
894
895 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
896 return @r;
897}
898sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700899 my ($linenr, $remain) = @_;
900
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700901 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700902}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700903sub ctx_statement_level {
904 my ($linenr, $remain, $off) = @_;
905
906 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
907}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700908
909sub ctx_locate_comment {
910 my ($first_line, $end_line) = @_;
911
912 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700913 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700914 return $current_comment if (defined $current_comment);
915
916 # Look through the context and try and figure out if there is a
917 # comment.
918 my $in_comment = 0;
919 $current_comment = '';
920 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700921 my $line = $rawlines[$linenr - 1];
922 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700923 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
924 $in_comment = 1;
925 }
926 if ($line =~ m@/\*@) {
927 $in_comment = 1;
928 }
929 if (!$in_comment && $current_comment ne '') {
930 $current_comment = '';
931 }
932 $current_comment .= $line . "\n" if ($in_comment);
933 if ($line =~ m@\*/@) {
934 $in_comment = 0;
935 }
936 }
937
938 chomp($current_comment);
939 return($current_comment);
940}
941sub ctx_has_comment {
942 my ($first_line, $end_line) = @_;
943 my $cmt = ctx_locate_comment($first_line, $end_line);
944
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700945 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700946 ##print "CMMT: $cmt\n";
947
948 return ($cmt ne '');
949}
950
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700951sub raw_line {
952 my ($linenr, $cnt) = @_;
953
954 my $offset = $linenr - 1;
955 $cnt++;
956
957 my $line;
958 while ($cnt) {
959 $line = $rawlines[$offset++];
960 next if (defined($line) && $line =~ /^-/);
961 $cnt--;
962 }
963
964 return $line;
965}
966
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700967sub cat_vet {
968 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700969 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700970
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700971 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700972 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
973 $res .= $1;
974 if ($2 ne '') {
975 $coded = sprintf("^%c", unpack('C', $2) + 64);
976 $res .= $coded;
977 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700978 }
979 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700980
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700981 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700982}
983
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800984my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800985my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800986my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700987my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800988
989sub annotate_reset {
990 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800991 $av_pending = '_';
992 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700993 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800994}
995
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700996sub annotate_values {
997 my ($stream, $type) = @_;
998
999 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001000 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001001 my $cur = $stream;
1002
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001003 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001004
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001005 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001006 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001007 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001008 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001009 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010 print "WS($1)\n" if ($dbg_values > 1);
1011 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001012 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001013 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001014 }
1015
Florian Micklerc023e4732011-01-12 16:59:58 -08001016 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001017 print "CAST($1)\n" if ($dbg_values > 1);
1018 push(@av_paren_type, $type);
1019 $type = 'C';
1020
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001021 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001022 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001023 $type = 'T';
1024
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001025 } elsif ($cur =~ /^($Modifier)\s*/) {
1026 print "MODIFIER($1)\n" if ($dbg_values > 1);
1027 $type = 'T';
1028
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001029 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001030 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001031 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001032 push(@av_paren_type, $type);
1033 if ($2 ne '') {
1034 $av_pending = 'N';
1035 }
1036 $type = 'E';
1037
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001038 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001039 print "UNDEF($1)\n" if ($dbg_values > 1);
1040 $av_preprocessor = 1;
1041 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001042
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001043 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001044 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001045 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001046
1047 push(@av_paren_type, $type);
1048 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001049 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001050
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001051 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001052 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1053 $av_preprocessor = 1;
1054
1055 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1056
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001057 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001058
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001059 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001060 print "PRE_END($1)\n" if ($dbg_values > 1);
1061
1062 $av_preprocessor = 1;
1063
1064 # Assume all arms of the conditional end as this
1065 # one does, and continue as if the #endif was not here.
1066 pop(@av_paren_type);
1067 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001068 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001069
1070 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001071 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001072
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001073 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1074 print "ATTR($1)\n" if ($dbg_values > 1);
1075 $av_pending = $type;
1076 $type = 'N';
1077
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001078 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001079 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001080 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001081 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001082 }
1083 $type = 'N';
1084
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001085 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001087 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001088 $type = 'N';
1089
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001090 } elsif ($cur =~/^(case)/o) {
1091 print "CASE($1)\n" if ($dbg_values > 1);
1092 $av_pend_colon = 'C';
1093 $type = 'N';
1094
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001095 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001096 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001097 $type = 'N';
1098
1099 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001100 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001101 push(@av_paren_type, $av_pending);
1102 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001103 $type = 'N';
1104
1105 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001106 my $new_type = pop(@av_paren_type);
1107 if ($new_type ne '_') {
1108 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001109 print "PAREN('$1') -> $type\n"
1110 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001111 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001112 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001113 }
1114
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001115 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001116 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001117 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001118 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001119
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001120 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1121 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001122 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001123 } elsif ($type eq 'E') {
1124 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001125 }
1126 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1127 $type = 'V';
1128
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001129 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001130 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001131 $type = 'V';
1132
1133 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001134 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001135 $type = 'N';
1136
Andy Whitcroftcf655042008-03-04 14:28:20 -08001137 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001138 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001139 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001140 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001141
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001142 } elsif ($cur =~/^(,)/) {
1143 print "COMMA($1)\n" if ($dbg_values > 1);
1144 $type = 'C';
1145
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001146 } elsif ($cur =~ /^(\?)/o) {
1147 print "QUESTION($1)\n" if ($dbg_values > 1);
1148 $type = 'N';
1149
1150 } elsif ($cur =~ /^(:)/o) {
1151 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1152
1153 substr($var, length($res), 1, $av_pend_colon);
1154 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1155 $type = 'E';
1156 } else {
1157 $type = 'N';
1158 }
1159 $av_pend_colon = 'O';
1160
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001161 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001162 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001163 $type = 'N';
1164
Andy Whitcroft0d413862008-10-15 22:02:16 -07001165 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001166 my $variant;
1167
1168 print "OPV($1)\n" if ($dbg_values > 1);
1169 if ($type eq 'V') {
1170 $variant = 'B';
1171 } else {
1172 $variant = 'U';
1173 }
1174
1175 substr($var, length($res), 1, $variant);
1176 $type = 'N';
1177
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001178 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001179 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001180 if ($1 ne '++' && $1 ne '--') {
1181 $type = 'N';
1182 }
1183
1184 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001185 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001186 }
1187 if (defined $1) {
1188 $cur = substr($cur, length($1));
1189 $res .= $type x length($1);
1190 }
1191 }
1192
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001193 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194}
1195
Andy Whitcroft8905a672007-11-28 16:21:06 -08001196sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001197 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001198 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001199 ^(?:
1200 $Modifier|
1201 $Storage|
1202 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001203 DEFINE_\S+
1204 )$|
1205 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001206 goto|
1207 return|
1208 case|
1209 else|
1210 asm|__asm__|
1211 do
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001212 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001213 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001214 )}x;
1215 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1216 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001217 # Check for modifiers.
1218 $possible =~ s/\s*$Storage\s*//g;
1219 $possible =~ s/\s*$Sparse\s*//g;
1220 if ($possible =~ /^\s*$/) {
1221
1222 } elsif ($possible =~ /\s/) {
1223 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001224 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001225 if ($modifier !~ $notPermitted) {
1226 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1227 push(@modifierList, $modifier);
1228 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001229 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001230
1231 } else {
1232 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1233 push(@typeList, $possible);
1234 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001235 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001236 } else {
1237 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001238 }
1239}
1240
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001241my $prefix = '';
1242
Joe Perches000d1cc12011-07-25 17:13:25 -07001243sub show_type {
1244 return !defined $ignore_type{$_[0]};
1245}
1246
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001247sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001248 if (!show_type($_[1]) ||
1249 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001250 return 0;
1251 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001252 my $line;
1253 if ($show_types) {
1254 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1255 } else {
1256 $line = "$prefix$_[0]: $_[2]\n";
1257 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001258 $line = (split('\n', $line))[0] . "\n" if ($terse);
1259
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001260 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001261
1262 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001263}
1264sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001265 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001266}
Joe Perches000d1cc12011-07-25 17:13:25 -07001267
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001268sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001269 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001270 our $clean = 0;
1271 our $cnt_error++;
1272 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001273}
1274sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001275 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001276 our $clean = 0;
1277 our $cnt_warn++;
1278 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001279}
1280sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001281 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001282 our $clean = 0;
1283 our $cnt_chk++;
1284 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001285}
1286
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001287sub check_absolute_file {
1288 my ($absolute, $herecurr) = @_;
1289 my $file = $absolute;
1290
1291 ##print "absolute<$absolute>\n";
1292
1293 # See if any suffix of this path is a path within the tree.
1294 while ($file =~ s@^[^/]*/@@) {
1295 if (-f "$root/$file") {
1296 ##print "file<$file>\n";
1297 last;
1298 }
1299 }
1300 if (! -f _) {
1301 return 0;
1302 }
1303
1304 # It is, so see if the prefix is acceptable.
1305 my $prefix = $absolute;
1306 substr($prefix, -length($file)) = '';
1307
1308 ##print "prefix<$prefix>\n";
1309 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001310 WARN("USE_RELATIVE_PATH",
1311 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001312 }
1313}
1314
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001315sub process {
1316 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001317
1318 my $linenr=0;
1319 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001320 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001321 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001322 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001323
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001324 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001325 my $indent;
1326 my $previndent=0;
1327 my $stashindent=0;
1328
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001329 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001330 my $signoff = 0;
1331 my $is_patch = 0;
1332
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001333 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001334 our $cnt_lines = 0;
1335 our $cnt_error = 0;
1336 our $cnt_warn = 0;
1337 our $cnt_chk = 0;
1338
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001339 # Trace the real file/line as we go.
1340 my $realfile = '';
1341 my $realline = 0;
1342 my $realcnt = 0;
1343 my $here = '';
1344 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001345 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001346 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001347 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001348
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001349 my $prev_values = 'E';
1350
1351 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001352 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001353 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001354 my %suppress_export;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001355
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001356 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001357 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001358 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001359 my @setup_docs = ();
1360 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001361
1362 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001363 my $line;
1364 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001365 $linenr++;
1366 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001367
Andy Whitcroft773647a2008-03-28 14:15:58 -07001368 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001369 $setup_docs = 0;
1370 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1371 $setup_docs = 1;
1372 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001373 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001374 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001375 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1376 $realline=$1-1;
1377 if (defined $2) {
1378 $realcnt=$3+1;
1379 } else {
1380 $realcnt=1+1;
1381 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001382 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001383
1384 # Guestimate if this is a continuing comment. Run
1385 # the context looking for a comment "edge". If this
1386 # edge is a close comment then we must be in a comment
1387 # at context start.
1388 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001389 my $cnt = $realcnt;
1390 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1391 next if (defined $rawlines[$ln - 1] &&
1392 $rawlines[$ln - 1] =~ /^-/);
1393 $cnt--;
1394 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001395 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001396 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1397 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1398 ($edge) = $1;
1399 last;
1400 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001401 }
1402 if (defined $edge && $edge eq '*/') {
1403 $in_comment = 1;
1404 }
1405
1406 # Guestimate if this is a continuing comment. If this
1407 # is the start of a diff block and this line starts
1408 # ' *' then it is very likely a comment.
1409 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001410 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001411 {
1412 $in_comment = 1;
1413 }
1414
1415 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1416 sanitise_line_reset($in_comment);
1417
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001418 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001419 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001420 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001421 $line = sanitise_line($rawline);
1422 }
1423 push(@lines, $line);
1424
1425 if ($realcnt > 1) {
1426 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1427 } else {
1428 $realcnt = 0;
1429 }
1430
1431 #print "==>$rawline\n";
1432 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001433
1434 if ($setup_docs && $line =~ /^\+/) {
1435 push(@setup_docs, $line);
1436 }
1437 }
1438
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001439 $prefix = '';
1440
Andy Whitcroft773647a2008-03-28 14:15:58 -07001441 $realcnt = 0;
1442 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001443 foreach my $line (@lines) {
1444 $linenr++;
1445
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001446 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001447
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001448#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001449 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001450 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001451 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001452 $realline=$1-1;
1453 if (defined $2) {
1454 $realcnt=$3+1;
1455 } else {
1456 $realcnt=1+1;
1457 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001458 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001459 $prev_values = 'E';
1460
Andy Whitcroft773647a2008-03-28 14:15:58 -07001461 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001462 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001463 %suppress_export = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001464 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001465
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001466# track the line number as we move through the hunk, note that
1467# new versions of GNU diff omit the leading space on completely
1468# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001469 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001470 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001471 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001472
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001473 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001474 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001475
1476 # Track the previous line.
1477 ($prevline, $stashline) = ($stashline, $line);
1478 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001479 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1480
Andy Whitcroft773647a2008-03-28 14:15:58 -07001481 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001482
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001483 } elsif ($realcnt == 1) {
1484 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001485 }
1486
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001487 my $hunk_line = ($realcnt != 0);
1488
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001489#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001490 $prefix = "$filename:$realline: " if ($emacs && $file);
1491 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1492
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001493 $here = "#$linenr: " if (!$file);
1494 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001495
1496 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001497 if ($line =~ /^diff --git.*?(\S+)$/) {
1498 $realfile = $1;
1499 $realfile =~ s@^([^/]*)/@@;
1500
1501 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001502 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001503 $realfile =~ s@^([^/]*)/@@;
1504
1505 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001506 if (!$file && $tree && $p1_prefix ne '' &&
1507 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001508 WARN("PATCH_PREFIX",
1509 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001510 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001511
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001512 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001513 ERROR("MODIFIED_INCLUDE_ASM",
1514 "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 -07001515 }
1516 next;
1517 }
1518
Randy Dunlap389834b2007-06-08 13:47:03 -07001519 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001520
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001521 my $hereline = "$here\n$rawline\n";
1522 my $herecurr = "$here\n$rawline\n";
1523 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001524
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001525 $cnt_lines++ if ($realcnt != 0);
1526
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001527# Check for incorrect file permissions
1528 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1529 my $permhere = $here . "FILE: $realfile\n";
1530 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001531 ERROR("EXECUTE_PERMISSIONS",
1532 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001533 }
1534 }
1535
Joe Perches20112472011-07-25 17:13:23 -07001536# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001537 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001538 $signoff++;
Joe Perches20112472011-07-25 17:13:23 -07001539 }
1540
1541# Check signature styles
1542 if ($line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1543 my $space_before = $1;
1544 my $sign_off = $2;
1545 my $space_after = $3;
1546 my $email = $4;
1547 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1548
1549 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001550 WARN("BAD_SIGN_OFF",
1551 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001552 }
Joe Perches20112472011-07-25 17:13:23 -07001553 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001554 WARN("BAD_SIGN_OFF",
1555 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001556 }
1557 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001558 WARN("BAD_SIGN_OFF",
1559 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001560 }
1561
1562 my ($email_name, $email_address, $comment) = parse_email($email);
1563 my $suggested_email = format_email(($email_name, $email_address));
1564 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001565 ERROR("BAD_SIGN_OFF",
1566 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001567 } else {
1568 my $dequoted = $suggested_email;
1569 $dequoted =~ s/^"//;
1570 $dequoted =~ s/" </ </;
1571 # Don't force email to have quotes
1572 # Allow just an angle bracketed address
1573 if ("$dequoted$comment" ne $email &&
1574 "<$email_address>$comment" ne $email &&
1575 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001576 WARN("BAD_SIGN_OFF",
1577 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001578 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001579 }
1580 }
1581
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001582# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001583 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001584 ERROR("CORRUPTED_PATCH",
1585 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001586 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001587 }
1588
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001589# Check for absolute kernel paths.
1590 if ($tree) {
1591 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1592 my $file = $1;
1593
1594 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1595 check_absolute_file($1, $herecurr)) {
1596 #
1597 } else {
1598 check_absolute_file($file, $herecurr);
1599 }
1600 }
1601 }
1602
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001603# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1604 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001605 $rawline !~ m/^$UTF8*$/) {
1606 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1607
1608 my $blank = copy_spacing($rawline);
1609 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1610 my $hereptr = "$hereline$ptr\n";
1611
Joe Perches34d99212011-07-25 17:13:26 -07001612 CHK("INVALID_UTF8",
1613 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001614 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001615
Andy Whitcroft306708542008-10-15 22:02:28 -07001616# ignore non-hunk lines and lines being removed
1617 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001618
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001619#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001620 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001621 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001622 ERROR("DOS_LINE_ENDINGS",
1623 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001624
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001625 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1626 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001627 ERROR("TRAILING_WHITESPACE",
1628 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001629 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001630 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001631
Andi Kleen33549572010-05-24 14:33:29 -07001632# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001633# Only applies when adding the entry originally, after that we do not have
1634# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001635 if ($realfile =~ /Kconfig/ &&
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001636 $line =~ /\+\s*(?:---)?help(?:---)?$/) {
Andi Kleen33549572010-05-24 14:33:29 -07001637 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001638 my $cnt = $realcnt;
1639 my $ln = $linenr + 1;
1640 my $f;
1641 my $is_end = 0;
1642 while ($cnt > 0 && defined $lines[$ln - 1]) {
1643 $f = $lines[$ln - 1];
1644 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1645 $is_end = $lines[$ln - 1] =~ /^\+/;
1646 $ln++;
1647
1648 next if ($f =~ /^-/);
1649 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001650 $f =~ s/#.*//;
1651 $f =~ s/^\s+//;
1652 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001653 if ($f =~ /^\s*config\s/) {
1654 $is_end = 1;
1655 last;
1656 }
Andi Kleen33549572010-05-24 14:33:29 -07001657 $length++;
1658 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001659 WARN("CONFIG_DESCRIPTION",
1660 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001661 #print "is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001662 }
1663
Andy Whitcroft5368df202008-10-15 22:02:27 -07001664# check we are in a valid source file if not then ignore this hunk
1665 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1666
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001667#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001668 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001669 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001670 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001671 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001672 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001673 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001674 WARN("LONG_LINE",
1675 "line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001676 }
1677
Joe Perches5e79d962010-03-05 13:43:55 -08001678# check for spaces before a quoted newline
1679 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001680 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1681 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001682 }
1683
Andy Whitcroft8905a672007-11-28 16:21:06 -08001684# check for adding lines without a newline.
1685 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001686 WARN("MISSING_EOF_NEWLINE",
1687 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001688 }
1689
Mike Frysinger42e41c52009-09-21 17:04:40 -07001690# Blackfin: use hi/lo macros
1691 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1692 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1693 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001694 ERROR("LO_MACRO",
1695 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001696 }
1697 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1698 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001699 ERROR("HI_MACRO",
1700 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001701 }
1702 }
1703
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001704# check we are in a valid source file C or perl if not then ignore this hunk
1705 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001706
1707# at the beginning of a line any tabs must come first and anything
1708# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001709 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1710 $rawline =~ /^\+\s* \s*/) {
1711 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001712 ERROR("CODE_INDENT",
1713 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001714 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001715 }
1716
Alberto Panizzo08e44362010-03-05 13:43:54 -08001717# check for space before tabs.
1718 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1719 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001720 WARN("SPACE_BEFORE_TAB",
1721 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001722 }
1723
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001724# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001725# Exceptions:
1726# 1) within comments
1727# 2) indented preprocessor commands
1728# 3) hanging labels
1729 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001730 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001731 WARN("LEADING_SPACE",
1732 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001733 }
1734
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001735# check we are in a valid C source file if not then ignore this hunk
1736 next if ($realfile !~ /\.(h|c)$/);
1737
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001738# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001739 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001740 WARN("CVS_KEYWORD",
1741 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001742 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001743
Mike Frysinger42e41c52009-09-21 17:04:40 -07001744# Blackfin: don't use __builtin_bfin_[cs]sync
1745 if ($line =~ /__builtin_bfin_csync/) {
1746 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001747 ERROR("CSYNC",
1748 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001749 }
1750 if ($line =~ /__builtin_bfin_ssync/) {
1751 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001752 ERROR("SSYNC",
1753 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001754 }
1755
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001756# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001757 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1758 $realline_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001759 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001760 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001761 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001762 $stat =~ s/\n./\n /g;
1763 $cond =~ s/\n./\n /g;
1764
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001765 # Find the real next line.
1766 $realline_next = $line_nr_next;
1767 if (defined $realline_next &&
1768 (!defined $lines[$realline_next - 1] ||
1769 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1770 $realline_next++;
1771 }
1772
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001773 my $s = $stat;
1774 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001775
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001776 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001777 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001778
1779 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001780 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001781
Andy Whitcroft463f2862009-09-21 17:04:34 -07001782 } elsif ($s =~ /^.\s*else\b/s) {
1783
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001784 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001785 } 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 -07001786 my $type = $1;
1787 $type =~ s/\s+/ /g;
1788 possible($type, "A:" . $s);
1789
Andy Whitcroft8905a672007-11-28 16:21:06 -08001790 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001791 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001792 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001793 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001794
1795 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001796 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001797 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001798 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001799
1800 # Check for any sort of function declaration.
1801 # int foo(something bar, other baz);
1802 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001803 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 -08001804 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001805
Andy Whitcroftcf655042008-03-04 14:28:20 -08001806 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001807 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001808 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001809
Andy Whitcroft8905a672007-11-28 16:21:06 -08001810 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001811 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001812
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001813 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001814 }
1815 }
1816 }
1817
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001818 }
1819
Andy Whitcroft653d4872007-06-23 17:16:34 -07001820#
1821# Checks which may be anchored in the context.
1822#
1823
1824# Check for switch () and associated case and default
1825# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001826 if ($line=~/\bswitch\s*\(.*\)/) {
1827 my $err = '';
1828 my $sep = '';
1829 my @ctx = ctx_block_outer($linenr, $realcnt);
1830 shift(@ctx);
1831 for my $ctx (@ctx) {
1832 my ($clen, $cindent) = line_stats($ctx);
1833 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1834 $indent != $cindent) {
1835 $err .= "$sep$ctx\n";
1836 $sep = '';
1837 } else {
1838 $sep = "[...]\n";
1839 }
1840 }
1841 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07001842 ERROR("SWITCH_CASE_INDENT_LEVEL",
1843 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001844 }
1845 }
1846
1847# if/while/etc brace do not go on next line, unless defining a do while loop,
1848# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001849 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001850 my $pre_ctx = "$1$2";
1851
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001852 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001853 my $ctx_cnt = $realcnt - $#ctx - 1;
1854 my $ctx = join("\n", @ctx);
1855
Andy Whitcroft548596d2008-07-23 21:29:01 -07001856 my $ctx_ln = $linenr;
1857 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001858
Andy Whitcroft548596d2008-07-23 21:29:01 -07001859 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1860 defined $lines[$ctx_ln - 1] &&
1861 $lines[$ctx_ln - 1] =~ /^-/)) {
1862 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1863 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001864 $ctx_ln++;
1865 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001866
Andy Whitcroft53210162008-07-23 21:29:03 -07001867 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1868 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001869
1870 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001871 ERROR("OPEN_BRACE",
1872 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001873 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001874 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001875 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1876 $ctx =~ /\)\s*\;\s*$/ &&
1877 defined $lines[$ctx_ln - 1])
1878 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001879 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1880 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001881 WARN("TRAILING_SEMICOLON",
1882 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07001883 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001884 }
1885 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001886 }
1887
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001888# Check relative indent for conditionals and blocks.
1889 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1890 my ($s, $c) = ($stat, $cond);
1891
1892 substr($s, 0, length($c), '');
1893
1894 # Make sure we remove the line prefixes as we have
1895 # none on the first line, and are going to readd them
1896 # where necessary.
1897 $s =~ s/\n./\n/gs;
1898
1899 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001900 my @newlines = ($c =~ /\n/gs);
1901 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001902
1903 # We want to check the first line inside the block
1904 # starting at the end of the conditional, so remove:
1905 # 1) any blank line termination
1906 # 2) any opening brace { on end of the line
1907 # 3) any do (...) {
1908 my $continuation = 0;
1909 my $check = 0;
1910 $s =~ s/^.*\bdo\b//;
1911 $s =~ s/^\s*{//;
1912 if ($s =~ s/^\s*\\//) {
1913 $continuation = 1;
1914 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001915 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001916 $check = 1;
1917 $cond_lines++;
1918 }
1919
1920 # Also ignore a loop construct at the end of a
1921 # preprocessor statement.
1922 if (($prevline =~ /^.\s*#\s*define\s/ ||
1923 $prevline =~ /\\\s*$/) && $continuation == 0) {
1924 $check = 0;
1925 }
1926
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001927 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001928 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001929 while ($cond_ptr != $cond_lines) {
1930 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001931
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001932 # If we see an #else/#elif then the code
1933 # is not linear.
1934 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1935 $check = 0;
1936 }
1937
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001938 # Ignore:
1939 # 1) blank lines, they should be at 0,
1940 # 2) preprocessor lines, and
1941 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001942 if ($continuation ||
1943 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001944 $s =~ /^\s*#\s*?/ ||
1945 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001946 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001947 if ($s =~ s/^.*?\n//) {
1948 $cond_lines++;
1949 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001950 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001951 }
1952
1953 my (undef, $sindent) = line_stats("+" . $s);
1954 my $stat_real = raw_line($linenr, $cond_lines);
1955
1956 # Check if either of these lines are modified, else
1957 # this is not this patch's fault.
1958 if (!defined($stat_real) ||
1959 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1960 $check = 0;
1961 }
1962 if (defined($stat_real) && $cond_lines > 1) {
1963 $stat_real = "[...]\n$stat_real";
1964 }
1965
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001966 #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 -07001967
1968 if ($check && (($sindent % 8) != 0 ||
1969 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001970 WARN("SUSPECT_CODE_INDENT",
1971 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001972 }
1973 }
1974
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001975 # Track the 'values' across context and added lines.
1976 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001977 my ($curr_values, $curr_vars) =
1978 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001979 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001980 if ($dbg_values) {
1981 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001982 print "$linenr > .$outline\n";
1983 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001984 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001985 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001986 $prev_values = substr($curr_values, -1);
1987
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001988#ignore lines not being added
1989 if ($line=~/^[^\+]/) {next;}
1990
Andy Whitcroft653d4872007-06-23 17:16:34 -07001991# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001992 if ($dbg_type) {
1993 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001994 ERROR("TEST_TYPE",
1995 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07001996 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001997 ERROR("TEST_NOT_TYPE",
1998 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07001999 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002000 next;
2001 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002002# TEST: allow direct testing of the attribute matcher.
2003 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002004 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002005 ERROR("TEST_ATTR",
2006 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002007 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002008 ERROR("TEST_NOT_ATTR",
2009 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002010 }
2011 next;
2012 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002013
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002014# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002015 if ($line =~ /^.\s*{/ &&
2016 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002017 ERROR("OPEN_BRACE",
2018 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002019 }
2020
Andy Whitcroft653d4872007-06-23 17:16:34 -07002021#
2022# Checks which are anchored on the added line.
2023#
2024
2025# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002026 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002027 my $path = $1;
2028 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002029 ERROR("MALFORMED_INCLUDE",
2030 "malformed #include filename\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002031 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002032 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002033 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002034
2035# no C99 // comments
2036 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002037 ERROR("C99_COMMENTS",
2038 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002039 }
2040 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002041 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002042 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002043
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002044# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2045# the whole statement.
2046#print "APW <$lines[$realline_next - 1]>\n";
2047 if (defined $realline_next &&
2048 exists $lines[$realline_next - 1] &&
2049 !defined $suppress_export{$realline_next} &&
2050 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2051 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002052 # Handle definitions which produce identifiers with
2053 # a prefix:
2054 # XXX(foo);
2055 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002056 my $name = $1;
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002057 if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ &&
2058 $name =~ /^${Ident}_$2/) {
2059#print "FOO C name<$name>\n";
2060 $suppress_export{$realline_next} = 1;
2061
2062 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002063 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002064 ^.DEFINE_$Ident\(\Q$name\E\)|
2065 ^.DECLARE_$Ident\(\Q$name\E\)|
2066 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002067 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2068 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002069 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002070#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2071 $suppress_export{$realline_next} = 2;
2072 } else {
2073 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002074 }
2075 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002076 if (!defined $suppress_export{$linenr} &&
2077 $prevline =~ /^.\s*$/ &&
2078 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2079 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2080#print "FOO B <$lines[$linenr - 1]>\n";
2081 $suppress_export{$linenr} = 2;
2082 }
2083 if (defined $suppress_export{$linenr} &&
2084 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002085 WARN("EXPORT_SYMBOL",
2086 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002087 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002088
Joe Eloff5150bda2010-08-09 17:21:00 -07002089# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002090 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002091 ERROR("GLOBAL_INITIALISERS",
2092 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002093 $herecurr);
2094 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002095# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002096 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002097 ERROR("INITIALISED_STATIC",
2098 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002099 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002100 }
2101
Joe Perchescb710ec2010-10-26 14:23:20 -07002102# check for static const char * arrays.
2103 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002104 WARN("STATIC_CONST_CHAR_ARRAY",
2105 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002106 $herecurr);
2107 }
2108
2109# check for static char foo[] = "bar" declarations.
2110 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002111 WARN("STATIC_CONST_CHAR_ARRAY",
2112 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002113 $herecurr);
2114 }
2115
Joe Perches93ed0e22010-10-26 14:23:21 -07002116# check for declarations of struct pci_device_id
2117 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002118 WARN("DEFINE_PCI_DEVICE_TABLE",
2119 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002120 }
2121
Andy Whitcroft653d4872007-06-23 17:16:34 -07002122# check for new typedefs, only function parameters and sparse annotations
2123# make sense.
2124 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002125 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002126 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002127 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002128 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002129 WARN("NEW_TYPEDEFS",
2130 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002131 }
2132
2133# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002134 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08002135 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002136 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002137
Andy Whitcroft65863862009-01-06 14:41:21 -08002138 # Should start with a space.
2139 $to =~ s/^(\S)/ $1/;
2140 # Should not end with a space.
2141 $to =~ s/\s+$//;
2142 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002143 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002144 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002145
Andy Whitcroft65863862009-01-06 14:41:21 -08002146 #print "from<$from> to<$to>\n";
2147 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002148 ERROR("POINTER_LOCATION",
2149 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002150 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08002151 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002152 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002153
Andy Whitcroft65863862009-01-06 14:41:21 -08002154 # Should start with a space.
2155 $to =~ s/^(\S)/ $1/;
2156 # Should not end with a space.
2157 $to =~ s/\s+$//;
2158 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002159 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002160 }
2161 # Modifiers should have spaces.
2162 $to =~ s/(\b$Modifier$)/$1 /;
2163
Andy Whitcroft667026e2009-02-27 14:03:08 -08002164 #print "from<$from> to<$to> ident<$ident>\n";
2165 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002166 ERROR("POINTER_LOCATION",
2167 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002168 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002169 }
2170
2171# # no BUG() or BUG_ON()
2172# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2173# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2174# print "$herecurr";
2175# $clean = 0;
2176# }
2177
Andy Whitcroft8905a672007-11-28 16:21:06 -08002178 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002179 WARN("LINUX_VERSION_CODE",
2180 "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 -08002181 }
2182
Joe Perches17441222011-06-15 15:08:17 -07002183# check for uses of printk_ratelimit
2184 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002185 WARN("PRINTK_RATELIMITED",
2186"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002187 }
2188
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002189# printk should use KERN_* levels. Note that follow on printk's on the
2190# same line do not need a level, so we use the current block context
2191# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002192# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002193# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002194 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002195 my $ok = 0;
2196 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2197 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002198 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002199 # with "\n" ignore it, else it is to blame
2200 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2201 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2202 $ok = 1;
2203 }
2204 last;
2205 }
2206 }
2207 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002208 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2209 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002210 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002211 }
2212
Andy Whitcroft653d4872007-06-23 17:16:34 -07002213# function brace can't be on same line, except for #defines of do while,
2214# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002215 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2216 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002217 ERROR("OPEN_BRACE",
2218 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002219 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002220
Andy Whitcroft8905a672007-11-28 16:21:06 -08002221# open braces for enum, union and struct go on the same line.
2222 if ($line =~ /^.\s*{/ &&
2223 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002224 ERROR("OPEN_BRACE",
2225 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002226 }
2227
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002228# missing space after union, struct or enum definition
2229 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002230 WARN("SPACING",
2231 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002232 }
2233
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002234# check for spacing round square brackets; allowed:
2235# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002236# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2237# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002238 while ($line =~ /(.*?\s)\[/g) {
2239 my ($where, $prefix) = ($-[1], $1);
2240 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002241 ($where != 0 || $prefix !~ /^.\s+$/) &&
2242 $prefix !~ /{\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002243 ERROR("BRACKET_SPACE",
2244 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002245 }
2246 }
2247
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002248# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002249 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002250 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002251 my $ctx_before = substr($line, 0, $-[1]);
2252 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002253
2254 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002255 if ($name =~ /^(?:
2256 if|for|while|switch|return|case|
2257 volatile|__volatile__|
2258 __attribute__|format|__extension__|
2259 asm|__asm__)$/x)
2260 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002261
2262 # cpp #define statements have non-optional spaces, ie
2263 # if there is a space between the name and the open
2264 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002265 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002266
2267 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002268 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002269
2270 # If this whole things ends with a type its most
2271 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002272 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002273
2274 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002275 WARN("SPACING",
2276 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002277 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002278 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002279# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002280 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002281 my $ops = qr{
2282 <<=|>>=|<=|>=|==|!=|
2283 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2284 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002285 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2286 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002287 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002288 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002289 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002290
2291 my $blank = copy_spacing($opline);
2292
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002293 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002294 $off += length($elements[$n]);
2295
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002296 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002297 my $ca = substr($opline, 0, $off);
2298 my $cc = '';
2299 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2300 $cc = substr($opline, $off + length($elements[$n + 1]));
2301 }
2302 my $cb = "$ca$;$cc";
2303
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002304 my $a = '';
2305 $a = 'V' if ($elements[$n] ne '');
2306 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002307 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002308 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2309 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002310 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002311
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002312 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002313
2314 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002315 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002316 $c = 'V' if ($elements[$n + 2] ne '');
2317 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002318 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002319 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2320 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002321 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002322 } else {
2323 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002324 }
2325
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002326 my $ctx = "${a}x${c}";
2327
2328 my $at = "(ctx:$ctx)";
2329
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002330 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002331 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002332
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002333 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002334 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002335
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002336 # Get the full operator variant.
2337 my $opv = $op . substr($curr_vars, $off, 1);
2338
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002339 # Ignore operators passed as parameters.
2340 if ($op_type ne 'V' &&
2341 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2342
Andy Whitcroftcf655042008-03-04 14:28:20 -08002343# # Ignore comments
2344# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002345
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002346 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002347 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002348 if ($ctx !~ /.x[WEBC]/ &&
2349 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002350 ERROR("SPACING",
2351 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002352 }
2353
2354 # // is a comment
2355 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002356
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002357 # No spaces for:
2358 # ->
2359 # : when part of a bitfield
2360 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002361 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002362 ERROR("SPACING",
2363 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002364 }
2365
2366 # , must have a space on the right.
2367 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002368 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002369 ERROR("SPACING",
2370 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002371 }
2372
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002373 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002374 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002375 #warn "'*' is part of type\n";
2376
2377 # unary operators should have a space before and
2378 # none after. May be left adjacent to another
2379 # unary operator, or a cast
2380 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002381 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002382 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002383 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002384 ERROR("SPACING",
2385 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002386 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002387 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002388 # A unary '*' may be const
2389
2390 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002391 ERROR("SPACING",
2392 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002393 }
2394
2395 # unary ++ and unary -- are allowed no space on one side.
2396 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002397 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002398 ERROR("SPACING",
2399 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002400 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002401 if ($ctx =~ /Wx[BE]/ ||
2402 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002403 ERROR("SPACING",
2404 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002405 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002406 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002407 ERROR("SPACING",
2408 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002409 }
2410
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002411
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002412 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002413 } elsif ($op eq '<<' or $op eq '>>' or
2414 $op eq '&' or $op eq '^' or $op eq '|' or
2415 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002416 $op eq '*' or $op eq '/' or
2417 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002418 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002420 ERROR("SPACING",
2421 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002422 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002423 }
2424
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002425 # A colon needs no spaces before when it is
2426 # terminating a case value or a label.
2427 } elsif ($opv eq ':C' || $opv eq ':L') {
2428 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002429 ERROR("SPACING",
2430 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002431 }
2432
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002433 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002434 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002435 my $ok = 0;
2436
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002437 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002438 if (($op eq '<' &&
2439 $cc =~ /^\S+\@\S+>/) ||
2440 ($op eq '>' &&
2441 $ca =~ /<\S+\@\S+$/))
2442 {
2443 $ok = 1;
2444 }
2445
2446 # Ignore ?:
2447 if (($opv eq ':O' && $ca =~ /\?$/) ||
2448 ($op eq '?' && $cc =~ /^:/)) {
2449 $ok = 1;
2450 }
2451
2452 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002453 ERROR("SPACING",
2454 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002455 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002456 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002457 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002458 }
2459 }
2460
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002461# check for multiple assignments
2462 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002463 CHK("MULTIPLE_ASSIGNMENTS",
2464 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002465 }
2466
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002467## # check for multiple declarations, allowing for a function declaration
2468## # continuation.
2469## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2470## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2471##
2472## # Remove any bracketed sections to ensure we do not
2473## # falsly report the parameters of functions.
2474## my $ln = $line;
2475## while ($ln =~ s/\([^\(\)]*\)//g) {
2476## }
2477## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002478## WARN("MULTIPLE_DECLARATION",
2479## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002480## }
2481## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002482
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002483#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002484 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2485 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002486 ERROR("SPACING",
2487 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002488 }
2489
2490# closing brace should have a space following it when it has anything
2491# on the line
2492 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002493 ERROR("SPACING",
2494 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002495 }
2496
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002497# check spacing on square brackets
2498 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002499 ERROR("SPACING",
2500 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002501 }
2502 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002503 ERROR("SPACING",
2504 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002505 }
2506
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002507# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002508 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2509 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002510 ERROR("SPACING",
2511 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002512 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002513 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002514 $line !~ /for\s*\(.*;\s+\)/ &&
2515 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002516 ERROR("SPACING",
2517 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002518 }
2519
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002520#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002521 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002522 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002523 WARN("INDENTED_LABEL",
2524 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002525 }
2526
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002527# Return is not a function.
2528 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2529 my $spacing = $1;
2530 my $value = $2;
2531
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002532 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002533 $value =~ s/\(/ \(/g;
2534 $value =~ s/\)/\) /g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002535 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2536 $value !~ /(?:$Ident|-?$Constant)\s*
2537 $Compare\s*
2538 (?:$Ident|-?$Constant)/x &&
2539 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002540 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002541#print "value<$value>\n";
2542 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002543 ERROR("RETURN_PARENTHESES",
2544 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002545
2546 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002547 ERROR("SPACING",
2548 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002549 }
2550 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002551# Return of what appears to be an errno should normally be -'ve
2552 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2553 my $name = $1;
2554 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002555 WARN("USE_NEGATIVE_ERRNO",
2556 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002557 }
2558 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002559
Joe Perches7d2367a2011-07-25 17:13:22 -07002560# typecasts on min/max could be min_t/max_t
2561 if ($line =~ /^\+(?:.*?)\b(min|max)\s*\($Typecast{0,1}($LvalOrFunc)\s*,\s*$Typecast{0,1}($LvalOrFunc)\s*\)/) {
2562 if (defined $2 || defined $8) {
2563 my $call = $1;
2564 my $cast1 = deparenthesize($2);
2565 my $arg1 = $3;
2566 my $cast2 = deparenthesize($8);
2567 my $arg2 = $9;
2568 my $cast;
2569
2570 if ($cast1 ne "" && $cast2 ne "") {
2571 $cast = "$cast1 or $cast2";
2572 } elsif ($cast1 ne "") {
2573 $cast = $cast1;
2574 } else {
2575 $cast = $cast2;
2576 }
2577 WARN("$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . $herecurr);
2578 }
2579 }
2580
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002581# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002582 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002583 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002584 }
2585
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002586# Check for illegal assignment in if conditional -- and check for trailing
2587# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002588 if ($line =~ /do\s*(?!{)/) {
2589 my ($stat_next) = ctx_statement_block($line_nr_next,
2590 $remain_next, $off_next);
2591 $stat_next =~ s/\n./\n /g;
2592 ##print "stat<$stat> stat_next<$stat_next>\n";
2593
2594 if ($stat_next =~ /^\s*while\b/) {
2595 # If the statement carries leading newlines,
2596 # then count those as offsets.
2597 my ($whitespace) =
2598 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2599 my $offset =
2600 statement_rawlines($whitespace) - 1;
2601
2602 $suppress_whiletrailers{$line_nr_next +
2603 $offset} = 1;
2604 }
2605 }
2606 if (!defined $suppress_whiletrailers{$linenr} &&
2607 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002608 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002609
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002610 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002611 ERROR("ASSIGN_IN_IF",
2612 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002613 }
2614
2615 # Find out what is on the end of the line after the
2616 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002617 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002618 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002619 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002620 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2621 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002622 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002623 # Find out how long the conditional actually is.
2624 my @newlines = ($c =~ /\n/gs);
2625 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002626 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002627
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002628 $stat_real = raw_line($linenr, $cond_lines)
2629 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002630 if (defined($stat_real) && $cond_lines > 1) {
2631 $stat_real = "[...]\n$stat_real";
2632 }
2633
Joe Perches000d1cc12011-07-25 17:13:25 -07002634 ERROR("TRAILING_STATEMENTS",
2635 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002636 }
2637 }
2638
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002639# Check for bitwise tests written as boolean
2640 if ($line =~ /
2641 (?:
2642 (?:\[|\(|\&\&|\|\|)
2643 \s*0[xX][0-9]+\s*
2644 (?:\&\&|\|\|)
2645 |
2646 (?:\&\&|\|\|)
2647 \s*0[xX][0-9]+\s*
2648 (?:\&\&|\|\||\)|\])
2649 )/x)
2650 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002651 WARN("HEXADECIMAL_BOOLEAN_TEST",
2652 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002653 }
2654
Andy Whitcroft8905a672007-11-28 16:21:06 -08002655# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002656 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2657 my $s = $1;
2658 $s =~ s/$;//g; # Remove any comments
2659 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002660 ERROR("TRAILING_STATEMENTS",
2661 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002662 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002663 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002664# if should not continue a brace
2665 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002666 ERROR("TRAILING_STATEMENTS",
2667 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002668 $herecurr);
2669 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002670# case and default should not have general statements after them
2671 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2672 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002673 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002674 \s*return\s+
2675 )/xg)
2676 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002677 ERROR("TRAILING_STATEMENTS",
2678 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002679 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002680
2681 # Check for }<nl>else {, these must be at the same
2682 # indent level to be relevant to each other.
2683 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2684 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002685 ERROR("ELSE_AFTER_BRACE",
2686 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002687 }
2688
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002689 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2690 $previndent == $indent) {
2691 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2692
2693 # Find out what is on the end of the line after the
2694 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002695 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002696 $s =~ s/\n.*//g;
2697
2698 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002699 ERROR("WHILE_AFTER_BRACE",
2700 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002701 }
2702 }
2703
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002704#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2705# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2706# print "No studly caps, use _\n";
2707# print "$herecurr";
2708# $clean = 0;
2709# }
2710
2711#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002712 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002713 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2714 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002715 }
2716
Andy Whitcroft653d4872007-06-23 17:16:34 -07002717#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002718 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002719 my $file = "$1.h";
2720 my $checkfile = "include/linux/$file";
2721 if (-f "$root/$checkfile" &&
2722 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002723 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002724 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002725 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002726 CHK("ARCH_INCLUDE_LINUX",
2727 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002728 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002729 WARN("INCLUDE_LINUX",
2730 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002731 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002732 }
2733 }
2734
Andy Whitcroft653d4872007-06-23 17:16:34 -07002735# multi-statement macros should be enclosed in a do while loop, grab the
2736# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002737# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002738 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2739 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002740 my $ln = $linenr;
2741 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002742 my ($off, $dstat, $dcond, $rest);
2743 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002744
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002745 my $args = defined($1);
2746
2747 # Find the end of the macro and limit our statement
2748 # search to that.
2749 while ($cnt > 0 && defined $lines[$ln - 1] &&
2750 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2751 {
2752 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002753 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002754 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002755 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002756 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002757
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002758 ($dstat, $dcond, $ln, $cnt, $off) =
2759 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2760 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002761 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002762
2763 # Extract the remainder of the define (if any) and
2764 # rip off surrounding spaces, and trailing \'s.
2765 $rest = '';
Andy Whitcroft636d140a2008-10-15 22:02:18 -07002766 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2767 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002768 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2769 $rest .= substr($lines[$ln - 1], $off) . "\n";
2770 $cnt--;
2771 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002772 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002773 $off = 0;
2774 }
2775 $rest =~ s/\\\n.//g;
2776 $rest =~ s/^\s*//s;
2777 $rest =~ s/\s*$//s;
2778
2779 # Clean up the original statement.
2780 if ($args) {
2781 substr($dstat, 0, length($dcond), '');
2782 } else {
2783 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2784 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002785 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002786 $dstat =~ s/\\\n.//g;
2787 $dstat =~ s/^\s*//s;
2788 $dstat =~ s/\s*$//s;
2789
2790 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002791 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2792 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2793 $dstat =~ s/\[[^\{\}]*\]/1/)
2794 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002795 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002796
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002797 my $exceptions = qr{
2798 $Declare|
2799 module_param_named|
2800 MODULE_PARAM_DESC|
2801 DECLARE_PER_CPU|
2802 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002803 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002804 union|
2805 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002806 \.$Ident\s*=\s*|
2807 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002808 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07002809 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2810 if ($rest ne '' && $rest ne ',') {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002811 if ($rest !~ /while\s*\(/ &&
2812 $dstat !~ /$exceptions/)
2813 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002814 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2815 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002816 }
2817
2818 } elsif ($ctx !~ /;/) {
2819 if ($dstat ne '' &&
2820 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2821 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002822 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002823 $dstat =~ /$Operators/)
2824 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002825 ERROR("COMPLEX_MACRO",
2826 "Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002827 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002828 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002829 }
2830
Mike Frysinger080ba922009-01-06 14:41:25 -08002831# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2832# all assignments may have only one of the following with an assignment:
2833# .
2834# ALIGN(...)
2835# VMLINUX_SYMBOL(...)
2836 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002837 WARN("MISSING_VMLINUX_SYMBOL",
2838 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08002839 }
2840
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002841# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002842 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2843 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002844 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002845 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002846 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2847 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002848 my $allowed = 0;
2849 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002850 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002851 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002852 for my $chunk (@chunks) {
2853 my ($cond, $block) = @{$chunk};
2854
Andy Whitcroft773647a2008-03-28 14:15:58 -07002855 # If the condition carries leading newlines, then count those as offsets.
2856 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2857 my $offset = statement_rawlines($whitespace) - 1;
2858
2859 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2860
2861 # We have looked at and allowed this specific line.
2862 $suppress_ifbraces{$ln + $offset} = 1;
2863
2864 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002865 $ln += statement_rawlines($block) - 1;
2866
Andy Whitcroft773647a2008-03-28 14:15:58 -07002867 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002868
2869 $seen++ if ($block =~ /^\s*{/);
2870
Andy Whitcroftcf655042008-03-04 14:28:20 -08002871 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2872 if (statement_lines($cond) > 1) {
2873 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002874 $allowed = 1;
2875 }
2876 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002877 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002878 $allowed = 1;
2879 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002880 if (statement_block_size($block) > 1) {
2881 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002882 $allowed = 1;
2883 }
2884 }
2885 if ($seen && !$allowed) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002886 WARN("BRACES",
2887 "braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002888 }
2889 }
2890 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002891 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002892 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002893 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002894
Andy Whitcroftcf655042008-03-04 14:28:20 -08002895 # Check the pre-context.
2896 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2897 #print "APW: ALLOWED: pre<$1>\n";
2898 $allowed = 1;
2899 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002900
2901 my ($level, $endln, @chunks) =
2902 ctx_statement_full($linenr, $realcnt, $-[0]);
2903
Andy Whitcroftcf655042008-03-04 14:28:20 -08002904 # Check the condition.
2905 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002906 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002907 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002908 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002909 }
2910 if (statement_lines($cond) > 1) {
2911 #print "APW: ALLOWED: cond<$cond>\n";
2912 $allowed = 1;
2913 }
2914 if ($block =~/\b(?:if|for|while)\b/) {
2915 #print "APW: ALLOWED: block<$block>\n";
2916 $allowed = 1;
2917 }
2918 if (statement_block_size($block) > 1) {
2919 #print "APW: ALLOWED: lines block<$block>\n";
2920 $allowed = 1;
2921 }
2922 # Check the post-context.
2923 if (defined $chunks[1]) {
2924 my ($cond, $block) = @{$chunks[1]};
2925 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002926 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002927 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002928 if ($block =~ /^\s*\{/) {
2929 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2930 $allowed = 1;
2931 }
2932 }
2933 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2934 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002935 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002936
Andy Whitcroftf0556632008-10-15 22:02:23 -07002937 for (my $n = 0; $n < $cnt; $n++) {
2938 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002939 }
2940
Joe Perches000d1cc12011-07-25 17:13:25 -07002941 WARN("BRACES",
2942 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002943 }
2944 }
2945
Andy Whitcroft653d4872007-06-23 17:16:34 -07002946# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002947 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002948 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002949 ERROR("DEPRECATED_INCLUDE",
2950 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002951 }
2952 }
2953
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002954# don't use deprecated functions
2955 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002956 if ($line =~ /\b$func\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002957 ERROR("DEPRECATED_FUNCTION",
2958 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002959 }
2960 }
2961
2962# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002963 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2964 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002965 WARN("VOLATILE",
2966 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002967 }
2968
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002969# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002970 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002971 CHK("REDUNDANT_CODE",
2972 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002973 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002974 }
2975
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002976# check for needless kfree() checks
2977 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2978 my $expr = $1;
2979 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002980 WARN("NEEDLESS_KFREE",
2981 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002982 }
2983 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002984# check for needless usb_free_urb() checks
2985 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2986 my $expr = $1;
2987 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002988 WARN("NEEDLESS_USB_FREE_URB",
2989 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002990 }
2991 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002992
Patrick Pannuto1a15a252010-08-09 17:21:01 -07002993# prefer usleep_range over udelay
2994 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
2995 # ignore udelay's < 10, however
2996 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002997 CHK("USLEEP_RANGE",
2998 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07002999 }
3000 }
3001
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003002# warn about unexpectedly long msleep's
3003 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3004 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003005 WARN("MSLEEP",
3006 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003007 }
3008 }
3009
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003010# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003011# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003012# print "#ifdef in C files should be avoided\n";
3013# print "$herecurr";
3014# $clean = 0;
3015# }
3016
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003017# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003018 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003019 ERROR("SPACING",
3020 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003021 }
3022
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003023# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003024 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3025 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003026 my $which = $1;
3027 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003028 CHK("UNCOMMENTED_DEFINITION",
3029 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003030 }
3031 }
3032# check for memory barriers without a comment.
3033 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3034 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003035 CHK("MEMORY_BARRIER",
3036 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003037 }
3038 }
3039# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003040 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003041 CHK("ARCH_DEFINES",
3042 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003043 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003044
Tobias Klauserd4977c72010-05-24 14:33:30 -07003045# Check that the storage class is at the beginning of a declaration
3046 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003047 WARN("STORAGE_CLASS",
3048 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003049 }
3050
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003051# check the location of the inline attribute, that it is between
3052# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003053 if ($line =~ /\b$Type\s+$Inline\b/ ||
3054 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003055 ERROR("INLINE_LOCATION",
3056 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003057 }
3058
Andy Whitcroft8905a672007-11-28 16:21:06 -08003059# Check for __inline__ and __inline, prefer inline
3060 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003061 WARN("INLINE",
3062 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003063 }
3064
Joe Perches3d130fd2011-01-12 17:00:00 -08003065# Check for __attribute__ packed, prefer __packed
3066 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003067 WARN("PREFER_PACKED",
3068 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003069 }
3070
Joe Perches39b7e282011-07-25 17:13:24 -07003071# Check for __attribute__ aligned, prefer __aligned
3072 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003073 WARN("PREFER_ALIGNED",
3074 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003075 }
3076
Joe Perches8f53a9b2010-03-05 13:43:48 -08003077# check for sizeof(&)
3078 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003079 WARN("SIZEOF_ADDRESS",
3080 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003081 }
3082
Joe Perches428e2fd2011-05-24 17:13:39 -07003083# check for line continuations in quoted strings with odd counts of "
3084 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003085 WARN("LINE_CONTINUATIONS",
3086 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003087 }
3088
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003089# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003090 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003091 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003092 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003093 my $function_name = $1;
3094 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003095
3096 my $s = $stat;
3097 if (defined $cond) {
3098 substr($s, 0, length($cond), '');
3099 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003100 if ($s =~ /^\s*;/ &&
3101 $function_name ne 'uninitialized_var')
3102 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003103 WARN("AVOID_EXTERNS",
3104 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003105 }
3106
3107 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003108 WARN("FUNCTION_ARGUMENTS",
3109 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003110 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003111
3112 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3113 $stat =~ /^.\s*extern\s+/)
3114 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003115 WARN("AVOID_EXTERNS",
3116 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003117 }
3118
3119# checks for new __setup's
3120 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3121 my $name = $1;
3122
3123 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003124 CHK("UNDOCUMENTED_SETUP",
3125 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003126 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003127 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003128
3129# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003130 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003131 WARN("UNNECESSARY_CASTS",
3132 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003133 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003134
Joe Perchescaf2a542011-01-12 16:59:56 -08003135# check for multiple semicolons
3136 if ($line =~ /;\s*;\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003137 WARN("ONE_SEMICOLON",
3138 "Statements terminations use 1 semicolon\n" . $herecurr);
Joe Perchescaf2a542011-01-12 16:59:56 -08003139 }
3140
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003141# check for gcc specific __FUNCTION__
3142 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003143 WARN("USE_FUNC",
3144 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003145 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003146
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003147# check for semaphores initialized locked
3148 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003149 WARN("CONSIDER_COMPLETION",
3150 "consider using a completion\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003151
Andy Whitcroft773647a2008-03-28 14:15:58 -07003152 }
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -07003153# recommend kstrto* over simple_strto*
Andy Whitcroft773647a2008-03-28 14:15:58 -07003154 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003155 WARN("CONSIDER_KSTRTO",
3156 "consider using kstrto* in preference to simple_$1\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003157 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07003158# check for __initcall(), use device_initcall() explicitly please
3159 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003160 WARN("USE_DEVICE_INITCALL",
3161 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003162 }
Emese Revfy79404842010-03-05 13:43:53 -08003163# check for various ops structs, ensure they are const.
3164 my $struct_ops = qr{acpi_dock_ops|
3165 address_space_operations|
3166 backlight_ops|
3167 block_device_operations|
3168 dentry_operations|
3169 dev_pm_ops|
3170 dma_map_ops|
3171 extent_io_ops|
3172 file_lock_operations|
3173 file_operations|
3174 hv_ops|
3175 ide_dma_ops|
3176 intel_dvo_dev_ops|
3177 item_operations|
3178 iwl_ops|
3179 kgdb_arch|
3180 kgdb_io|
3181 kset_uevent_ops|
3182 lock_manager_operations|
3183 microcode_ops|
3184 mtrr_ops|
3185 neigh_ops|
3186 nlmsvc_binding|
3187 pci_raw_ops|
3188 pipe_buf_operations|
3189 platform_hibernation_ops|
3190 platform_suspend_ops|
3191 proto_ops|
3192 rpc_pipe_ops|
3193 seq_operations|
3194 snd_ac97_build_ops|
3195 soc_pcmcia_socket_ops|
3196 stacktrace_ops|
3197 sysfs_ops|
3198 tty_operations|
3199 usb_mon_operations|
3200 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003201 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003202 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003203 WARN("CONST_STRUCT",
3204 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003205 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003206 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003207
3208# use of NR_CPUS is usually wrong
3209# ignore definitions of NR_CPUS and usage to define arrays as likely right
3210 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003211 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3212 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003213 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3214 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3215 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003216 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003217 WARN("NR_CPUS",
3218 "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 -07003219 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003220
3221# check for %L{u,d,i} in strings
3222 my $string;
3223 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3224 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003225 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003226 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003227 WARN("PRINTF_L",
3228 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003229 last;
3230 }
3231 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003232
3233# whine mightly about in_atomic
3234 if ($line =~ /\bin_atomic\s*\(/) {
3235 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003236 ERROR("IN_ATOMIC",
3237 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003238 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003239 WARN("IN_ATOMIC",
3240 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003241 }
3242 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003243
3244# check for lockdep_set_novalidate_class
3245 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3246 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3247 if ($realfile !~ m@^kernel/lockdep@ &&
3248 $realfile !~ m@^include/linux/lockdep@ &&
3249 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003250 ERROR("LOCKDEP",
3251 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003252 }
3253 }
Dave Jones88f88312011-01-12 16:59:59 -08003254
3255 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3256 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003257 WARN("EXPORTED_WORLD_WRITABLE",
3258 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003259 }
Dave Jones309c00c2011-03-22 16:34:44 -07003260
3261 # Check for memset with swapped arguments
3262 if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003263 ERROR("MEMSET",
3264 "memset size is 3rd argument, not the second.\n" . $herecurr);
Dave Jones309c00c2011-03-22 16:34:44 -07003265 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003266 }
3267
3268 # If we have no input at all, then there is nothing to report on
3269 # so just keep quiet.
3270 if ($#rawlines == -1) {
3271 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003272 }
3273
Andy Whitcroft8905a672007-11-28 16:21:06 -08003274 # In mailback mode only produce a report in the negative, for
3275 # things that appear to be patches.
3276 if ($mailback && ($clean == 1 || !$is_patch)) {
3277 exit(0);
3278 }
3279
3280 # This is not a patch, and we are are in 'no-patch' mode so
3281 # just keep quiet.
3282 if (!$chk_patch && !$is_patch) {
3283 exit(0);
3284 }
3285
3286 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003287 ERROR("NOT_UNIFIED_DIFF",
3288 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003289 }
3290 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003291 ERROR("MISSING_SIGN_OFF",
3292 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003293 }
3294
Andy Whitcroft8905a672007-11-28 16:21:06 -08003295 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003296 if ($summary && !($clean == 1 && $quiet == 1)) {
3297 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003298 print "total: $cnt_error errors, $cnt_warn warnings, " .
3299 (($check)? "$cnt_chk checks, " : "") .
3300 "$cnt_lines lines checked\n";
3301 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003302 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003303
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003304 if ($quiet == 0) {
3305 # If there were whitespace errors which cleanpatch can fix
3306 # then suggest that.
3307 if ($rpt_cleaners) {
3308 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3309 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003310 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003311 }
3312 }
3313
Joe Perches000d1cc12011-07-25 17:13:25 -07003314 if (keys %ignore_type) {
3315 print "NOTE: Ignored message types:";
3316 foreach my $ignore (sort keys %ignore_type) {
3317 print " $ignore";
3318 }
3319 print "\n";
3320 print "\n" if ($quiet == 0);
3321 }
3322
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003323 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003324 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003325 }
3326 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003327 print << "EOM";
3328$vname has style problems, please review.
3329
3330If any of these errors are false positives, please report
3331them to the maintainer, see CHECKPATCH in MAINTAINERS.
3332EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003333 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003334
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003335 return $clean;
3336}