blob: b954de58304fc7387d947ac7c6d06374009536a4 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
Joe Perches000d1cc12011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070029my $show_types = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080031my %debug;
Joe Perches000d1cc12011-07-25 17:13:25 -070032my %ignore_type = ();
33my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070034my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070035my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080036my $max_line_length = 80;
Hannes Eder77f5b102009-09-21 17:04:37 -070037
38sub help {
39 my ($exitcode) = @_;
40
41 print << "EOM";
42Usage: $P [OPTION]... [FILE]...
43Version: $V
44
45Options:
46 -q, --quiet quiet
47 --no-tree run without a kernel tree
48 --no-signoff do not check for 'Signed-off-by' line
49 --patch treat FILE as patchfile (default)
50 --emacs emacs compile window format
51 --terse one line per report
52 -f, --file treat FILE as regular source file
53 --subjective, --strict enable more subjective tests
Joe Perches000d1cc12011-07-25 17:13:25 -070054 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080055 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070056 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070057 --root=PATH PATH to the kernel tree root
58 --no-summary suppress the per-file summary
59 --mailback only produce a report in case of warnings/errors
60 --summary-file include the filename in summary
61 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
62 'values', 'possible', 'type', and 'attr' (default
63 is all off)
64 --test-only=WORD report only warnings/errors containing WORD
65 literally
66 -h, --help, --version display this help and exit
67
68When FILE is - read standard input.
69EOM
70
71 exit($exitcode);
72}
73
Joe Perches000d1cc12011-07-25 17:13:25 -070074my $conf = which_conf($configuration_file);
75if (-f $conf) {
76 my @conf_args;
77 open(my $conffile, '<', "$conf")
78 or warn "$P: Can't find a readable $configuration_file file $!\n";
79
80 while (<$conffile>) {
81 my $line = $_;
82
83 $line =~ s/\s*\n?$//g;
84 $line =~ s/^\s*//g;
85 $line =~ s/\s+/ /g;
86
87 next if ($line =~ m/^\s*#/);
88 next if ($line =~ m/^\s*$/);
89
90 my @words = split(" ", $line);
91 foreach my $word (@words) {
92 last if ($word =~ m/^#/);
93 push (@conf_args, $word);
94 }
95 }
96 close($conffile);
97 unshift(@ARGV, @conf_args) if @conf_args;
98}
99
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700100GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700101 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700102 'tree!' => \$tree,
103 'signoff!' => \$chk_signoff,
104 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700105 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800106 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700107 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700108 'subjective!' => \$check,
109 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700110 'ignore=s' => \@ignore,
111 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800112 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700113 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800114 'summary!' => \$summary,
115 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800116 'summary-file!' => \$summary_file,
117
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800118 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700119 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700120 'h|help' => \$help,
121 'version' => \$help
122) or help(1);
123
124help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700125
126my $exit = 0;
127
128if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700129 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700130 exit(1);
131}
132
Joe Perches000d1cc12011-07-25 17:13:25 -0700133@ignore = split(/,/, join(',',@ignore));
134foreach my $word (@ignore) {
135 $word =~ s/\s*\n?$//g;
136 $word =~ s/^\s*//g;
137 $word =~ s/\s+/ /g;
138 $word =~ tr/[a-z]/[A-Z]/;
139
140 next if ($word =~ m/^\s*#/);
141 next if ($word =~ m/^\s*$/);
142
143 $ignore_type{$word}++;
144}
145
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800146my $dbg_values = 0;
147my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700148my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700149my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800150for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800151 ## no critic
152 eval "\${dbg_$key} = '$debug{$key}';";
153 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800154}
155
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700156my $rpt_cleaners = 0;
157
Andy Whitcroft8905a672007-11-28 16:21:06 -0800158if ($terse) {
159 $emacs = 1;
160 $quiet++;
161}
162
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700163if ($tree) {
164 if (defined $root) {
165 if (!top_of_kernel_tree($root)) {
166 die "$P: $root: --root does not point at a valid tree\n";
167 }
168 } else {
169 if (top_of_kernel_tree('.')) {
170 $root = '.';
171 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
172 top_of_kernel_tree($1)) {
173 $root = $1;
174 }
175 }
176
177 if (!defined $root) {
178 print "Must be run from the top-level dir. of a kernel tree\n";
179 exit(2);
180 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700181}
182
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700183my $emitted_corrupt = 0;
184
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700185our $Ident = qr{
186 [A-Za-z_][A-Za-z\d_]*
187 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
188 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700189our $Storage = qr{extern|static|asmlinkage};
190our $Sparse = qr{
191 __user|
192 __kernel|
193 __force|
194 __iomem|
195 __must_check|
196 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800197 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700198 __ref|
199 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800201
202# Notes to $Attribute:
203# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700204our $Attribute = qr{
205 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700206 __percpu|
207 __nocast|
208 __safe|
209 __bitwise__|
210 __packed__|
211 __packed2__|
212 __naked|
213 __maybe_unused|
214 __always_unused|
215 __noreturn|
216 __used|
217 __cold|
218 __noclone|
219 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700220 __read_mostly|
221 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800222 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700223 ____cacheline_aligned|
224 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800225 ____cacheline_internodealigned_in_smp|
226 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700227 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700228our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700229our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700230our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
231our $Lval = qr{$Ident(?:$Member)*};
232
Joe Perches326b1ff2013-02-04 14:28:51 -0800233our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
234our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
235our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800236our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800237our $Constant = qr{$Float|(?i)(?:0x[0-9a-f]+|[0-9]+)[ul]*};
238our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800239our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700240our $Operators = qr{
241 <=|>=|==|!=|
242 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800243 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700244 }x;
245
Andy Whitcroft8905a672007-11-28 16:21:06 -0800246our $NonptrType;
247our $Type;
248our $Declare;
249
Joe Perches15662b32011-10-31 17:13:12 -0700250our $NON_ASCII_UTF8 = qr{
251 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700252 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
253 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
254 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
255 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
256 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
257 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
258}x;
259
Joe Perches15662b32011-10-31 17:13:12 -0700260our $UTF8 = qr{
261 [\x09\x0A\x0D\x20-\x7E] # ASCII
262 | $NON_ASCII_UTF8
263}x;
264
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700265our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700266 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700267 atomic_t
268)};
269
Joe Perches691e6692010-03-05 13:43:51 -0800270our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700271 printk(?:_ratelimited|_once|)|
272 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
273 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700274 panic|
275 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800276)};
277
Joe Perches20112472011-07-25 17:13:23 -0700278our $signature_tags = qr{(?xi:
279 Signed-off-by:|
280 Acked-by:|
281 Tested-by:|
282 Reviewed-by:|
283 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700284 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700285 To:|
286 Cc:
287)};
288
Andy Whitcroft8905a672007-11-28 16:21:06 -0800289our @typeList = (
290 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700291 qr{(?:unsigned\s+)?char},
292 qr{(?:unsigned\s+)?short},
293 qr{(?:unsigned\s+)?int},
294 qr{(?:unsigned\s+)?long},
295 qr{(?:unsigned\s+)?long\s+int},
296 qr{(?:unsigned\s+)?long\s+long},
297 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800298 qr{unsigned},
299 qr{float},
300 qr{double},
301 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800302 qr{struct\s+$Ident},
303 qr{union\s+$Ident},
304 qr{enum\s+$Ident},
305 qr{${Ident}_t},
306 qr{${Ident}_handler},
307 qr{${Ident}_handler_fn},
308);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700309our @modifierList = (
310 qr{fastcall},
311);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800312
Wolfram Sang7840a942010-08-09 17:20:57 -0700313our $allowed_asm_includes = qr{(?x:
314 irq|
315 memory
316)};
317# memory.h: ARM has a custom one
318
Andy Whitcroft8905a672007-11-28 16:21:06 -0800319sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700320 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
321 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700322 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800323 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700324 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800325 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800326 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700327 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700328 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800329 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700330 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800331 }x;
332 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700333 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700334 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700335 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800336 }x;
337 $Declare = qr{(?:$Storage\s+)?$Type};
338}
339build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700340
Joe Perches7d2367a2011-07-25 17:13:22 -0700341
342our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700343
344# Using $balanced_parens, $LvalOrFunc, or $FuncArg
345# requires at least perl version v5.10.0
346# Any use must be runtime checked with $^V
347
348our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
349our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800350our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700351
352sub deparenthesize {
353 my ($string) = @_;
354 return "" if (!defined($string));
355 $string =~ s@^\s*\(\s*@@g;
356 $string =~ s@\s*\)\s*$@@g;
357 $string =~ s@\s+@ @g;
358 return $string;
359}
360
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700361$chk_signoff = 0 if ($file);
362
Andy Whitcroft00df3442007-06-08 13:47:06 -0700363my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800364my @lines = ();
365my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700366for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800367 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700368 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800369 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700370 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800371 } elsif ($filename eq '-') {
372 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700373 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800374 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700375 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700376 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800377 if ($filename eq '-') {
378 $vname = 'Your patch';
379 } else {
380 $vname = $filename;
381 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800382 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700383 chomp;
384 push(@rawlines, $_);
385 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800386 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800387 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700388 $exit = 1;
389 }
390 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800391 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700392}
393
394exit($exit);
395
396sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700397 my ($root) = @_;
398
399 my @tree_check = (
400 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
401 "README", "Documentation", "arch", "include", "drivers",
402 "fs", "init", "ipc", "kernel", "lib", "scripts",
403 );
404
405 foreach my $check (@tree_check) {
406 if (! -e $root . '/' . $check) {
407 return 0;
408 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700409 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700410 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700411}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700412
Joe Perches20112472011-07-25 17:13:23 -0700413sub parse_email {
414 my ($formatted_email) = @_;
415
416 my $name = "";
417 my $address = "";
418 my $comment = "";
419
420 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
421 $name = $1;
422 $address = $2;
423 $comment = $3 if defined $3;
424 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
425 $address = $1;
426 $comment = $2 if defined $2;
427 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
428 $address = $1;
429 $comment = $2 if defined $2;
430 $formatted_email =~ s/$address.*$//;
431 $name = $formatted_email;
432 $name =~ s/^\s+|\s+$//g;
433 $name =~ s/^\"|\"$//g;
434 # If there's a name left after stripping spaces and
435 # leading quotes, and the address doesn't have both
436 # leading and trailing angle brackets, the address
437 # is invalid. ie:
438 # "joe smith joe@smith.com" bad
439 # "joe smith <joe@smith.com" bad
440 if ($name ne "" && $address !~ /^<[^>]+>$/) {
441 $name = "";
442 $address = "";
443 $comment = "";
444 }
445 }
446
447 $name =~ s/^\s+|\s+$//g;
448 $name =~ s/^\"|\"$//g;
449 $address =~ s/^\s+|\s+$//g;
450 $address =~ s/^\<|\>$//g;
451
452 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
453 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
454 $name = "\"$name\"";
455 }
456
457 return ($name, $address, $comment);
458}
459
460sub format_email {
461 my ($name, $address) = @_;
462
463 my $formatted_email;
464
465 $name =~ s/^\s+|\s+$//g;
466 $name =~ s/^\"|\"$//g;
467 $address =~ s/^\s+|\s+$//g;
468
469 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
470 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
471 $name = "\"$name\"";
472 }
473
474 if ("$name" eq "") {
475 $formatted_email = "$address";
476 } else {
477 $formatted_email = "$name <$address>";
478 }
479
480 return $formatted_email;
481}
482
Joe Perches000d1cc12011-07-25 17:13:25 -0700483sub which_conf {
484 my ($conf) = @_;
485
486 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
487 if (-e "$path/$conf") {
488 return "$path/$conf";
489 }
490 }
491
492 return "";
493}
494
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700495sub expand_tabs {
496 my ($str) = @_;
497
498 my $res = '';
499 my $n = 0;
500 for my $c (split(//, $str)) {
501 if ($c eq "\t") {
502 $res .= ' ';
503 $n++;
504 for (; ($n % 8) != 0; $n++) {
505 $res .= ' ';
506 }
507 next;
508 }
509 $res .= $c;
510 $n++;
511 }
512
513 return $res;
514}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700515sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700516 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700517 return $res;
518}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700519
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700520sub line_stats {
521 my ($line) = @_;
522
523 # Drop the diff line leader and expand tabs
524 $line =~ s/^.//;
525 $line = expand_tabs($line);
526
527 # Pick the indent from the front of the line.
528 my ($white) = ($line =~ /^(\s*)/);
529
530 return (length($line), length($white));
531}
532
Andy Whitcroft773647a2008-03-28 14:15:58 -0700533my $sanitise_quote = '';
534
535sub sanitise_line_reset {
536 my ($in_comment) = @_;
537
538 if ($in_comment) {
539 $sanitise_quote = '*/';
540 } else {
541 $sanitise_quote = '';
542 }
543}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700544sub sanitise_line {
545 my ($line) = @_;
546
547 my $res = '';
548 my $l = '';
549
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800550 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700551 my $off = 0;
552 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700553
Andy Whitcroft773647a2008-03-28 14:15:58 -0700554 # Always copy over the diff marker.
555 $res = substr($line, 0, 1);
556
557 for ($off = 1; $off < length($line); $off++) {
558 $c = substr($line, $off, 1);
559
560 # Comments we are wacking completly including the begin
561 # and end, all to $;.
562 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
563 $sanitise_quote = '*/';
564
565 substr($res, $off, 2, "$;$;");
566 $off++;
567 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800568 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700569 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700570 $sanitise_quote = '';
571 substr($res, $off, 2, "$;$;");
572 $off++;
573 next;
574 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700575 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
576 $sanitise_quote = '//';
577
578 substr($res, $off, 2, $sanitise_quote);
579 $off++;
580 next;
581 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700582
583 # A \ in a string means ignore the next character.
584 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
585 $c eq "\\") {
586 substr($res, $off, 2, 'XX');
587 $off++;
588 next;
589 }
590 # Regular quotes.
591 if ($c eq "'" || $c eq '"') {
592 if ($sanitise_quote eq '') {
593 $sanitise_quote = $c;
594
595 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700596 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700597 } elsif ($sanitise_quote eq $c) {
598 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700599 }
600 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700601
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800602 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700603 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
604 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700605 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
606 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700607 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
608 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700609 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700610 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700611 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800612 }
613
Daniel Walker113f04a2009-09-21 17:04:35 -0700614 if ($sanitise_quote eq '//') {
615 $sanitise_quote = '';
616 }
617
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800618 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700619 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800620 my $clean = 'X' x length($1);
621 $res =~ s@\<.*\>@<$clean>@;
622
623 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700624 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800625 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700626 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800627 }
628
Andy Whitcroft00df3442007-06-08 13:47:06 -0700629 return $res;
630}
631
Joe Perchesa6962d72013-04-29 16:18:13 -0700632sub get_quoted_string {
633 my ($line, $rawline) = @_;
634
635 return "" if ($line !~ m/(\"[X]+\")/g);
636 return substr($rawline, $-[0], $+[0] - $-[0]);
637}
638
Andy Whitcroft8905a672007-11-28 16:21:06 -0800639sub ctx_statement_block {
640 my ($linenr, $remain, $off) = @_;
641 my $line = $linenr - 1;
642 my $blk = '';
643 my $soff = $off;
644 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700645 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800646
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800647 my $loff = 0;
648
Andy Whitcroft8905a672007-11-28 16:21:06 -0800649 my $type = '';
650 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800651 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800652 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800653 my $c;
654 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800655
656 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800657 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800658 @stack = (['', 0]) if ($#stack == -1);
659
Andy Whitcroft773647a2008-03-28 14:15:58 -0700660 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800661 # If we are about to drop off the end, pull in more
662 # context.
663 if ($off >= $len) {
664 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700665 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800666 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800667 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800668 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800669 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800670 $len = length($blk);
671 $line++;
672 last;
673 }
674 # Bail if there is no further context.
675 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800676 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800677 last;
678 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800679 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
680 $level++;
681 $type = '#';
682 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800683 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800684 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800685 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800686 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800687
Andy Whitcroft773647a2008-03-28 14:15:58 -0700688 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800689
690 # Handle nested #if/#else.
691 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
692 push(@stack, [ $type, $level ]);
693 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
694 ($type, $level) = @{$stack[$#stack - 1]};
695 } elsif ($remainder =~ /^#\s*endif\b/) {
696 ($type, $level) = @{pop(@stack)};
697 }
698
Andy Whitcroft8905a672007-11-28 16:21:06 -0800699 # Statement ends at the ';' or a close '}' at the
700 # outermost level.
701 if ($level == 0 && $c eq ';') {
702 last;
703 }
704
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800705 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700706 if ($level == 0 && $coff_set == 0 &&
707 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
708 $remainder =~ /^(else)(?:\s|{)/ &&
709 $remainder !~ /^else\s+if\b/) {
710 $coff = $off + length($1) - 1;
711 $coff_set = 1;
712 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
713 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800714 }
715
Andy Whitcroft8905a672007-11-28 16:21:06 -0800716 if (($type eq '' || $type eq '(') && $c eq '(') {
717 $level++;
718 $type = '(';
719 }
720 if ($type eq '(' && $c eq ')') {
721 $level--;
722 $type = ($level != 0)? '(' : '';
723
724 if ($level == 0 && $coff < $soff) {
725 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700726 $coff_set = 1;
727 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800728 }
729 }
730 if (($type eq '' || $type eq '{') && $c eq '{') {
731 $level++;
732 $type = '{';
733 }
734 if ($type eq '{' && $c eq '}') {
735 $level--;
736 $type = ($level != 0)? '{' : '';
737
738 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700739 if (substr($blk, $off + 1, 1) eq ';') {
740 $off++;
741 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800742 last;
743 }
744 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800745 # Preprocessor commands end at the newline unless escaped.
746 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
747 $level--;
748 $type = '';
749 $off++;
750 last;
751 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800752 $off++;
753 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700754 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800755 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700756 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800757 $line++;
758 $remain--;
759 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800760
761 my $statement = substr($blk, $soff, $off - $soff + 1);
762 my $condition = substr($blk, $soff, $coff - $soff + 1);
763
764 #warn "STATEMENT<$statement>\n";
765 #warn "CONDITION<$condition>\n";
766
Andy Whitcroft773647a2008-03-28 14:15:58 -0700767 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800768
769 return ($statement, $condition,
770 $line, $remain + 1, $off - $loff + 1, $level);
771}
772
Andy Whitcroftcf655042008-03-04 14:28:20 -0800773sub statement_lines {
774 my ($stmt) = @_;
775
776 # Strip the diff line prefixes and rip blank lines at start and end.
777 $stmt =~ s/(^|\n)./$1/g;
778 $stmt =~ s/^\s*//;
779 $stmt =~ s/\s*$//;
780
781 my @stmt_lines = ($stmt =~ /\n/g);
782
783 return $#stmt_lines + 2;
784}
785
786sub statement_rawlines {
787 my ($stmt) = @_;
788
789 my @stmt_lines = ($stmt =~ /\n/g);
790
791 return $#stmt_lines + 2;
792}
793
794sub statement_block_size {
795 my ($stmt) = @_;
796
797 $stmt =~ s/(^|\n)./$1/g;
798 $stmt =~ s/^\s*{//;
799 $stmt =~ s/}\s*$//;
800 $stmt =~ s/^\s*//;
801 $stmt =~ s/\s*$//;
802
803 my @stmt_lines = ($stmt =~ /\n/g);
804 my @stmt_statements = ($stmt =~ /;/g);
805
806 my $stmt_lines = $#stmt_lines + 2;
807 my $stmt_statements = $#stmt_statements + 1;
808
809 if ($stmt_lines > $stmt_statements) {
810 return $stmt_lines;
811 } else {
812 return $stmt_statements;
813 }
814}
815
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800816sub ctx_statement_full {
817 my ($linenr, $remain, $off) = @_;
818 my ($statement, $condition, $level);
819
820 my (@chunks);
821
Andy Whitcroftcf655042008-03-04 14:28:20 -0800822 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800823 ($statement, $condition, $linenr, $remain, $off, $level) =
824 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700825 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800826 push(@chunks, [ $condition, $statement ]);
827 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
828 return ($level, $linenr, @chunks);
829 }
830
831 # Pull in the following conditional/block pairs and see if they
832 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800833 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800834 ($statement, $condition, $linenr, $remain, $off, $level) =
835 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800836 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700837 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800838 #print "C: push\n";
839 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800840 }
841
842 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800843}
844
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700845sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700846 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700847 my $line;
848 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700849 my $blk = '';
850 my @o;
851 my @c;
852 my @res = ();
853
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700854 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800855 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700856 for ($line = $start; $remain > 0; $line++) {
857 next if ($rawlines[$line] =~ /^-/);
858 $remain--;
859
860 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800861
862 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700863 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800864 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700865 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800866 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700867 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800868 $level = pop(@stack);
869 }
870
Andy Whitcroft01464f32010-10-26 14:23:19 -0700871 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700872 ##print "C<$c>L<$level><$open$close>O<$off>\n";
873 if ($off > 0) {
874 $off--;
875 next;
876 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700877
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700878 if ($c eq $close && $level > 0) {
879 $level--;
880 last if ($level == 0);
881 } elsif ($c eq $open) {
882 $level++;
883 }
884 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700885
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700886 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700887 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700888 }
889
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700890 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700891 }
892
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700893 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700894}
895sub ctx_block_outer {
896 my ($linenr, $remain) = @_;
897
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700898 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
899 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700900}
901sub ctx_block {
902 my ($linenr, $remain) = @_;
903
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700904 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
905 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700906}
907sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700908 my ($linenr, $remain, $off) = @_;
909
910 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
911 return @r;
912}
913sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700914 my ($linenr, $remain) = @_;
915
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700916 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700917}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700918sub ctx_statement_level {
919 my ($linenr, $remain, $off) = @_;
920
921 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
922}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700923
924sub ctx_locate_comment {
925 my ($first_line, $end_line) = @_;
926
927 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700928 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700929 return $current_comment if (defined $current_comment);
930
931 # Look through the context and try and figure out if there is a
932 # comment.
933 my $in_comment = 0;
934 $current_comment = '';
935 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700936 my $line = $rawlines[$linenr - 1];
937 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700938 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
939 $in_comment = 1;
940 }
941 if ($line =~ m@/\*@) {
942 $in_comment = 1;
943 }
944 if (!$in_comment && $current_comment ne '') {
945 $current_comment = '';
946 }
947 $current_comment .= $line . "\n" if ($in_comment);
948 if ($line =~ m@\*/@) {
949 $in_comment = 0;
950 }
951 }
952
953 chomp($current_comment);
954 return($current_comment);
955}
956sub ctx_has_comment {
957 my ($first_line, $end_line) = @_;
958 my $cmt = ctx_locate_comment($first_line, $end_line);
959
Andy Whitcroft00df3442007-06-08 13:47:06 -0700960 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700961 ##print "CMMT: $cmt\n";
962
963 return ($cmt ne '');
964}
965
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700966sub raw_line {
967 my ($linenr, $cnt) = @_;
968
969 my $offset = $linenr - 1;
970 $cnt++;
971
972 my $line;
973 while ($cnt) {
974 $line = $rawlines[$offset++];
975 next if (defined($line) && $line =~ /^-/);
976 $cnt--;
977 }
978
979 return $line;
980}
981
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700982sub cat_vet {
983 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700984 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700985
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700986 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700987 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
988 $res .= $1;
989 if ($2 ne '') {
990 $coded = sprintf("^%c", unpack('C', $2) + 64);
991 $res .= $coded;
992 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700993 }
994 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700995
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700996 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700997}
998
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800999my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001000my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001001my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001002my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001003
1004sub annotate_reset {
1005 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001006 $av_pending = '_';
1007 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001008 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001009}
1010
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001011sub annotate_values {
1012 my ($stream, $type) = @_;
1013
1014 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001015 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001016 my $cur = $stream;
1017
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001018 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001019
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001020 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001021 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001022 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001023 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001024 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001025 print "WS($1)\n" if ($dbg_values > 1);
1026 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001027 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001028 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001029 }
1030
Florian Micklerc023e4732011-01-12 16:59:58 -08001031 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001032 print "CAST($1)\n" if ($dbg_values > 1);
1033 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001034 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001035
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001036 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001037 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001038 $type = 'T';
1039
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001040 } elsif ($cur =~ /^($Modifier)\s*/) {
1041 print "MODIFIER($1)\n" if ($dbg_values > 1);
1042 $type = 'T';
1043
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001044 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001045 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001046 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001047 push(@av_paren_type, $type);
1048 if ($2 ne '') {
1049 $av_pending = 'N';
1050 }
1051 $type = 'E';
1052
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001053 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001054 print "UNDEF($1)\n" if ($dbg_values > 1);
1055 $av_preprocessor = 1;
1056 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001057
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001058 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001059 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001060 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001061
1062 push(@av_paren_type, $type);
1063 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001064 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001065
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001066 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001067 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1068 $av_preprocessor = 1;
1069
1070 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1071
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001072 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001073
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001074 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001075 print "PRE_END($1)\n" if ($dbg_values > 1);
1076
1077 $av_preprocessor = 1;
1078
1079 # Assume all arms of the conditional end as this
1080 # one does, and continue as if the #endif was not here.
1081 pop(@av_paren_type);
1082 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001083 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001084
1085 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001087
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001088 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1089 print "ATTR($1)\n" if ($dbg_values > 1);
1090 $av_pending = $type;
1091 $type = 'N';
1092
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001093 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001094 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001095 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001096 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001097 }
1098 $type = 'N';
1099
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001100 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001101 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001102 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001103 $type = 'N';
1104
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001105 } elsif ($cur =~/^(case)/o) {
1106 print "CASE($1)\n" if ($dbg_values > 1);
1107 $av_pend_colon = 'C';
1108 $type = 'N';
1109
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001110 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001111 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001112 $type = 'N';
1113
1114 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001115 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001116 push(@av_paren_type, $av_pending);
1117 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001118 $type = 'N';
1119
1120 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001121 my $new_type = pop(@av_paren_type);
1122 if ($new_type ne '_') {
1123 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001124 print "PAREN('$1') -> $type\n"
1125 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001126 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001127 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001128 }
1129
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001130 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001131 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001132 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001133 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001134
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001135 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1136 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001137 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001138 } elsif ($type eq 'E') {
1139 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001140 }
1141 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1142 $type = 'V';
1143
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001144 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001145 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001146 $type = 'V';
1147
1148 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001149 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001150 $type = 'N';
1151
Andy Whitcroftcf655042008-03-04 14:28:20 -08001152 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001153 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001154 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001155 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001156
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001157 } elsif ($cur =~/^(,)/) {
1158 print "COMMA($1)\n" if ($dbg_values > 1);
1159 $type = 'C';
1160
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001161 } elsif ($cur =~ /^(\?)/o) {
1162 print "QUESTION($1)\n" if ($dbg_values > 1);
1163 $type = 'N';
1164
1165 } elsif ($cur =~ /^(:)/o) {
1166 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1167
1168 substr($var, length($res), 1, $av_pend_colon);
1169 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1170 $type = 'E';
1171 } else {
1172 $type = 'N';
1173 }
1174 $av_pend_colon = 'O';
1175
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001176 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001177 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001178 $type = 'N';
1179
Andy Whitcroft0d413862008-10-15 22:02:16 -07001180 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001181 my $variant;
1182
1183 print "OPV($1)\n" if ($dbg_values > 1);
1184 if ($type eq 'V') {
1185 $variant = 'B';
1186 } else {
1187 $variant = 'U';
1188 }
1189
1190 substr($var, length($res), 1, $variant);
1191 $type = 'N';
1192
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001194 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001195 if ($1 ne '++' && $1 ne '--') {
1196 $type = 'N';
1197 }
1198
1199 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001200 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001201 }
1202 if (defined $1) {
1203 $cur = substr($cur, length($1));
1204 $res .= $type x length($1);
1205 }
1206 }
1207
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001208 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001209}
1210
Andy Whitcroft8905a672007-11-28 16:21:06 -08001211sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001212 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001213 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001214 ^(?:
1215 $Modifier|
1216 $Storage|
1217 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001218 DEFINE_\S+
1219 )$|
1220 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001221 goto|
1222 return|
1223 case|
1224 else|
1225 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001226 do|
1227 \#|
1228 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001229 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001230 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001231 )}x;
1232 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1233 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001234 # Check for modifiers.
1235 $possible =~ s/\s*$Storage\s*//g;
1236 $possible =~ s/\s*$Sparse\s*//g;
1237 if ($possible =~ /^\s*$/) {
1238
1239 } elsif ($possible =~ /\s/) {
1240 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001241 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001242 if ($modifier !~ $notPermitted) {
1243 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1244 push(@modifierList, $modifier);
1245 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001246 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001247
1248 } else {
1249 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1250 push(@typeList, $possible);
1251 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001252 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001253 } else {
1254 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001255 }
1256}
1257
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001258my $prefix = '';
1259
Joe Perches000d1cc12011-07-25 17:13:25 -07001260sub show_type {
1261 return !defined $ignore_type{$_[0]};
1262}
1263
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001264sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001265 if (!show_type($_[1]) ||
1266 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001267 return 0;
1268 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001269 my $line;
1270 if ($show_types) {
1271 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1272 } else {
1273 $line = "$prefix$_[0]: $_[2]\n";
1274 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001275 $line = (split('\n', $line))[0] . "\n" if ($terse);
1276
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001277 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001278
1279 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001280}
1281sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001282 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001283}
Joe Perches000d1cc12011-07-25 17:13:25 -07001284
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001285sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001286 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001287 our $clean = 0;
1288 our $cnt_error++;
1289 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001290}
1291sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001292 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001293 our $clean = 0;
1294 our $cnt_warn++;
1295 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001296}
1297sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001298 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001299 our $clean = 0;
1300 our $cnt_chk++;
1301 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001302}
1303
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001304sub check_absolute_file {
1305 my ($absolute, $herecurr) = @_;
1306 my $file = $absolute;
1307
1308 ##print "absolute<$absolute>\n";
1309
1310 # See if any suffix of this path is a path within the tree.
1311 while ($file =~ s@^[^/]*/@@) {
1312 if (-f "$root/$file") {
1313 ##print "file<$file>\n";
1314 last;
1315 }
1316 }
1317 if (! -f _) {
1318 return 0;
1319 }
1320
1321 # It is, so see if the prefix is acceptable.
1322 my $prefix = $absolute;
1323 substr($prefix, -length($file)) = '';
1324
1325 ##print "prefix<$prefix>\n";
1326 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001327 WARN("USE_RELATIVE_PATH",
1328 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001329 }
1330}
1331
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001332sub pos_last_openparen {
1333 my ($line) = @_;
1334
1335 my $pos = 0;
1336
1337 my $opens = $line =~ tr/\(/\(/;
1338 my $closes = $line =~ tr/\)/\)/;
1339
1340 my $last_openparen = 0;
1341
1342 if (($opens == 0) || ($closes >= $opens)) {
1343 return -1;
1344 }
1345
1346 my $len = length($line);
1347
1348 for ($pos = 0; $pos < $len; $pos++) {
1349 my $string = substr($line, $pos);
1350 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1351 $pos += length($1) - 1;
1352 } elsif (substr($line, $pos, 1) eq '(') {
1353 $last_openparen = $pos;
1354 } elsif (index($string, '(') == -1) {
1355 last;
1356 }
1357 }
1358
1359 return $last_openparen + 1;
1360}
1361
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001362sub process {
1363 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001364
1365 my $linenr=0;
1366 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001367 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001368 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001369 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001370
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001371 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001372 my $indent;
1373 my $previndent=0;
1374 my $stashindent=0;
1375
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001376 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001377 my $signoff = 0;
1378 my $is_patch = 0;
1379
Joe Perches15662b32011-10-31 17:13:12 -07001380 my $in_header_lines = 1;
1381 my $in_commit_log = 0; #Scanning lines before patch
1382
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001383 my $non_utf8_charset = 0;
1384
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001385 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001386 our $cnt_lines = 0;
1387 our $cnt_error = 0;
1388 our $cnt_warn = 0;
1389 our $cnt_chk = 0;
1390
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001391 # Trace the real file/line as we go.
1392 my $realfile = '';
1393 my $realline = 0;
1394 my $realcnt = 0;
1395 my $here = '';
1396 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001397 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001398 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001399 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001400
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001401 my $prev_values = 'E';
1402
1403 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001404 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001405 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001406 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001407 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001408
Joe Perches323c1262012-12-17 16:02:07 -08001409 my %camelcase = ();
1410
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001411 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001412 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001413 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001414 my @setup_docs = ();
1415 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001416
1417 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001418 my $line;
1419 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001420 $linenr++;
1421 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001422
Andy Whitcroft773647a2008-03-28 14:15:58 -07001423 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001424 $setup_docs = 0;
1425 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1426 $setup_docs = 1;
1427 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001428 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001429 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001430 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1431 $realline=$1-1;
1432 if (defined $2) {
1433 $realcnt=$3+1;
1434 } else {
1435 $realcnt=1+1;
1436 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001437 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001438
1439 # Guestimate if this is a continuing comment. Run
1440 # the context looking for a comment "edge". If this
1441 # edge is a close comment then we must be in a comment
1442 # at context start.
1443 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001444 my $cnt = $realcnt;
1445 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1446 next if (defined $rawlines[$ln - 1] &&
1447 $rawlines[$ln - 1] =~ /^-/);
1448 $cnt--;
1449 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001450 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001451 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1452 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1453 ($edge) = $1;
1454 last;
1455 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001456 }
1457 if (defined $edge && $edge eq '*/') {
1458 $in_comment = 1;
1459 }
1460
1461 # Guestimate if this is a continuing comment. If this
1462 # is the start of a diff block and this line starts
1463 # ' *' then it is very likely a comment.
1464 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001465 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001466 {
1467 $in_comment = 1;
1468 }
1469
1470 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1471 sanitise_line_reset($in_comment);
1472
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001473 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001474 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001475 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001476 $line = sanitise_line($rawline);
1477 }
1478 push(@lines, $line);
1479
1480 if ($realcnt > 1) {
1481 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1482 } else {
1483 $realcnt = 0;
1484 }
1485
1486 #print "==>$rawline\n";
1487 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001488
1489 if ($setup_docs && $line =~ /^\+/) {
1490 push(@setup_docs, $line);
1491 }
1492 }
1493
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001494 $prefix = '';
1495
Andy Whitcroft773647a2008-03-28 14:15:58 -07001496 $realcnt = 0;
1497 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001498 foreach my $line (@lines) {
1499 $linenr++;
1500
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001501 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001502
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001503#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001504 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001505 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001506 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001507 $realline=$1-1;
1508 if (defined $2) {
1509 $realcnt=$3+1;
1510 } else {
1511 $realcnt=1+1;
1512 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001513 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001514 $prev_values = 'E';
1515
Andy Whitcroft773647a2008-03-28 14:15:58 -07001516 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001517 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001518 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001519 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001520 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001521
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001522# track the line number as we move through the hunk, note that
1523# new versions of GNU diff omit the leading space on completely
1524# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001525 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001526 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001527 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001528
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001529 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001530 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001531
1532 # Track the previous line.
1533 ($prevline, $stashline) = ($stashline, $line);
1534 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001535 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1536
Andy Whitcroft773647a2008-03-28 14:15:58 -07001537 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001538
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001539 } elsif ($realcnt == 1) {
1540 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001541 }
1542
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001543 my $hunk_line = ($realcnt != 0);
1544
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001545#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001546 $prefix = "$filename:$realline: " if ($emacs && $file);
1547 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1548
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001549 $here = "#$linenr: " if (!$file);
1550 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001551
1552 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001553 if ($line =~ /^diff --git.*?(\S+)$/) {
1554 $realfile = $1;
1555 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001556 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001557 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001558 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001559 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001560 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001561
1562 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001563 if (!$file && $tree && $p1_prefix ne '' &&
1564 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001565 WARN("PATCH_PREFIX",
1566 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001567 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001568
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001569 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001570 ERROR("MODIFIED_INCLUDE_ASM",
1571 "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 -07001572 }
1573 next;
1574 }
1575
Randy Dunlap389834b2007-06-08 13:47:03 -07001576 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001577
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001578 my $hereline = "$here\n$rawline\n";
1579 my $herecurr = "$here\n$rawline\n";
1580 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001581
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001582 $cnt_lines++ if ($realcnt != 0);
1583
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001584# Check for incorrect file permissions
1585 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1586 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001587 if ($realfile !~ m@scripts/@ &&
1588 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001589 ERROR("EXECUTE_PERMISSIONS",
1590 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001591 }
1592 }
1593
Joe Perches20112472011-07-25 17:13:23 -07001594# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001595 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001596 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001597 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001598 }
1599
1600# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001601 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001602 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001603 my $space_before = $1;
1604 my $sign_off = $2;
1605 my $space_after = $3;
1606 my $email = $4;
1607 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1608
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001609 if ($sign_off !~ /$signature_tags/) {
1610 WARN("BAD_SIGN_OFF",
1611 "Non-standard signature: $sign_off\n" . $herecurr);
1612 }
Joe Perches20112472011-07-25 17:13:23 -07001613 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001614 WARN("BAD_SIGN_OFF",
1615 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001616 }
Joe Perches20112472011-07-25 17:13:23 -07001617 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001618 WARN("BAD_SIGN_OFF",
1619 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001620 }
1621 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001622 WARN("BAD_SIGN_OFF",
1623 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001624 }
1625
1626 my ($email_name, $email_address, $comment) = parse_email($email);
1627 my $suggested_email = format_email(($email_name, $email_address));
1628 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001629 ERROR("BAD_SIGN_OFF",
1630 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001631 } else {
1632 my $dequoted = $suggested_email;
1633 $dequoted =~ s/^"//;
1634 $dequoted =~ s/" </ </;
1635 # Don't force email to have quotes
1636 # Allow just an angle bracketed address
1637 if ("$dequoted$comment" ne $email &&
1638 "<$email_address>$comment" ne $email &&
1639 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001640 WARN("BAD_SIGN_OFF",
1641 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001642 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001643 }
1644 }
1645
Andy Whitcroft00df3442007-06-08 13:47:06 -07001646# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001647 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001648 ERROR("CORRUPTED_PATCH",
1649 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001650 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001651 }
1652
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001653# Check for absolute kernel paths.
1654 if ($tree) {
1655 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1656 my $file = $1;
1657
1658 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1659 check_absolute_file($1, $herecurr)) {
1660 #
1661 } else {
1662 check_absolute_file($file, $herecurr);
1663 }
1664 }
1665 }
1666
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001667# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1668 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001669 $rawline !~ m/^$UTF8*$/) {
1670 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1671
1672 my $blank = copy_spacing($rawline);
1673 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1674 my $hereptr = "$hereline$ptr\n";
1675
Joe Perches34d99212011-07-25 17:13:26 -07001676 CHK("INVALID_UTF8",
1677 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001678 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001679
Joe Perches15662b32011-10-31 17:13:12 -07001680# Check if it's the start of a commit log
1681# (not a header line and we haven't seen the patch filename)
1682 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001683 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001684 $in_header_lines = 0;
1685 $in_commit_log = 1;
1686 }
1687
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001688# Check if there is UTF-8 in a commit log when a mail header has explicitly
1689# declined it, i.e defined some charset where it is missing.
1690 if ($in_header_lines &&
1691 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1692 $1 !~ /utf-8/i) {
1693 $non_utf8_charset = 1;
1694 }
1695
1696 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001697 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001698 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001699 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1700 }
1701
Andy Whitcroft306708542008-10-15 22:02:28 -07001702# ignore non-hunk lines and lines being removed
1703 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001704
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001705#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001706 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001707 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001708 ERROR("DOS_LINE_ENDINGS",
1709 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001710
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001711 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1712 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001713 ERROR("TRAILING_WHITESPACE",
1714 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001715 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001716 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001717
Andi Kleen33549572010-05-24 14:33:29 -07001718# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001719# Only applies when adding the entry originally, after that we do not have
1720# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001721 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001722 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001723 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001724 my $cnt = $realcnt;
1725 my $ln = $linenr + 1;
1726 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001727 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001728 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001729 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001730 $f = $lines[$ln - 1];
1731 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1732 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001733
1734 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001735
1736 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1737 $is_start = 1;
1738 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1739 $length = -1;
1740 }
1741
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001742 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001743 $f =~ s/#.*//;
1744 $f =~ s/^\s+//;
1745 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001746 if ($f =~ /^\s*config\s/) {
1747 $is_end = 1;
1748 last;
1749 }
Andi Kleen33549572010-05-24 14:33:29 -07001750 $length++;
1751 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001752 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001753 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1754 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001755 }
1756
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001757# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1758 if ($realfile =~ /Kconfig/ &&
1759 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1760 WARN("CONFIG_EXPERIMENTAL",
1761 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1762 }
1763
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001764 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1765 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1766 my $flag = $1;
1767 my $replacement = {
1768 'EXTRA_AFLAGS' => 'asflags-y',
1769 'EXTRA_CFLAGS' => 'ccflags-y',
1770 'EXTRA_CPPFLAGS' => 'cppflags-y',
1771 'EXTRA_LDFLAGS' => 'ldflags-y',
1772 };
1773
1774 WARN("DEPRECATED_VARIABLE",
1775 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1776 }
1777
Andy Whitcroft5368df22008-10-15 22:02:27 -07001778# check we are in a valid source file if not then ignore this hunk
1779 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1780
Joe Perches6cd7f382012-12-17 16:01:54 -08001781#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001782 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001783 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001784 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001785 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08001786 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001787 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001788 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08001789 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001790 }
1791
Josh Triplettca56dc02012-03-23 15:02:21 -07001792# Check for user-visible strings broken across lines, which breaks the ability
1793# to grep for the string. Limited to strings used as parameters (those
1794# following an open parenthesis), which almost completely eliminates false
1795# positives, as well as warning only once per parameter rather than once per
1796# line of the string. Make an exception when the previous string ends in a
1797# newline (multiple lines in one string constant) or \n\t (common in inline
1798# assembly to indent the instruction on the following line).
1799 if ($line =~ /^\+\s*"/ &&
1800 $prevline =~ /"\s*$/ &&
1801 $prevline =~ /\(/ &&
1802 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1803 WARN("SPLIT_STRING",
1804 "quoted string split across lines\n" . $hereprev);
1805 }
1806
Joe Perches5e79d962010-03-05 13:43:55 -08001807# check for spaces before a quoted newline
1808 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001809 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1810 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001811 }
1812
Andy Whitcroft8905a672007-11-28 16:21:06 -08001813# check for adding lines without a newline.
1814 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001815 WARN("MISSING_EOF_NEWLINE",
1816 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001817 }
1818
Mike Frysinger42e41c52009-09-21 17:04:40 -07001819# Blackfin: use hi/lo macros
1820 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1821 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1822 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001823 ERROR("LO_MACRO",
1824 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001825 }
1826 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1827 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001828 ERROR("HI_MACRO",
1829 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001830 }
1831 }
1832
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001833# check we are in a valid source file C or perl if not then ignore this hunk
1834 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001835
1836# at the beginning of a line any tabs must come first and anything
1837# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001838 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1839 $rawline =~ /^\+\s* \s*/) {
1840 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001841 ERROR("CODE_INDENT",
1842 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001843 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001844 }
1845
Alberto Panizzo08e44362010-03-05 13:43:54 -08001846# check for space before tabs.
1847 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1848 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001849 WARN("SPACE_BEFORE_TAB",
1850 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001851 }
1852
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001853# check for && or || at the start of a line
1854 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1855 CHK("LOGICAL_CONTINUATIONS",
1856 "Logical continuations should be on the previous line\n" . $hereprev);
1857 }
1858
1859# check multi-line statement indentation matches previous line
1860 if ($^V && $^V ge 5.10.0 &&
1861 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1862 $prevline =~ /^\+(\t*)(.*)$/;
1863 my $oldindent = $1;
1864 my $rest = $2;
1865
1866 my $pos = pos_last_openparen($rest);
1867 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07001868 $line =~ /^(\+| )([ \t]*)/;
1869 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001870
1871 my $goodtabindent = $oldindent .
1872 "\t" x ($pos / 8) .
1873 " " x ($pos % 8);
1874 my $goodspaceindent = $oldindent . " " x $pos;
1875
1876 if ($newindent ne $goodtabindent &&
1877 $newindent ne $goodspaceindent) {
1878 CHK("PARENTHESIS_ALIGNMENT",
1879 "Alignment should match open parenthesis\n" . $hereprev);
1880 }
1881 }
1882 }
1883
Joe Perchesaad4f612012-03-23 15:02:19 -07001884 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1885 CHK("SPACING",
1886 "No space is necessary after a cast\n" . $hereprev);
1887 }
1888
Joe Perches05880602012-10-04 17:13:35 -07001889 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1890 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1891 $prevrawline =~ /^\+[ \t]*$/) {
1892 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1893 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1894 }
1895
1896 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08001897 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1898 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1899 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1900 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07001901 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1902 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1903 }
1904
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001905# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001906# Exceptions:
1907# 1) within comments
1908# 2) indented preprocessor commands
1909# 3) hanging labels
1910 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001911 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001912 WARN("LEADING_SPACE",
1913 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001914 }
1915
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001916# check we are in a valid C source file if not then ignore this hunk
1917 next if ($realfile !~ /\.(h|c)$/);
1918
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001919# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1920 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1921 WARN("CONFIG_EXPERIMENTAL",
1922 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1923 }
1924
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001925# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001926 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001927 WARN("CVS_KEYWORD",
1928 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001929 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001930
Mike Frysinger42e41c52009-09-21 17:04:40 -07001931# Blackfin: don't use __builtin_bfin_[cs]sync
1932 if ($line =~ /__builtin_bfin_csync/) {
1933 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001934 ERROR("CSYNC",
1935 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001936 }
1937 if ($line =~ /__builtin_bfin_ssync/) {
1938 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001939 ERROR("SSYNC",
1940 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001941 }
1942
Joe Perches56e77d72013-02-21 16:44:14 -08001943# check for old HOTPLUG __dev<foo> section markings
1944 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
1945 WARN("HOTPLUG_SECTION",
1946 "Using $1 is unnecessary\n" . $herecurr);
1947 }
1948
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001949# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001950 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1951 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001952#print "LINE<$line>\n";
1953 if ($linenr >= $suppress_statement &&
1954 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001955 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001956 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001957 $stat =~ s/\n./\n /g;
1958 $cond =~ s/\n./\n /g;
1959
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001960#print "linenr<$linenr> <$stat>\n";
1961 # If this statement has no statement boundaries within
1962 # it there is no point in retrying a statement scan
1963 # until we hit end of it.
1964 my $frag = $stat; $frag =~ s/;+\s*$//;
1965 if ($frag !~ /(?:{|;)/) {
1966#print "skip<$line_nr_next>\n";
1967 $suppress_statement = $line_nr_next;
1968 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001969
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001970 # Find the real next line.
1971 $realline_next = $line_nr_next;
1972 if (defined $realline_next &&
1973 (!defined $lines[$realline_next - 1] ||
1974 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1975 $realline_next++;
1976 }
1977
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001978 my $s = $stat;
1979 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001980
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001981 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001982 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001983
1984 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001985 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001986
Andy Whitcroft463f2862009-09-21 17:04:34 -07001987 } elsif ($s =~ /^.\s*else\b/s) {
1988
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001989 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001990 } 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 -07001991 my $type = $1;
1992 $type =~ s/\s+/ /g;
1993 possible($type, "A:" . $s);
1994
Andy Whitcroft8905a672007-11-28 16:21:06 -08001995 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001996 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001997 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001998 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001999
2000 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002001 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002002 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002003 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002004
2005 # Check for any sort of function declaration.
2006 # int foo(something bar, other baz);
2007 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002008 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 -08002009 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002010
Andy Whitcroftcf655042008-03-04 14:28:20 -08002011 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002012 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002013 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002014
Andy Whitcroft8905a672007-11-28 16:21:06 -08002015 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002016 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002017
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002018 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002019 }
2020 }
2021 }
2022
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002023 }
2024
Andy Whitcroft653d4872007-06-23 17:16:34 -07002025#
2026# Checks which may be anchored in the context.
2027#
2028
2029# Check for switch () and associated case and default
2030# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002031 if ($line=~/\bswitch\s*\(.*\)/) {
2032 my $err = '';
2033 my $sep = '';
2034 my @ctx = ctx_block_outer($linenr, $realcnt);
2035 shift(@ctx);
2036 for my $ctx (@ctx) {
2037 my ($clen, $cindent) = line_stats($ctx);
2038 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2039 $indent != $cindent) {
2040 $err .= "$sep$ctx\n";
2041 $sep = '';
2042 } else {
2043 $sep = "[...]\n";
2044 }
2045 }
2046 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002047 ERROR("SWITCH_CASE_INDENT_LEVEL",
2048 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002049 }
2050 }
2051
2052# if/while/etc brace do not go on next line, unless defining a do while loop,
2053# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002054 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002055 my $pre_ctx = "$1$2";
2056
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002057 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002058
2059 if ($line =~ /^\+\t{6,}/) {
2060 WARN("DEEP_INDENTATION",
2061 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2062 }
2063
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002064 my $ctx_cnt = $realcnt - $#ctx - 1;
2065 my $ctx = join("\n", @ctx);
2066
Andy Whitcroft548596d2008-07-23 21:29:01 -07002067 my $ctx_ln = $linenr;
2068 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002069
Andy Whitcroft548596d2008-07-23 21:29:01 -07002070 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2071 defined $lines[$ctx_ln - 1] &&
2072 $lines[$ctx_ln - 1] =~ /^-/)) {
2073 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2074 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002075 $ctx_ln++;
2076 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002077
Andy Whitcroft53210162008-07-23 21:29:03 -07002078 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2079 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002080
2081 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002082 ERROR("OPEN_BRACE",
2083 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002084 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002085 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002086 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2087 $ctx =~ /\)\s*\;\s*$/ &&
2088 defined $lines[$ctx_ln - 1])
2089 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002090 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2091 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002092 WARN("TRAILING_SEMICOLON",
2093 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002094 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002095 }
2096 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002097 }
2098
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002099# Check relative indent for conditionals and blocks.
2100 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002101 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2102 ctx_statement_block($linenr, $realcnt, 0)
2103 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002104 my ($s, $c) = ($stat, $cond);
2105
2106 substr($s, 0, length($c), '');
2107
2108 # Make sure we remove the line prefixes as we have
2109 # none on the first line, and are going to readd them
2110 # where necessary.
2111 $s =~ s/\n./\n/gs;
2112
2113 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002114 my @newlines = ($c =~ /\n/gs);
2115 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002116
2117 # We want to check the first line inside the block
2118 # starting at the end of the conditional, so remove:
2119 # 1) any blank line termination
2120 # 2) any opening brace { on end of the line
2121 # 3) any do (...) {
2122 my $continuation = 0;
2123 my $check = 0;
2124 $s =~ s/^.*\bdo\b//;
2125 $s =~ s/^\s*{//;
2126 if ($s =~ s/^\s*\\//) {
2127 $continuation = 1;
2128 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002129 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002130 $check = 1;
2131 $cond_lines++;
2132 }
2133
2134 # Also ignore a loop construct at the end of a
2135 # preprocessor statement.
2136 if (($prevline =~ /^.\s*#\s*define\s/ ||
2137 $prevline =~ /\\\s*$/) && $continuation == 0) {
2138 $check = 0;
2139 }
2140
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002141 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002142 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002143 while ($cond_ptr != $cond_lines) {
2144 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002145
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002146 # If we see an #else/#elif then the code
2147 # is not linear.
2148 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2149 $check = 0;
2150 }
2151
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002152 # Ignore:
2153 # 1) blank lines, they should be at 0,
2154 # 2) preprocessor lines, and
2155 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002156 if ($continuation ||
2157 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002158 $s =~ /^\s*#\s*?/ ||
2159 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002160 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002161 if ($s =~ s/^.*?\n//) {
2162 $cond_lines++;
2163 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002164 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002165 }
2166
2167 my (undef, $sindent) = line_stats("+" . $s);
2168 my $stat_real = raw_line($linenr, $cond_lines);
2169
2170 # Check if either of these lines are modified, else
2171 # this is not this patch's fault.
2172 if (!defined($stat_real) ||
2173 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2174 $check = 0;
2175 }
2176 if (defined($stat_real) && $cond_lines > 1) {
2177 $stat_real = "[...]\n$stat_real";
2178 }
2179
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002180 #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 -07002181
2182 if ($check && (($sindent % 8) != 0 ||
2183 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002184 WARN("SUSPECT_CODE_INDENT",
2185 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002186 }
2187 }
2188
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002189 # Track the 'values' across context and added lines.
2190 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002191 my ($curr_values, $curr_vars) =
2192 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002193 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002194 if ($dbg_values) {
2195 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002196 print "$linenr > .$outline\n";
2197 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002198 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002199 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002200 $prev_values = substr($curr_values, -1);
2201
Andy Whitcroft00df3442007-06-08 13:47:06 -07002202#ignore lines not being added
2203 if ($line=~/^[^\+]/) {next;}
2204
Andy Whitcroft653d4872007-06-23 17:16:34 -07002205# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002206 if ($dbg_type) {
2207 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002208 ERROR("TEST_TYPE",
2209 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002210 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002211 ERROR("TEST_NOT_TYPE",
2212 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002213 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002214 next;
2215 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002216# TEST: allow direct testing of the attribute matcher.
2217 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002218 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002219 ERROR("TEST_ATTR",
2220 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002221 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002222 ERROR("TEST_NOT_ATTR",
2223 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002224 }
2225 next;
2226 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002227
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002228# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002229 if ($line =~ /^.\s*{/ &&
2230 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002231 ERROR("OPEN_BRACE",
2232 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002233 }
2234
Andy Whitcroft653d4872007-06-23 17:16:34 -07002235#
2236# Checks which are anchored on the added line.
2237#
2238
2239# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002240 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002241 my $path = $1;
2242 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002243 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002244 "malformed #include filename\n" . $herecurr);
2245 }
2246 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2247 ERROR("UAPI_INCLUDE",
2248 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002249 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002250 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002251
2252# no C99 // comments
2253 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002254 ERROR("C99_COMMENTS",
2255 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002256 }
2257 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002258 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002259 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002260
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002261# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2262# the whole statement.
2263#print "APW <$lines[$realline_next - 1]>\n";
2264 if (defined $realline_next &&
2265 exists $lines[$realline_next - 1] &&
2266 !defined $suppress_export{$realline_next} &&
2267 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2268 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002269 # Handle definitions which produce identifiers with
2270 # a prefix:
2271 # XXX(foo);
2272 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002273 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002274 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002275 $name =~ /^${Ident}_$2/) {
2276#print "FOO C name<$name>\n";
2277 $suppress_export{$realline_next} = 1;
2278
2279 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002280 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002281 ^.DEFINE_$Ident\(\Q$name\E\)|
2282 ^.DECLARE_$Ident\(\Q$name\E\)|
2283 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002284 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2285 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002286 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002287#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2288 $suppress_export{$realline_next} = 2;
2289 } else {
2290 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002291 }
2292 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002293 if (!defined $suppress_export{$linenr} &&
2294 $prevline =~ /^.\s*$/ &&
2295 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2296 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2297#print "FOO B <$lines[$linenr - 1]>\n";
2298 $suppress_export{$linenr} = 2;
2299 }
2300 if (defined $suppress_export{$linenr} &&
2301 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002302 WARN("EXPORT_SYMBOL",
2303 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002304 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002305
Joe Eloff5150bda2010-08-09 17:21:00 -07002306# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002307 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002308 ERROR("GLOBAL_INITIALISERS",
2309 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002310 $herecurr);
2311 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002312# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002313 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002314 ERROR("INITIALISED_STATIC",
2315 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002316 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002317 }
2318
Joe Perchescb710ec2010-10-26 14:23:20 -07002319# check for static const char * arrays.
2320 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002321 WARN("STATIC_CONST_CHAR_ARRAY",
2322 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002323 $herecurr);
2324 }
2325
2326# check for static char foo[] = "bar" declarations.
2327 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002328 WARN("STATIC_CONST_CHAR_ARRAY",
2329 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002330 $herecurr);
2331 }
2332
Joe Perches93ed0e22010-10-26 14:23:21 -07002333# check for declarations of struct pci_device_id
2334 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002335 WARN("DEFINE_PCI_DEVICE_TABLE",
2336 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002337 }
2338
Andy Whitcroft653d4872007-06-23 17:16:34 -07002339# check for new typedefs, only function parameters and sparse annotations
2340# make sense.
2341 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002342 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002343 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002344 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002345 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002346 WARN("NEW_TYPEDEFS",
2347 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002348 }
2349
2350# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002351 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002352 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2353 #print "AA<$1>\n";
2354 my ($from, $to) = ($2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002355
Andy Whitcroft65863862009-01-06 14:41:21 -08002356 # Should start with a space.
2357 $to =~ s/^(\S)/ $1/;
2358 # Should not end with a space.
2359 $to =~ s/\s+$//;
2360 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002361 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002362 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002363
Andy Whitcroft65863862009-01-06 14:41:21 -08002364 #print "from<$from> to<$to>\n";
2365 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002366 ERROR("POINTER_LOCATION",
2367 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002368 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002369 }
2370 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2371 #print "BB<$1>\n";
2372 my ($from, $to, $ident) = ($2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002373
Andy Whitcroft65863862009-01-06 14:41:21 -08002374 # Should start with a space.
2375 $to =~ s/^(\S)/ $1/;
2376 # Should not end with a space.
2377 $to =~ s/\s+$//;
2378 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002379 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002380 }
2381 # Modifiers should have spaces.
2382 $to =~ s/(\b$Modifier$)/$1 /;
2383
Andy Whitcroft667026e2009-02-27 14:03:08 -08002384 #print "from<$from> to<$to> ident<$ident>\n";
2385 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002386 ERROR("POINTER_LOCATION",
2387 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002388 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002389 }
2390
2391# # no BUG() or BUG_ON()
2392# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2393# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2394# print "$herecurr";
2395# $clean = 0;
2396# }
2397
Andy Whitcroft8905a672007-11-28 16:21:06 -08002398 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002399 WARN("LINUX_VERSION_CODE",
2400 "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 -08002401 }
2402
Joe Perches17441222011-06-15 15:08:17 -07002403# check for uses of printk_ratelimit
2404 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002405 WARN("PRINTK_RATELIMITED",
2406"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002407 }
2408
Andy Whitcroft00df3442007-06-08 13:47:06 -07002409# printk should use KERN_* levels. Note that follow on printk's on the
2410# same line do not need a level, so we use the current block context
2411# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002412# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002413# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002414 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002415 my $ok = 0;
2416 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2417 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002418 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002419 # with "\n" ignore it, else it is to blame
2420 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2421 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2422 $ok = 1;
2423 }
2424 last;
2425 }
2426 }
2427 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002428 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2429 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002430 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002431 }
2432
Joe Perches243f3802012-05-31 16:26:09 -07002433 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2434 my $orig = $1;
2435 my $level = lc($orig);
2436 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002437 my $level2 = $level;
2438 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002439 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002440 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002441 }
2442
2443 if ($line =~ /\bpr_warning\s*\(/) {
2444 WARN("PREFER_PR_LEVEL",
2445 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2446 }
2447
Joe Perchesdc139312013-02-21 16:44:13 -08002448 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2449 my $orig = $1;
2450 my $level = lc($orig);
2451 $level = "warn" if ($level eq "warning");
2452 $level = "dbg" if ($level eq "debug");
2453 WARN("PREFER_DEV_LEVEL",
2454 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2455 }
2456
Andy Whitcroft653d4872007-06-23 17:16:34 -07002457# function brace can't be on same line, except for #defines of do while,
2458# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002459 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2460 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002461 ERROR("OPEN_BRACE",
2462 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002463 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002464
Andy Whitcroft8905a672007-11-28 16:21:06 -08002465# open braces for enum, union and struct go on the same line.
2466 if ($line =~ /^.\s*{/ &&
2467 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002468 ERROR("OPEN_BRACE",
2469 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002470 }
2471
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002472# missing space after union, struct or enum definition
2473 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002474 WARN("SPACING",
2475 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002476 }
2477
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002478# check for spacing round square brackets; allowed:
2479# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002480# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2481# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002482 while ($line =~ /(.*?\s)\[/g) {
2483 my ($where, $prefix) = ($-[1], $1);
2484 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002485 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002486 $prefix !~ /[{,]\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002487 ERROR("BRACKET_SPACE",
2488 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002489 }
2490 }
2491
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002492# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002493 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002494 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002495 my $ctx_before = substr($line, 0, $-[1]);
2496 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002497
2498 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002499 if ($name =~ /^(?:
2500 if|for|while|switch|return|case|
2501 volatile|__volatile__|
2502 __attribute__|format|__extension__|
2503 asm|__asm__)$/x)
2504 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002505
2506 # cpp #define statements have non-optional spaces, ie
2507 # if there is a space between the name and the open
2508 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002509 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002510
2511 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002512 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002513
2514 # If this whole things ends with a type its most
2515 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002516 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002517
2518 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002519 WARN("SPACING",
2520 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002521 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002522 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002523
2524# check for whitespace before a non-naked semicolon
2525 if ($line =~ /^\+.*\S\s+;/) {
Joe Perches5646bc72013-04-29 16:18:15 -07002526 WARN("SPACING",
2527 "space prohibited before semicolon\n" . $herecurr);
Eric Nelson9a4cad42012-05-31 16:26:09 -07002528 }
2529
Andy Whitcroft653d4872007-06-23 17:16:34 -07002530# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002531 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002532 my $ops = qr{
2533 <<=|>>=|<=|>=|==|!=|
2534 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2535 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002536 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2537 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002538 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002539 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002540 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002541
2542 my $blank = copy_spacing($opline);
2543
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002544 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002545 $off += length($elements[$n]);
2546
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002547 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002548 my $ca = substr($opline, 0, $off);
2549 my $cc = '';
2550 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2551 $cc = substr($opline, $off + length($elements[$n + 1]));
2552 }
2553 my $cb = "$ca$;$cc";
2554
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002555 my $a = '';
2556 $a = 'V' if ($elements[$n] ne '');
2557 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002558 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002559 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2560 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002561 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002562
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002563 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002564
2565 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002566 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002567 $c = 'V' if ($elements[$n + 2] ne '');
2568 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002569 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002570 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2571 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002572 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002573 } else {
2574 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002575 }
2576
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002577 my $ctx = "${a}x${c}";
2578
2579 my $at = "(ctx:$ctx)";
2580
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002581 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002582 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002583
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002584 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002585 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002586
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002587 # Get the full operator variant.
2588 my $opv = $op . substr($curr_vars, $off, 1);
2589
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002590 # Ignore operators passed as parameters.
2591 if ($op_type ne 'V' &&
2592 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2593
Andy Whitcroftcf655042008-03-04 14:28:20 -08002594# # Ignore comments
2595# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002596
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002597 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002598 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002599 if ($ctx !~ /.x[WEBC]/ &&
2600 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002601 ERROR("SPACING",
2602 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002603 }
2604
2605 # // is a comment
2606 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002607
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002608 # No spaces for:
2609 # ->
2610 # : when part of a bitfield
2611 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002612 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002613 ERROR("SPACING",
2614 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002615 }
2616
2617 # , must have a space on the right.
2618 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002619 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002620 ERROR("SPACING",
2621 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002622 }
2623
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002624 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002625 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002626 #warn "'*' is part of type\n";
2627
2628 # unary operators should have a space before and
2629 # none after. May be left adjacent to another
2630 # unary operator, or a cast
2631 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002632 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002633 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002634 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002635 ERROR("SPACING",
2636 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002637 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002638 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002639 # A unary '*' may be const
2640
2641 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002642 ERROR("SPACING",
2643 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002644 }
2645
2646 # unary ++ and unary -- are allowed no space on one side.
2647 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002648 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002649 ERROR("SPACING",
2650 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002651 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002652 if ($ctx =~ /Wx[BE]/ ||
2653 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002654 ERROR("SPACING",
2655 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002656 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002657 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002658 ERROR("SPACING",
2659 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002660 }
2661
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002662
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002663 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002664 } elsif ($op eq '<<' or $op eq '>>' or
2665 $op eq '&' or $op eq '^' or $op eq '|' or
2666 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002667 $op eq '*' or $op eq '/' or
2668 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002669 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002670 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002671 ERROR("SPACING",
2672 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002673 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002674 }
2675
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002676 # A colon needs no spaces before when it is
2677 # terminating a case value or a label.
2678 } elsif ($opv eq ':C' || $opv eq ':L') {
2679 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002680 ERROR("SPACING",
2681 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002682 }
2683
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002684 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002685 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002686 my $ok = 0;
2687
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002688 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002689 if (($op eq '<' &&
2690 $cc =~ /^\S+\@\S+>/) ||
2691 ($op eq '>' &&
2692 $ca =~ /<\S+\@\S+$/))
2693 {
2694 $ok = 1;
2695 }
2696
2697 # Ignore ?:
2698 if (($opv eq ':O' && $ca =~ /\?$/) ||
2699 ($op eq '?' && $cc =~ /^:/)) {
2700 $ok = 1;
2701 }
2702
2703 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002704 ERROR("SPACING",
2705 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002706 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002707 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002708 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002709 }
2710 }
2711
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002712# check for multiple assignments
2713 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002714 CHK("MULTIPLE_ASSIGNMENTS",
2715 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002716 }
2717
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002718## # check for multiple declarations, allowing for a function declaration
2719## # continuation.
2720## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2721## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2722##
2723## # Remove any bracketed sections to ensure we do not
2724## # falsly report the parameters of functions.
2725## my $ln = $line;
2726## while ($ln =~ s/\([^\(\)]*\)//g) {
2727## }
2728## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002729## WARN("MULTIPLE_DECLARATION",
2730## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002731## }
2732## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002733
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002734#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002735 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2736 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002737 ERROR("SPACING",
2738 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002739 }
2740
2741# closing brace should have a space following it when it has anything
2742# on the line
2743 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002744 ERROR("SPACING",
2745 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002746 }
2747
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002748# check spacing on square brackets
2749 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002750 ERROR("SPACING",
2751 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002752 }
2753 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002754 ERROR("SPACING",
2755 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002756 }
2757
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002758# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002759 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2760 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002761 ERROR("SPACING",
2762 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002763 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002764 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002765 $line !~ /for\s*\(.*;\s+\)/ &&
2766 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002767 ERROR("SPACING",
2768 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002769 }
2770
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002771#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002772 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002773 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002774 WARN("INDENTED_LABEL",
2775 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002776 }
2777
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002778# Return is not a function.
2779 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2780 my $spacing = $1;
2781 my $value = $2;
2782
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002783 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002784 $value =~ s/\(/ \(/g;
2785 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08002786 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002787 $value !~ /(?:$Ident|-?$Constant)\s*
2788 $Compare\s*
2789 (?:$Ident|-?$Constant)/x &&
2790 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002791 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002792#print "value<$value>\n";
2793 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002794 ERROR("RETURN_PARENTHESES",
2795 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002796
2797 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002798 ERROR("SPACING",
2799 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002800 }
2801 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002802# Return of what appears to be an errno should normally be -'ve
2803 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2804 my $name = $1;
2805 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002806 WARN("USE_NEGATIVE_ERRNO",
2807 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002808 }
2809 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002810
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002811# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002812 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002813 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002814 }
2815
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002816# Check for illegal assignment in if conditional -- and check for trailing
2817# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002818 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002819 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2820 ctx_statement_block($linenr, $realcnt, 0)
2821 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002822 my ($stat_next) = ctx_statement_block($line_nr_next,
2823 $remain_next, $off_next);
2824 $stat_next =~ s/\n./\n /g;
2825 ##print "stat<$stat> stat_next<$stat_next>\n";
2826
2827 if ($stat_next =~ /^\s*while\b/) {
2828 # If the statement carries leading newlines,
2829 # then count those as offsets.
2830 my ($whitespace) =
2831 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2832 my $offset =
2833 statement_rawlines($whitespace) - 1;
2834
2835 $suppress_whiletrailers{$line_nr_next +
2836 $offset} = 1;
2837 }
2838 }
2839 if (!defined $suppress_whiletrailers{$linenr} &&
2840 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002841 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002842
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002843 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002844 ERROR("ASSIGN_IN_IF",
2845 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002846 }
2847
2848 # Find out what is on the end of the line after the
2849 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002850 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002851 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002852 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002853 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2854 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002855 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002856 # Find out how long the conditional actually is.
2857 my @newlines = ($c =~ /\n/gs);
2858 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002859 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002860
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002861 $stat_real = raw_line($linenr, $cond_lines)
2862 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002863 if (defined($stat_real) && $cond_lines > 1) {
2864 $stat_real = "[...]\n$stat_real";
2865 }
2866
Joe Perches000d1cc12011-07-25 17:13:25 -07002867 ERROR("TRAILING_STATEMENTS",
2868 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002869 }
2870 }
2871
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002872# Check for bitwise tests written as boolean
2873 if ($line =~ /
2874 (?:
2875 (?:\[|\(|\&\&|\|\|)
2876 \s*0[xX][0-9]+\s*
2877 (?:\&\&|\|\|)
2878 |
2879 (?:\&\&|\|\|)
2880 \s*0[xX][0-9]+\s*
2881 (?:\&\&|\|\||\)|\])
2882 )/x)
2883 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002884 WARN("HEXADECIMAL_BOOLEAN_TEST",
2885 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002886 }
2887
Andy Whitcroft8905a672007-11-28 16:21:06 -08002888# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002889 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2890 my $s = $1;
2891 $s =~ s/$;//g; # Remove any comments
2892 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002893 ERROR("TRAILING_STATEMENTS",
2894 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002895 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002896 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002897# if should not continue a brace
2898 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002899 ERROR("TRAILING_STATEMENTS",
2900 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002901 $herecurr);
2902 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002903# case and default should not have general statements after them
2904 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2905 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002906 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002907 \s*return\s+
2908 )/xg)
2909 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002910 ERROR("TRAILING_STATEMENTS",
2911 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002912 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002913
2914 # Check for }<nl>else {, these must be at the same
2915 # indent level to be relevant to each other.
2916 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2917 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002918 ERROR("ELSE_AFTER_BRACE",
2919 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002920 }
2921
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002922 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2923 $previndent == $indent) {
2924 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2925
2926 # Find out what is on the end of the line after the
2927 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002928 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002929 $s =~ s/\n.*//g;
2930
2931 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002932 ERROR("WHILE_AFTER_BRACE",
2933 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002934 }
2935 }
2936
Joe Perches323c1262012-12-17 16:02:07 -08002937#CamelCase
2938 while ($line =~ m{($Constant|$Lval)}g) {
2939 my $var = $1;
2940 if ($var !~ /$Constant/ &&
2941 $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ &&
Joe Perchesbe987d92013-02-27 17:02:38 -08002942 $var !~ /"^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches323c1262012-12-17 16:02:07 -08002943 !defined $camelcase{$var}) {
2944 $camelcase{$var} = 1;
2945 WARN("CAMELCASE",
2946 "Avoid CamelCase: <$var>\n" . $herecurr);
2947 }
2948 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002949
2950#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002951 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002952 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2953 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002954 }
2955
Andy Whitcroft653d4872007-06-23 17:16:34 -07002956#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002957 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002958 my $file = "$1.h";
2959 my $checkfile = "include/linux/$file";
2960 if (-f "$root/$checkfile" &&
2961 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002962 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002963 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002964 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002965 CHK("ARCH_INCLUDE_LINUX",
2966 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002967 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002968 WARN("INCLUDE_LINUX",
2969 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002970 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002971 }
2972 }
2973
Andy Whitcroft653d4872007-06-23 17:16:34 -07002974# multi-statement macros should be enclosed in a do while loop, grab the
2975# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002976# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002977 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2978 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002979 my $ln = $linenr;
2980 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002981 my ($off, $dstat, $dcond, $rest);
2982 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002983 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002984 ctx_statement_block($linenr, $realcnt, 0);
2985 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002986 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002987 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002988
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002989 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002990 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002991 $dstat =~ s/\\\n.//g;
2992 $dstat =~ s/^\s*//s;
2993 $dstat =~ s/\s*$//s;
2994
2995 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002996 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2997 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08002998 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002999 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003000 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003001
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003002 # Flatten any obvious string concatentation.
3003 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3004 $dstat =~ s/$Ident\s*("X*")/$1/)
3005 {
3006 }
3007
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003008 my $exceptions = qr{
3009 $Declare|
3010 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003011 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003012 DECLARE_PER_CPU|
3013 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003014 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003015 union|
3016 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003017 \.$Ident\s*=\s*|
3018 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003019 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003020 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003021 if ($dstat ne '' &&
3022 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3023 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Andy Whitcroftfd1b57a2012-03-23 15:02:18 -07003024 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003025 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003026 $dstat !~ /$exceptions/ &&
3027 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003028 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003029 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003030 $dstat !~ /^for\s*$Constant$/ && # for (...)
3031 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3032 $dstat !~ /^do\s*{/ && # do {...
3033 $dstat !~ /^\({/) # ({...
3034 {
3035 $ctx =~ s/\n*$//;
3036 my $herectx = $here . "\n";
3037 my $cnt = statement_rawlines($ctx);
3038
3039 for (my $n = 0; $n < $cnt; $n++) {
3040 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003041 }
3042
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003043 if ($dstat =~ /;/) {
3044 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3045 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3046 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003047 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003048 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003049 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003050 }
Joe Perches5023d342012-12-17 16:01:47 -08003051
Joe Perches481eb482012-12-17 16:01:56 -08003052# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003053
3054 } else {
3055 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003056 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3057 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003058 $line =~ /^\+.*\\$/) {
3059 WARN("LINE_CONTINUATIONS",
3060 "Avoid unnecessary line continuations\n" . $herecurr);
3061 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003062 }
3063
Joe Perchesb13edf72012-07-30 14:41:24 -07003064# do {} while (0) macro tests:
3065# single-statement macros do not need to be enclosed in do while (0) loop,
3066# macro should not end with a semicolon
3067 if ($^V && $^V ge 5.10.0 &&
3068 $realfile !~ m@/vmlinux.lds.h$@ &&
3069 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3070 my $ln = $linenr;
3071 my $cnt = $realcnt;
3072 my ($off, $dstat, $dcond, $rest);
3073 my $ctx = '';
3074 ($dstat, $dcond, $ln, $cnt, $off) =
3075 ctx_statement_block($linenr, $realcnt, 0);
3076 $ctx = $dstat;
3077
3078 $dstat =~ s/\\\n.//g;
3079
3080 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3081 my $stmts = $2;
3082 my $semis = $3;
3083
3084 $ctx =~ s/\n*$//;
3085 my $cnt = statement_rawlines($ctx);
3086 my $herectx = $here . "\n";
3087
3088 for (my $n = 0; $n < $cnt; $n++) {
3089 $herectx .= raw_line($linenr, $n) . "\n";
3090 }
3091
Joe Perchesac8e97f2012-08-21 16:15:53 -07003092 if (($stmts =~ tr/;/;/) == 1 &&
3093 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003094 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3095 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3096 }
3097 if (defined $semis && $semis ne "") {
3098 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3099 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3100 }
3101 }
3102 }
3103
Mike Frysinger080ba922009-01-06 14:41:25 -08003104# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3105# all assignments may have only one of the following with an assignment:
3106# .
3107# ALIGN(...)
3108# VMLINUX_SYMBOL(...)
3109 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003110 WARN("MISSING_VMLINUX_SYMBOL",
3111 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003112 }
3113
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003114# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003115 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3116 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003117 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003118 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003119 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3120 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003121 my @allowed = ();
3122 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003123 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003124 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003125 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003126 for my $chunk (@chunks) {
3127 my ($cond, $block) = @{$chunk};
3128
Andy Whitcroft773647a2008-03-28 14:15:58 -07003129 # If the condition carries leading newlines, then count those as offsets.
3130 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3131 my $offset = statement_rawlines($whitespace) - 1;
3132
Joe Perchesaad4f612012-03-23 15:02:19 -07003133 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003134 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3135
3136 # We have looked at and allowed this specific line.
3137 $suppress_ifbraces{$ln + $offset} = 1;
3138
3139 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003140 $ln += statement_rawlines($block) - 1;
3141
Andy Whitcroft773647a2008-03-28 14:15:58 -07003142 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003143
3144 $seen++ if ($block =~ /^\s*{/);
3145
Joe Perchesaad4f612012-03-23 15:02:19 -07003146 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003147 if (statement_lines($cond) > 1) {
3148 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003149 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003150 }
3151 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003152 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003153 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003154 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003155 if (statement_block_size($block) > 1) {
3156 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003157 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003158 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003159 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003160 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003161 if ($seen) {
3162 my $sum_allowed = 0;
3163 foreach (@allowed) {
3164 $sum_allowed += $_;
3165 }
3166 if ($sum_allowed == 0) {
3167 WARN("BRACES",
3168 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3169 } elsif ($sum_allowed != $allow &&
3170 $seen != $allow) {
3171 CHK("BRACES",
3172 "braces {} should be used on all arms of this statement\n" . $herectx);
3173 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003174 }
3175 }
3176 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003177 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003178 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003179 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003180
Andy Whitcroftcf655042008-03-04 14:28:20 -08003181 # Check the pre-context.
3182 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3183 #print "APW: ALLOWED: pre<$1>\n";
3184 $allowed = 1;
3185 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003186
3187 my ($level, $endln, @chunks) =
3188 ctx_statement_full($linenr, $realcnt, $-[0]);
3189
Andy Whitcroftcf655042008-03-04 14:28:20 -08003190 # Check the condition.
3191 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003192 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003193 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003194 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003195 }
3196 if (statement_lines($cond) > 1) {
3197 #print "APW: ALLOWED: cond<$cond>\n";
3198 $allowed = 1;
3199 }
3200 if ($block =~/\b(?:if|for|while)\b/) {
3201 #print "APW: ALLOWED: block<$block>\n";
3202 $allowed = 1;
3203 }
3204 if (statement_block_size($block) > 1) {
3205 #print "APW: ALLOWED: lines block<$block>\n";
3206 $allowed = 1;
3207 }
3208 # Check the post-context.
3209 if (defined $chunks[1]) {
3210 my ($cond, $block) = @{$chunks[1]};
3211 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003212 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003213 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003214 if ($block =~ /^\s*\{/) {
3215 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3216 $allowed = 1;
3217 }
3218 }
3219 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003220 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003221 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003222
Andy Whitcroftf0556632008-10-15 22:02:23 -07003223 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003224 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003225 }
3226
Joe Perches000d1cc12011-07-25 17:13:25 -07003227 WARN("BRACES",
3228 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003229 }
3230 }
3231
Joe Perches0979ae62012-12-17 16:01:59 -08003232# check for unnecessary blank lines around braces
Matthijs Kooijman74c8f432013-04-29 16:18:16 -07003233 if (($line =~ /^.\s*}\s*$/ && $prevline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003234 CHK("BRACES",
3235 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3236 }
3237 if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3238 CHK("BRACES",
3239 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3240 }
3241
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003242# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003243 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3244 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003245 WARN("VOLATILE",
3246 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003247 }
3248
Andy Whitcroft00df3442007-06-08 13:47:06 -07003249# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003250 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003251 CHK("REDUNDANT_CODE",
3252 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003253 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003254 }
3255
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003256# check for needless "if (<foo>) fn(<foo>)" uses
3257 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3258 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3259 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3260 WARN('NEEDLESS_IF',
3261 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003262 }
3263 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003264
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003265# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003266 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003267 # ignore udelay's < 10, however
Bruce Allan37581c22013-02-21 16:44:19 -08003268 if (! ($1 < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003269 CHK("USLEEP_RANGE",
3270 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003271 }
3272 }
3273
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003274# warn about unexpectedly long msleep's
3275 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3276 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003277 WARN("MSLEEP",
3278 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003279 }
3280 }
3281
Andy Whitcroft00df3442007-06-08 13:47:06 -07003282# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003283# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003284# print "#ifdef in C files should be avoided\n";
3285# print "$herecurr";
3286# $clean = 0;
3287# }
3288
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003289# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003290 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003291 ERROR("SPACING",
3292 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003293 }
3294
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003295# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003296 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3297 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003298 my $which = $1;
3299 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003300 CHK("UNCOMMENTED_DEFINITION",
3301 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003302 }
3303 }
3304# check for memory barriers without a comment.
3305 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3306 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003307 CHK("MEMORY_BARRIER",
3308 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003309 }
3310 }
3311# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003312 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003313 CHK("ARCH_DEFINES",
3314 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003315 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003316
Tobias Klauserd4977c72010-05-24 14:33:30 -07003317# Check that the storage class is at the beginning of a declaration
3318 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003319 WARN("STORAGE_CLASS",
3320 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003321 }
3322
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003323# check the location of the inline attribute, that it is between
3324# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003325 if ($line =~ /\b$Type\s+$Inline\b/ ||
3326 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003327 ERROR("INLINE_LOCATION",
3328 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003329 }
3330
Andy Whitcroft8905a672007-11-28 16:21:06 -08003331# Check for __inline__ and __inline, prefer inline
3332 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003333 WARN("INLINE",
3334 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003335 }
3336
Joe Perches3d130fd2011-01-12 17:00:00 -08003337# Check for __attribute__ packed, prefer __packed
3338 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003339 WARN("PREFER_PACKED",
3340 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003341 }
3342
Joe Perches39b7e282011-07-25 17:13:24 -07003343# Check for __attribute__ aligned, prefer __aligned
3344 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003345 WARN("PREFER_ALIGNED",
3346 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003347 }
3348
Joe Perches5f14d3b2012-01-10 15:09:52 -08003349# Check for __attribute__ format(printf, prefer __printf
3350 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3351 WARN("PREFER_PRINTF",
3352 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3353 }
3354
Joe Perches6061d942012-03-23 15:02:16 -07003355# Check for __attribute__ format(scanf, prefer __scanf
3356 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3357 WARN("PREFER_SCANF",
3358 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3359 }
3360
Joe Perches8f53a9b2010-03-05 13:43:48 -08003361# check for sizeof(&)
3362 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003363 WARN("SIZEOF_ADDRESS",
3364 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003365 }
3366
Joe Perches66c80b62012-07-30 14:41:22 -07003367# check for sizeof without parenthesis
3368 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3369 WARN("SIZEOF_PARENTHESIS",
3370 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3371 }
3372
Joe Perches428e2fd2011-05-24 17:13:39 -07003373# check for line continuations in quoted strings with odd counts of "
3374 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003375 WARN("LINE_CONTINUATIONS",
3376 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003377 }
3378
Joe Perches88982fe2012-12-17 16:02:00 -08003379# check for struct spinlock declarations
3380 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3381 WARN("USE_SPINLOCK_T",
3382 "struct spinlock should be spinlock_t\n" . $herecurr);
3383 }
3384
Joe Perchesa6962d72013-04-29 16:18:13 -07003385# check for seq_printf uses that could be seq_puts
3386 if ($line =~ /\bseq_printf\s*\(/) {
3387 my $fmt = get_quoted_string($line, $rawline);
3388 if ($fmt !~ /[^\\]\%/) {
3389 WARN("PREFER_SEQ_PUTS",
3390 "Prefer seq_puts to seq_printf\n" . $herecurr);
3391 }
3392 }
3393
Andy Whitcroft554e1652012-01-10 15:09:57 -08003394# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003395 if ($^V && $^V ge 5.10.0 &&
3396 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003397 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003398
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003399 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003400 my $ms_val = $7;
3401 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003402
Andy Whitcroft554e1652012-01-10 15:09:57 -08003403 if ($ms_size =~ /^(0x|)0$/i) {
3404 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003405 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003406 } elsif ($ms_size =~ /^(0x|)1$/i) {
3407 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003408 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3409 }
3410 }
3411
3412# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003413 if ($^V && $^V ge 5.10.0 &&
3414 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003415 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003416 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003417 my $call = $1;
3418 my $cast1 = deparenthesize($2);
3419 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003420 my $cast2 = deparenthesize($7);
3421 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003422 my $cast;
3423
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003424 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003425 $cast = "$cast1 or $cast2";
3426 } elsif ($cast1 ne "") {
3427 $cast = $cast1;
3428 } else {
3429 $cast = $cast2;
3430 }
3431 WARN("MINMAX",
3432 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003433 }
3434 }
3435
Joe Perches4a273192012-07-30 14:41:20 -07003436# check usleep_range arguments
3437 if ($^V && $^V ge 5.10.0 &&
3438 defined $stat &&
3439 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3440 my $min = $1;
3441 my $max = $7;
3442 if ($min eq $max) {
3443 WARN("USLEEP_RANGE",
3444 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3445 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3446 $min > $max) {
3447 WARN("USLEEP_RANGE",
3448 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3449 }
3450 }
3451
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003452# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003453 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003454 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003455 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003456 my $function_name = $1;
3457 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003458
3459 my $s = $stat;
3460 if (defined $cond) {
3461 substr($s, 0, length($cond), '');
3462 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003463 if ($s =~ /^\s*;/ &&
3464 $function_name ne 'uninitialized_var')
3465 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003466 WARN("AVOID_EXTERNS",
3467 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003468 }
3469
3470 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003471 WARN("FUNCTION_ARGUMENTS",
3472 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003473 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003474
3475 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3476 $stat =~ /^.\s*extern\s+/)
3477 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003478 WARN("AVOID_EXTERNS",
3479 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003480 }
3481
3482# checks for new __setup's
3483 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3484 my $name = $1;
3485
3486 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003487 CHK("UNDOCUMENTED_SETUP",
3488 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003489 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003490 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003491
3492# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003493 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003494 WARN("UNNECESSARY_CASTS",
3495 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003496 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003497
Joe Perches972fdea2013-04-29 16:18:12 -07003498# check for krealloc arg reuse
3499 if ($^V && $^V ge 5.10.0 &&
3500 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3501 WARN("KREALLOC_ARG_REUSE",
3502 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3503 }
3504
Joe Perches5ce59ae2013-02-21 16:44:18 -08003505# check for alloc argument mismatch
3506 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3507 WARN("ALLOC_ARRAY_ARGS",
3508 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3509 }
3510
Joe Perchescaf2a542011-01-12 16:59:56 -08003511# check for multiple semicolons
3512 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08003513 WARN("ONE_SEMICOLON",
3514 "Statements terminations use 1 semicolon\n" . $herecurr);
3515 }
3516
3517# check for switch/default statements without a break;
3518 if ($^V && $^V ge 5.10.0 &&
3519 defined $stat &&
3520 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3521 my $ctx = '';
3522 my $herectx = $here . "\n";
3523 my $cnt = statement_rawlines($stat);
3524 for (my $n = 0; $n < $cnt; $n++) {
3525 $herectx .= raw_line($linenr, $n) . "\n";
3526 }
3527 WARN("DEFAULT_NO_BREAK",
3528 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08003529 }
3530
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003531# check for gcc specific __FUNCTION__
3532 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003533 WARN("USE_FUNC",
3534 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003535 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003536
Joe Perches2c924882012-03-23 15:02:20 -07003537# check for use of yield()
3538 if ($line =~ /\byield\s*\(\s*\)/) {
3539 WARN("YIELD",
3540 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3541 }
3542
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003543# check for semaphores initialized locked
3544 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003545 WARN("CONSIDER_COMPLETION",
3546 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003547 }
Joe Perches6712d852012-03-23 15:02:20 -07003548
Joe Perches67d0a072011-10-31 17:13:10 -07003549# recommend kstrto* over simple_strto* and strict_strto*
3550 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003551 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003552 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003553 }
Joe Perches6712d852012-03-23 15:02:20 -07003554
Michael Ellermanf3db6632008-07-23 21:28:57 -07003555# check for __initcall(), use device_initcall() explicitly please
3556 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003557 WARN("USE_DEVICE_INITCALL",
3558 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003559 }
Joe Perches6712d852012-03-23 15:02:20 -07003560
Emese Revfy79404842010-03-05 13:43:53 -08003561# check for various ops structs, ensure they are const.
3562 my $struct_ops = qr{acpi_dock_ops|
3563 address_space_operations|
3564 backlight_ops|
3565 block_device_operations|
3566 dentry_operations|
3567 dev_pm_ops|
3568 dma_map_ops|
3569 extent_io_ops|
3570 file_lock_operations|
3571 file_operations|
3572 hv_ops|
3573 ide_dma_ops|
3574 intel_dvo_dev_ops|
3575 item_operations|
3576 iwl_ops|
3577 kgdb_arch|
3578 kgdb_io|
3579 kset_uevent_ops|
3580 lock_manager_operations|
3581 microcode_ops|
3582 mtrr_ops|
3583 neigh_ops|
3584 nlmsvc_binding|
3585 pci_raw_ops|
3586 pipe_buf_operations|
3587 platform_hibernation_ops|
3588 platform_suspend_ops|
3589 proto_ops|
3590 rpc_pipe_ops|
3591 seq_operations|
3592 snd_ac97_build_ops|
3593 soc_pcmcia_socket_ops|
3594 stacktrace_ops|
3595 sysfs_ops|
3596 tty_operations|
3597 usb_mon_operations|
3598 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003599 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003600 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003601 WARN("CONST_STRUCT",
3602 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003603 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003604 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003605
3606# use of NR_CPUS is usually wrong
3607# ignore definitions of NR_CPUS and usage to define arrays as likely right
3608 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003609 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3610 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003611 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3612 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3613 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003614 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003615 WARN("NR_CPUS",
3616 "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 -07003617 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003618
3619# check for %L{u,d,i} in strings
3620 my $string;
3621 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3622 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003623 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003624 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003625 WARN("PRINTF_L",
3626 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003627 last;
3628 }
3629 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003630
3631# whine mightly about in_atomic
3632 if ($line =~ /\bin_atomic\s*\(/) {
3633 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003634 ERROR("IN_ATOMIC",
3635 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003636 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003637 WARN("IN_ATOMIC",
3638 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003639 }
3640 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003641
3642# check for lockdep_set_novalidate_class
3643 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3644 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3645 if ($realfile !~ m@^kernel/lockdep@ &&
3646 $realfile !~ m@^include/linux/lockdep@ &&
3647 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003648 ERROR("LOCKDEP",
3649 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003650 }
3651 }
Dave Jones88f88312011-01-12 16:59:59 -08003652
3653 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3654 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003655 WARN("EXPORTED_WORLD_WRITABLE",
3656 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003657 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003658 }
3659
3660 # If we have no input at all, then there is nothing to report on
3661 # so just keep quiet.
3662 if ($#rawlines == -1) {
3663 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003664 }
3665
Andy Whitcroft8905a672007-11-28 16:21:06 -08003666 # In mailback mode only produce a report in the negative, for
3667 # things that appear to be patches.
3668 if ($mailback && ($clean == 1 || !$is_patch)) {
3669 exit(0);
3670 }
3671
3672 # This is not a patch, and we are are in 'no-patch' mode so
3673 # just keep quiet.
3674 if (!$chk_patch && !$is_patch) {
3675 exit(0);
3676 }
3677
3678 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003679 ERROR("NOT_UNIFIED_DIFF",
3680 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003681 }
3682 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003683 ERROR("MISSING_SIGN_OFF",
3684 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003685 }
3686
Andy Whitcroft8905a672007-11-28 16:21:06 -08003687 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003688 if ($summary && !($clean == 1 && $quiet == 1)) {
3689 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003690 print "total: $cnt_error errors, $cnt_warn warnings, " .
3691 (($check)? "$cnt_chk checks, " : "") .
3692 "$cnt_lines lines checked\n";
3693 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003694 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003695
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003696 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003697
3698 if ($^V lt 5.10.0) {
3699 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3700 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3701 }
3702
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003703 # If there were whitespace errors which cleanpatch can fix
3704 # then suggest that.
3705 if ($rpt_cleaners) {
3706 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3707 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003708 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003709 }
3710 }
3711
Artem Bityutskiy11232682012-03-23 15:02:17 -07003712 if ($quiet == 0 && keys %ignore_type) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003713 print "NOTE: Ignored message types:";
3714 foreach my $ignore (sort keys %ignore_type) {
3715 print " $ignore";
3716 }
Artem Bityutskiy11232682012-03-23 15:02:17 -07003717 print "\n\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003718 }
3719
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003720 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003721 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003722 }
3723 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003724 print << "EOM";
3725$vname has style problems, please review.
3726
3727If any of these errors are false positives, please report
3728them to the maintainer, see CHECKPATCH in MAINTAINERS.
3729EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003730 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003731
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003732 return $clean;
3733}