blob: 9cdd147c1335c9b54c4a79ffe22194b0bc9bcac3 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070012
Joe Perches000d1cc12011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070029my $show_types = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080031my %debug;
Joe Perches000d1cc12011-07-25 17:13:25 -070032my %ignore_type = ();
33my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070034my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070035my $configuration_file = ".checkpatch.conf";
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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700100GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700101 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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:|
284 To:|
285 Cc:
286)};
287
Andy Whitcroft8905a672007-11-28 16:21:06 -0800288our @typeList = (
289 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700290 qr{(?:unsigned\s+)?char},
291 qr{(?:unsigned\s+)?short},
292 qr{(?:unsigned\s+)?int},
293 qr{(?:unsigned\s+)?long},
294 qr{(?:unsigned\s+)?long\s+int},
295 qr{(?:unsigned\s+)?long\s+long},
296 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800297 qr{unsigned},
298 qr{float},
299 qr{double},
300 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800301 qr{struct\s+$Ident},
302 qr{union\s+$Ident},
303 qr{enum\s+$Ident},
304 qr{${Ident}_t},
305 qr{${Ident}_handler},
306 qr{${Ident}_handler_fn},
307);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700308our @modifierList = (
309 qr{fastcall},
310);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311
Wolfram Sang7840a942010-08-09 17:20:57 -0700312our $allowed_asm_includes = qr{(?x:
313 irq|
314 memory
315)};
316# memory.h: ARM has a custom one
317
Andy Whitcroft8905a672007-11-28 16:21:06 -0800318sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700319 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
320 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700321 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800322 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700323 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800324 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800325 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700326 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700327 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800328 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700329 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800330 }x;
331 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700332 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700333 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700334 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800335 }x;
336 $Declare = qr{(?:$Storage\s+)?$Type};
337}
338build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700339
Joe Perches7d2367a2011-07-25 17:13:22 -0700340
341our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700342
343# Using $balanced_parens, $LvalOrFunc, or $FuncArg
344# requires at least perl version v5.10.0
345# Any use must be runtime checked with $^V
346
347our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
348our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800349our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700350
351sub deparenthesize {
352 my ($string) = @_;
353 return "" if (!defined($string));
354 $string =~ s@^\s*\(\s*@@g;
355 $string =~ s@\s*\)\s*$@@g;
356 $string =~ s@\s+@ @g;
357 return $string;
358}
359
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700360$chk_signoff = 0 if ($file);
361
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700362my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800363my @lines = ();
364my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700365for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800366 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700367 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800368 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700369 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800370 } elsif ($filename eq '-') {
371 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700372 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800373 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700374 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700375 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800376 if ($filename eq '-') {
377 $vname = 'Your patch';
378 } else {
379 $vname = $filename;
380 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800381 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700382 chomp;
383 push(@rawlines, $_);
384 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800385 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800386 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700387 $exit = 1;
388 }
389 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800390 @lines = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700391}
392
393exit($exit);
394
395sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700396 my ($root) = @_;
397
398 my @tree_check = (
399 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
400 "README", "Documentation", "arch", "include", "drivers",
401 "fs", "init", "ipc", "kernel", "lib", "scripts",
402 );
403
404 foreach my $check (@tree_check) {
405 if (! -e $root . '/' . $check) {
406 return 0;
407 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700408 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700409 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700410}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700411
Joe Perches20112472011-07-25 17:13:23 -0700412sub parse_email {
413 my ($formatted_email) = @_;
414
415 my $name = "";
416 my $address = "";
417 my $comment = "";
418
419 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
420 $name = $1;
421 $address = $2;
422 $comment = $3 if defined $3;
423 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
424 $address = $1;
425 $comment = $2 if defined $2;
426 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
427 $address = $1;
428 $comment = $2 if defined $2;
429 $formatted_email =~ s/$address.*$//;
430 $name = $formatted_email;
431 $name =~ s/^\s+|\s+$//g;
432 $name =~ s/^\"|\"$//g;
433 # If there's a name left after stripping spaces and
434 # leading quotes, and the address doesn't have both
435 # leading and trailing angle brackets, the address
436 # is invalid. ie:
437 # "joe smith joe@smith.com" bad
438 # "joe smith <joe@smith.com" bad
439 if ($name ne "" && $address !~ /^<[^>]+>$/) {
440 $name = "";
441 $address = "";
442 $comment = "";
443 }
444 }
445
446 $name =~ s/^\s+|\s+$//g;
447 $name =~ s/^\"|\"$//g;
448 $address =~ s/^\s+|\s+$//g;
449 $address =~ s/^\<|\>$//g;
450
451 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
452 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
453 $name = "\"$name\"";
454 }
455
456 return ($name, $address, $comment);
457}
458
459sub format_email {
460 my ($name, $address) = @_;
461
462 my $formatted_email;
463
464 $name =~ s/^\s+|\s+$//g;
465 $name =~ s/^\"|\"$//g;
466 $address =~ s/^\s+|\s+$//g;
467
468 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
469 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
470 $name = "\"$name\"";
471 }
472
473 if ("$name" eq "") {
474 $formatted_email = "$address";
475 } else {
476 $formatted_email = "$name <$address>";
477 }
478
479 return $formatted_email;
480}
481
Joe Perches000d1cc12011-07-25 17:13:25 -0700482sub which_conf {
483 my ($conf) = @_;
484
485 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
486 if (-e "$path/$conf") {
487 return "$path/$conf";
488 }
489 }
490
491 return "";
492}
493
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700494sub expand_tabs {
495 my ($str) = @_;
496
497 my $res = '';
498 my $n = 0;
499 for my $c (split(//, $str)) {
500 if ($c eq "\t") {
501 $res .= ' ';
502 $n++;
503 for (; ($n % 8) != 0; $n++) {
504 $res .= ' ';
505 }
506 next;
507 }
508 $res .= $c;
509 $n++;
510 }
511
512 return $res;
513}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700514sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700515 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700516 return $res;
517}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700518
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700519sub line_stats {
520 my ($line) = @_;
521
522 # Drop the diff line leader and expand tabs
523 $line =~ s/^.//;
524 $line = expand_tabs($line);
525
526 # Pick the indent from the front of the line.
527 my ($white) = ($line =~ /^(\s*)/);
528
529 return (length($line), length($white));
530}
531
Andy Whitcroft773647a2008-03-28 14:15:58 -0700532my $sanitise_quote = '';
533
534sub sanitise_line_reset {
535 my ($in_comment) = @_;
536
537 if ($in_comment) {
538 $sanitise_quote = '*/';
539 } else {
540 $sanitise_quote = '';
541 }
542}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700543sub sanitise_line {
544 my ($line) = @_;
545
546 my $res = '';
547 my $l = '';
548
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800549 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700550 my $off = 0;
551 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700552
Andy Whitcroft773647a2008-03-28 14:15:58 -0700553 # Always copy over the diff marker.
554 $res = substr($line, 0, 1);
555
556 for ($off = 1; $off < length($line); $off++) {
557 $c = substr($line, $off, 1);
558
559 # Comments we are wacking completly including the begin
560 # and end, all to $;.
561 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
562 $sanitise_quote = '*/';
563
564 substr($res, $off, 2, "$;$;");
565 $off++;
566 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800567 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700568 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700569 $sanitise_quote = '';
570 substr($res, $off, 2, "$;$;");
571 $off++;
572 next;
573 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700574 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
575 $sanitise_quote = '//';
576
577 substr($res, $off, 2, $sanitise_quote);
578 $off++;
579 next;
580 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700581
582 # A \ in a string means ignore the next character.
583 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
584 $c eq "\\") {
585 substr($res, $off, 2, 'XX');
586 $off++;
587 next;
588 }
589 # Regular quotes.
590 if ($c eq "'" || $c eq '"') {
591 if ($sanitise_quote eq '') {
592 $sanitise_quote = $c;
593
594 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700595 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700596 } elsif ($sanitise_quote eq $c) {
597 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700598 }
599 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700600
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800601 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700602 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
603 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700604 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
605 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700606 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
607 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700608 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700609 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700610 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800611 }
612
Daniel Walker113f04a2009-09-21 17:04:35 -0700613 if ($sanitise_quote eq '//') {
614 $sanitise_quote = '';
615 }
616
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800617 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700618 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800619 my $clean = 'X' x length($1);
620 $res =~ s@\<.*\>@<$clean>@;
621
622 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700623 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800624 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700625 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800626 }
627
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700628 return $res;
629}
630
Joe Perchesa6962d72013-04-29 16:18:13 -0700631sub get_quoted_string {
632 my ($line, $rawline) = @_;
633
634 return "" if ($line !~ m/(\"[X]+\")/g);
635 return substr($rawline, $-[0], $+[0] - $-[0]);
636}
637
Andy Whitcroft8905a672007-11-28 16:21:06 -0800638sub ctx_statement_block {
639 my ($linenr, $remain, $off) = @_;
640 my $line = $linenr - 1;
641 my $blk = '';
642 my $soff = $off;
643 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700644 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800645
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800646 my $loff = 0;
647
Andy Whitcroft8905a672007-11-28 16:21:06 -0800648 my $type = '';
649 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800650 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800651 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800652 my $c;
653 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800654
655 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800656 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800657 @stack = (['', 0]) if ($#stack == -1);
658
Andy Whitcroft773647a2008-03-28 14:15:58 -0700659 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800660 # If we are about to drop off the end, pull in more
661 # context.
662 if ($off >= $len) {
663 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700664 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800665 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800666 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800667 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800668 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800669 $len = length($blk);
670 $line++;
671 last;
672 }
673 # Bail if there is no further context.
674 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800675 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800676 last;
677 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800678 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
679 $level++;
680 $type = '#';
681 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800682 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800683 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800684 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800685 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800686
Andy Whitcroft773647a2008-03-28 14:15:58 -0700687 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800688
689 # Handle nested #if/#else.
690 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
691 push(@stack, [ $type, $level ]);
692 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
693 ($type, $level) = @{$stack[$#stack - 1]};
694 } elsif ($remainder =~ /^#\s*endif\b/) {
695 ($type, $level) = @{pop(@stack)};
696 }
697
Andy Whitcroft8905a672007-11-28 16:21:06 -0800698 # Statement ends at the ';' or a close '}' at the
699 # outermost level.
700 if ($level == 0 && $c eq ';') {
701 last;
702 }
703
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800704 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700705 if ($level == 0 && $coff_set == 0 &&
706 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
707 $remainder =~ /^(else)(?:\s|{)/ &&
708 $remainder !~ /^else\s+if\b/) {
709 $coff = $off + length($1) - 1;
710 $coff_set = 1;
711 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
712 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800713 }
714
Andy Whitcroft8905a672007-11-28 16:21:06 -0800715 if (($type eq '' || $type eq '(') && $c eq '(') {
716 $level++;
717 $type = '(';
718 }
719 if ($type eq '(' && $c eq ')') {
720 $level--;
721 $type = ($level != 0)? '(' : '';
722
723 if ($level == 0 && $coff < $soff) {
724 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700725 $coff_set = 1;
726 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800727 }
728 }
729 if (($type eq '' || $type eq '{') && $c eq '{') {
730 $level++;
731 $type = '{';
732 }
733 if ($type eq '{' && $c eq '}') {
734 $level--;
735 $type = ($level != 0)? '{' : '';
736
737 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700738 if (substr($blk, $off + 1, 1) eq ';') {
739 $off++;
740 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800741 last;
742 }
743 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800744 # Preprocessor commands end at the newline unless escaped.
745 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
746 $level--;
747 $type = '';
748 $off++;
749 last;
750 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800751 $off++;
752 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700753 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800754 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700755 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800756 $line++;
757 $remain--;
758 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800759
760 my $statement = substr($blk, $soff, $off - $soff + 1);
761 my $condition = substr($blk, $soff, $coff - $soff + 1);
762
763 #warn "STATEMENT<$statement>\n";
764 #warn "CONDITION<$condition>\n";
765
Andy Whitcroft773647a2008-03-28 14:15:58 -0700766 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800767
768 return ($statement, $condition,
769 $line, $remain + 1, $off - $loff + 1, $level);
770}
771
Andy Whitcroftcf655042008-03-04 14:28:20 -0800772sub statement_lines {
773 my ($stmt) = @_;
774
775 # Strip the diff line prefixes and rip blank lines at start and end.
776 $stmt =~ s/(^|\n)./$1/g;
777 $stmt =~ s/^\s*//;
778 $stmt =~ s/\s*$//;
779
780 my @stmt_lines = ($stmt =~ /\n/g);
781
782 return $#stmt_lines + 2;
783}
784
785sub statement_rawlines {
786 my ($stmt) = @_;
787
788 my @stmt_lines = ($stmt =~ /\n/g);
789
790 return $#stmt_lines + 2;
791}
792
793sub statement_block_size {
794 my ($stmt) = @_;
795
796 $stmt =~ s/(^|\n)./$1/g;
797 $stmt =~ s/^\s*{//;
798 $stmt =~ s/}\s*$//;
799 $stmt =~ s/^\s*//;
800 $stmt =~ s/\s*$//;
801
802 my @stmt_lines = ($stmt =~ /\n/g);
803 my @stmt_statements = ($stmt =~ /;/g);
804
805 my $stmt_lines = $#stmt_lines + 2;
806 my $stmt_statements = $#stmt_statements + 1;
807
808 if ($stmt_lines > $stmt_statements) {
809 return $stmt_lines;
810 } else {
811 return $stmt_statements;
812 }
813}
814
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800815sub ctx_statement_full {
816 my ($linenr, $remain, $off) = @_;
817 my ($statement, $condition, $level);
818
819 my (@chunks);
820
Andy Whitcroftcf655042008-03-04 14:28:20 -0800821 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800822 ($statement, $condition, $linenr, $remain, $off, $level) =
823 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700824 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800825 push(@chunks, [ $condition, $statement ]);
826 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
827 return ($level, $linenr, @chunks);
828 }
829
830 # Pull in the following conditional/block pairs and see if they
831 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800832 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800833 ($statement, $condition, $linenr, $remain, $off, $level) =
834 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800835 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700836 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800837 #print "C: push\n";
838 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800839 }
840
841 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800842}
843
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700844sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700845 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700846 my $line;
847 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700848 my $blk = '';
849 my @o;
850 my @c;
851 my @res = ();
852
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700853 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800854 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700855 for ($line = $start; $remain > 0; $line++) {
856 next if ($rawlines[$line] =~ /^-/);
857 $remain--;
858
859 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800860
861 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700862 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800863 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700864 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800865 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700866 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800867 $level = pop(@stack);
868 }
869
Andy Whitcroft01464f32010-10-26 14:23:19 -0700870 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700871 ##print "C<$c>L<$level><$open$close>O<$off>\n";
872 if ($off > 0) {
873 $off--;
874 next;
875 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700876
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700877 if ($c eq $close && $level > 0) {
878 $level--;
879 last if ($level == 0);
880 } elsif ($c eq $open) {
881 $level++;
882 }
883 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700884
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700885 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700886 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700887 }
888
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700889 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700890 }
891
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700892 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700893}
894sub ctx_block_outer {
895 my ($linenr, $remain) = @_;
896
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700897 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
898 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700899}
900sub ctx_block {
901 my ($linenr, $remain) = @_;
902
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700903 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
904 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700905}
906sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700907 my ($linenr, $remain, $off) = @_;
908
909 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
910 return @r;
911}
912sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700913 my ($linenr, $remain) = @_;
914
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700915 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700916}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700917sub ctx_statement_level {
918 my ($linenr, $remain, $off) = @_;
919
920 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
921}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700922
923sub ctx_locate_comment {
924 my ($first_line, $end_line) = @_;
925
926 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700927 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700928 return $current_comment if (defined $current_comment);
929
930 # Look through the context and try and figure out if there is a
931 # comment.
932 my $in_comment = 0;
933 $current_comment = '';
934 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700935 my $line = $rawlines[$linenr - 1];
936 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700937 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
938 $in_comment = 1;
939 }
940 if ($line =~ m@/\*@) {
941 $in_comment = 1;
942 }
943 if (!$in_comment && $current_comment ne '') {
944 $current_comment = '';
945 }
946 $current_comment .= $line . "\n" if ($in_comment);
947 if ($line =~ m@\*/@) {
948 $in_comment = 0;
949 }
950 }
951
952 chomp($current_comment);
953 return($current_comment);
954}
955sub ctx_has_comment {
956 my ($first_line, $end_line) = @_;
957 my $cmt = ctx_locate_comment($first_line, $end_line);
958
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700959 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700960 ##print "CMMT: $cmt\n";
961
962 return ($cmt ne '');
963}
964
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700965sub raw_line {
966 my ($linenr, $cnt) = @_;
967
968 my $offset = $linenr - 1;
969 $cnt++;
970
971 my $line;
972 while ($cnt) {
973 $line = $rawlines[$offset++];
974 next if (defined($line) && $line =~ /^-/);
975 $cnt--;
976 }
977
978 return $line;
979}
980
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700981sub cat_vet {
982 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700983 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700984
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700985 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700986 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
987 $res .= $1;
988 if ($2 ne '') {
989 $coded = sprintf("^%c", unpack('C', $2) + 64);
990 $res .= $coded;
991 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700992 }
993 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700994
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700995 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700996}
997
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800998my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800999my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001000my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001001my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001002
1003sub annotate_reset {
1004 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001005 $av_pending = '_';
1006 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001007 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001008}
1009
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001010sub annotate_values {
1011 my ($stream, $type) = @_;
1012
1013 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001014 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001015 my $cur = $stream;
1016
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001017 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001018
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001019 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001020 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001021 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001022 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001023 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001024 print "WS($1)\n" if ($dbg_values > 1);
1025 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001026 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001027 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001028 }
1029
Florian Micklerc023e4732011-01-12 16:59:58 -08001030 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001031 print "CAST($1)\n" if ($dbg_values > 1);
1032 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001033 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001034
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001035 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001036 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001037 $type = 'T';
1038
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001039 } elsif ($cur =~ /^($Modifier)\s*/) {
1040 print "MODIFIER($1)\n" if ($dbg_values > 1);
1041 $type = 'T';
1042
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001043 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001044 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001045 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001046 push(@av_paren_type, $type);
1047 if ($2 ne '') {
1048 $av_pending = 'N';
1049 }
1050 $type = 'E';
1051
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001052 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001053 print "UNDEF($1)\n" if ($dbg_values > 1);
1054 $av_preprocessor = 1;
1055 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001056
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001057 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001058 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001059 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001060
1061 push(@av_paren_type, $type);
1062 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001063 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001064
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001065 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001066 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1067 $av_preprocessor = 1;
1068
1069 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1070
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001071 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001072
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001073 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001074 print "PRE_END($1)\n" if ($dbg_values > 1);
1075
1076 $av_preprocessor = 1;
1077
1078 # Assume all arms of the conditional end as this
1079 # one does, and continue as if the #endif was not here.
1080 pop(@av_paren_type);
1081 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001082 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001083
1084 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001085 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001086
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001087 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1088 print "ATTR($1)\n" if ($dbg_values > 1);
1089 $av_pending = $type;
1090 $type = 'N';
1091
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001092 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001093 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001094 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001095 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001096 }
1097 $type = 'N';
1098
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001099 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001100 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001101 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001102 $type = 'N';
1103
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001104 } elsif ($cur =~/^(case)/o) {
1105 print "CASE($1)\n" if ($dbg_values > 1);
1106 $av_pend_colon = 'C';
1107 $type = 'N';
1108
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001109 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001110 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001111 $type = 'N';
1112
1113 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001114 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001115 push(@av_paren_type, $av_pending);
1116 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001117 $type = 'N';
1118
1119 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001120 my $new_type = pop(@av_paren_type);
1121 if ($new_type ne '_') {
1122 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001123 print "PAREN('$1') -> $type\n"
1124 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001125 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001126 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001127 }
1128
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001129 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001130 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001131 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001132 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001133
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001134 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1135 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001136 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001137 } elsif ($type eq 'E') {
1138 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001139 }
1140 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1141 $type = 'V';
1142
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001143 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001144 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001145 $type = 'V';
1146
1147 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001148 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001149 $type = 'N';
1150
Andy Whitcroftcf655042008-03-04 14:28:20 -08001151 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001152 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001153 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001154 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001155
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001156 } elsif ($cur =~/^(,)/) {
1157 print "COMMA($1)\n" if ($dbg_values > 1);
1158 $type = 'C';
1159
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001160 } elsif ($cur =~ /^(\?)/o) {
1161 print "QUESTION($1)\n" if ($dbg_values > 1);
1162 $type = 'N';
1163
1164 } elsif ($cur =~ /^(:)/o) {
1165 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1166
1167 substr($var, length($res), 1, $av_pend_colon);
1168 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1169 $type = 'E';
1170 } else {
1171 $type = 'N';
1172 }
1173 $av_pend_colon = 'O';
1174
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001175 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001176 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001177 $type = 'N';
1178
Andy Whitcroft0d413862008-10-15 22:02:16 -07001179 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001180 my $variant;
1181
1182 print "OPV($1)\n" if ($dbg_values > 1);
1183 if ($type eq 'V') {
1184 $variant = 'B';
1185 } else {
1186 $variant = 'U';
1187 }
1188
1189 substr($var, length($res), 1, $variant);
1190 $type = 'N';
1191
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001192 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001193 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 if ($1 ne '++' && $1 ne '--') {
1195 $type = 'N';
1196 }
1197
1198 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001199 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001200 }
1201 if (defined $1) {
1202 $cur = substr($cur, length($1));
1203 $res .= $type x length($1);
1204 }
1205 }
1206
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001207 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001208}
1209
Andy Whitcroft8905a672007-11-28 16:21:06 -08001210sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001211 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001212 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001213 ^(?:
1214 $Modifier|
1215 $Storage|
1216 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001217 DEFINE_\S+
1218 )$|
1219 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001220 goto|
1221 return|
1222 case|
1223 else|
1224 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001225 do|
1226 \#|
1227 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001228 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001229 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001230 )}x;
1231 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1232 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001233 # Check for modifiers.
1234 $possible =~ s/\s*$Storage\s*//g;
1235 $possible =~ s/\s*$Sparse\s*//g;
1236 if ($possible =~ /^\s*$/) {
1237
1238 } elsif ($possible =~ /\s/) {
1239 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001240 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001241 if ($modifier !~ $notPermitted) {
1242 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1243 push(@modifierList, $modifier);
1244 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001245 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001246
1247 } else {
1248 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1249 push(@typeList, $possible);
1250 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001251 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001252 } else {
1253 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001254 }
1255}
1256
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001257my $prefix = '';
1258
Joe Perches000d1cc12011-07-25 17:13:25 -07001259sub show_type {
1260 return !defined $ignore_type{$_[0]};
1261}
1262
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001263sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001264 if (!show_type($_[1]) ||
1265 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001266 return 0;
1267 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001268 my $line;
1269 if ($show_types) {
1270 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1271 } else {
1272 $line = "$prefix$_[0]: $_[2]\n";
1273 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001274 $line = (split('\n', $line))[0] . "\n" if ($terse);
1275
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001276 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001277
1278 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001279}
1280sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001281 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001282}
Joe Perches000d1cc12011-07-25 17:13:25 -07001283
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001284sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001285 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001286 our $clean = 0;
1287 our $cnt_error++;
1288 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001289}
1290sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001291 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001292 our $clean = 0;
1293 our $cnt_warn++;
1294 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001295}
1296sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001297 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001298 our $clean = 0;
1299 our $cnt_chk++;
1300 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001301}
1302
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001303sub check_absolute_file {
1304 my ($absolute, $herecurr) = @_;
1305 my $file = $absolute;
1306
1307 ##print "absolute<$absolute>\n";
1308
1309 # See if any suffix of this path is a path within the tree.
1310 while ($file =~ s@^[^/]*/@@) {
1311 if (-f "$root/$file") {
1312 ##print "file<$file>\n";
1313 last;
1314 }
1315 }
1316 if (! -f _) {
1317 return 0;
1318 }
1319
1320 # It is, so see if the prefix is acceptable.
1321 my $prefix = $absolute;
1322 substr($prefix, -length($file)) = '';
1323
1324 ##print "prefix<$prefix>\n";
1325 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001326 WARN("USE_RELATIVE_PATH",
1327 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001328 }
1329}
1330
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001331sub pos_last_openparen {
1332 my ($line) = @_;
1333
1334 my $pos = 0;
1335
1336 my $opens = $line =~ tr/\(/\(/;
1337 my $closes = $line =~ tr/\)/\)/;
1338
1339 my $last_openparen = 0;
1340
1341 if (($opens == 0) || ($closes >= $opens)) {
1342 return -1;
1343 }
1344
1345 my $len = length($line);
1346
1347 for ($pos = 0; $pos < $len; $pos++) {
1348 my $string = substr($line, $pos);
1349 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1350 $pos += length($1) - 1;
1351 } elsif (substr($line, $pos, 1) eq '(') {
1352 $last_openparen = $pos;
1353 } elsif (index($string, '(') == -1) {
1354 last;
1355 }
1356 }
1357
1358 return $last_openparen + 1;
1359}
1360
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001361sub process {
1362 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001363
1364 my $linenr=0;
1365 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001366 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001367 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001368 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001369
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001370 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001371 my $indent;
1372 my $previndent=0;
1373 my $stashindent=0;
1374
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001375 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001376 my $signoff = 0;
1377 my $is_patch = 0;
1378
Joe Perches15662b32011-10-31 17:13:12 -07001379 my $in_header_lines = 1;
1380 my $in_commit_log = 0; #Scanning lines before patch
1381
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001382 my $non_utf8_charset = 0;
1383
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001384 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001385 our $cnt_lines = 0;
1386 our $cnt_error = 0;
1387 our $cnt_warn = 0;
1388 our $cnt_chk = 0;
1389
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001390 # Trace the real file/line as we go.
1391 my $realfile = '';
1392 my $realline = 0;
1393 my $realcnt = 0;
1394 my $here = '';
1395 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001396 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001397 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001398 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001399
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001400 my $prev_values = 'E';
1401
1402 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001403 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001404 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001405 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001406 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001407
Joe Perches323c1262012-12-17 16:02:07 -08001408 my %camelcase = ();
1409
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001410 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001411 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001412 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001413 my @setup_docs = ();
1414 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001415
1416 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001417 my $line;
1418 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001419 $linenr++;
1420 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001421
Andy Whitcroft773647a2008-03-28 14:15:58 -07001422 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001423 $setup_docs = 0;
1424 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1425 $setup_docs = 1;
1426 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001427 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001428 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001429 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1430 $realline=$1-1;
1431 if (defined $2) {
1432 $realcnt=$3+1;
1433 } else {
1434 $realcnt=1+1;
1435 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001436 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001437
1438 # Guestimate if this is a continuing comment. Run
1439 # the context looking for a comment "edge". If this
1440 # edge is a close comment then we must be in a comment
1441 # at context start.
1442 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001443 my $cnt = $realcnt;
1444 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1445 next if (defined $rawlines[$ln - 1] &&
1446 $rawlines[$ln - 1] =~ /^-/);
1447 $cnt--;
1448 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001449 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001450 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1451 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1452 ($edge) = $1;
1453 last;
1454 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001455 }
1456 if (defined $edge && $edge eq '*/') {
1457 $in_comment = 1;
1458 }
1459
1460 # Guestimate if this is a continuing comment. If this
1461 # is the start of a diff block and this line starts
1462 # ' *' then it is very likely a comment.
1463 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001464 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001465 {
1466 $in_comment = 1;
1467 }
1468
1469 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1470 sanitise_line_reset($in_comment);
1471
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001472 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001473 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001474 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001475 $line = sanitise_line($rawline);
1476 }
1477 push(@lines, $line);
1478
1479 if ($realcnt > 1) {
1480 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1481 } else {
1482 $realcnt = 0;
1483 }
1484
1485 #print "==>$rawline\n";
1486 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001487
1488 if ($setup_docs && $line =~ /^\+/) {
1489 push(@setup_docs, $line);
1490 }
1491 }
1492
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001493 $prefix = '';
1494
Andy Whitcroft773647a2008-03-28 14:15:58 -07001495 $realcnt = 0;
1496 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001497 foreach my $line (@lines) {
1498 $linenr++;
1499
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001500 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001501
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001502#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001503 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001504 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001505 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001506 $realline=$1-1;
1507 if (defined $2) {
1508 $realcnt=$3+1;
1509 } else {
1510 $realcnt=1+1;
1511 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001512 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001513 $prev_values = 'E';
1514
Andy Whitcroft773647a2008-03-28 14:15:58 -07001515 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001516 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001517 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001518 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001519 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001520
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001521# track the line number as we move through the hunk, note that
1522# new versions of GNU diff omit the leading space on completely
1523# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001524 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001525 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001526 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001527
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001528 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001529 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001530
1531 # Track the previous line.
1532 ($prevline, $stashline) = ($stashline, $line);
1533 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001534 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1535
Andy Whitcroft773647a2008-03-28 14:15:58 -07001536 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001537
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001538 } elsif ($realcnt == 1) {
1539 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001540 }
1541
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001542 my $hunk_line = ($realcnt != 0);
1543
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001544#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001545 $prefix = "$filename:$realline: " if ($emacs && $file);
1546 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1547
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001548 $here = "#$linenr: " if (!$file);
1549 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001550
1551 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001552 if ($line =~ /^diff --git.*?(\S+)$/) {
1553 $realfile = $1;
1554 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001555 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001556 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001557 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001558 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001559 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001560
1561 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001562 if (!$file && $tree && $p1_prefix ne '' &&
1563 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001564 WARN("PATCH_PREFIX",
1565 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001566 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001567
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001568 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001569 ERROR("MODIFIED_INCLUDE_ASM",
1570 "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 -07001571 }
1572 next;
1573 }
1574
Randy Dunlap389834b2007-06-08 13:47:03 -07001575 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001576
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001577 my $hereline = "$here\n$rawline\n";
1578 my $herecurr = "$here\n$rawline\n";
1579 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001580
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001581 $cnt_lines++ if ($realcnt != 0);
1582
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001583# Check for incorrect file permissions
1584 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1585 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001586 if ($realfile !~ m@scripts/@ &&
1587 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001588 ERROR("EXECUTE_PERMISSIONS",
1589 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001590 }
1591 }
1592
Joe Perches20112472011-07-25 17:13:23 -07001593# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001594 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001595 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001596 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001597 }
1598
1599# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001600 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001601 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001602 my $space_before = $1;
1603 my $sign_off = $2;
1604 my $space_after = $3;
1605 my $email = $4;
1606 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1607
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001608 if ($sign_off !~ /$signature_tags/) {
1609 WARN("BAD_SIGN_OFF",
1610 "Non-standard signature: $sign_off\n" . $herecurr);
1611 }
Joe Perches20112472011-07-25 17:13:23 -07001612 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001613 WARN("BAD_SIGN_OFF",
1614 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001615 }
Joe Perches20112472011-07-25 17:13:23 -07001616 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001617 WARN("BAD_SIGN_OFF",
1618 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001619 }
1620 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001621 WARN("BAD_SIGN_OFF",
1622 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001623 }
1624
1625 my ($email_name, $email_address, $comment) = parse_email($email);
1626 my $suggested_email = format_email(($email_name, $email_address));
1627 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001628 ERROR("BAD_SIGN_OFF",
1629 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001630 } else {
1631 my $dequoted = $suggested_email;
1632 $dequoted =~ s/^"//;
1633 $dequoted =~ s/" </ </;
1634 # Don't force email to have quotes
1635 # Allow just an angle bracketed address
1636 if ("$dequoted$comment" ne $email &&
1637 "<$email_address>$comment" ne $email &&
1638 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001639 WARN("BAD_SIGN_OFF",
1640 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001641 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001642 }
1643 }
1644
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001645# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001646 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001647 ERROR("CORRUPTED_PATCH",
1648 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001649 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001650 }
1651
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001652# Check for absolute kernel paths.
1653 if ($tree) {
1654 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1655 my $file = $1;
1656
1657 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1658 check_absolute_file($1, $herecurr)) {
1659 #
1660 } else {
1661 check_absolute_file($file, $herecurr);
1662 }
1663 }
1664 }
1665
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001666# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1667 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001668 $rawline !~ m/^$UTF8*$/) {
1669 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1670
1671 my $blank = copy_spacing($rawline);
1672 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1673 my $hereptr = "$hereline$ptr\n";
1674
Joe Perches34d99212011-07-25 17:13:26 -07001675 CHK("INVALID_UTF8",
1676 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001677 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001678
Joe Perches15662b32011-10-31 17:13:12 -07001679# Check if it's the start of a commit log
1680# (not a header line and we haven't seen the patch filename)
1681 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001682 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001683 $in_header_lines = 0;
1684 $in_commit_log = 1;
1685 }
1686
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001687# Check if there is UTF-8 in a commit log when a mail header has explicitly
1688# declined it, i.e defined some charset where it is missing.
1689 if ($in_header_lines &&
1690 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1691 $1 !~ /utf-8/i) {
1692 $non_utf8_charset = 1;
1693 }
1694
1695 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001696 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001697 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001698 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1699 }
1700
Andy Whitcroft306708542008-10-15 22:02:28 -07001701# ignore non-hunk lines and lines being removed
1702 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001703
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001704#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001705 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001706 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001707 ERROR("DOS_LINE_ENDINGS",
1708 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001709
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001710 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1711 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001712 ERROR("TRAILING_WHITESPACE",
1713 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001714 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001715 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001716
Andi Kleen33549572010-05-24 14:33:29 -07001717# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001718# Only applies when adding the entry originally, after that we do not have
1719# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001720 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001721 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001722 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001723 my $cnt = $realcnt;
1724 my $ln = $linenr + 1;
1725 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001726 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001727 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001728 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001729 $f = $lines[$ln - 1];
1730 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1731 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001732
1733 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001734
1735 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1736 $is_start = 1;
1737 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1738 $length = -1;
1739 }
1740
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001741 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001742 $f =~ s/#.*//;
1743 $f =~ s/^\s+//;
1744 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001745 if ($f =~ /^\s*config\s/) {
1746 $is_end = 1;
1747 last;
1748 }
Andi Kleen33549572010-05-24 14:33:29 -07001749 $length++;
1750 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001751 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001752 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1753 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001754 }
1755
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001756# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1757 if ($realfile =~ /Kconfig/ &&
1758 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1759 WARN("CONFIG_EXPERIMENTAL",
1760 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1761 }
1762
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001763 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1764 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1765 my $flag = $1;
1766 my $replacement = {
1767 'EXTRA_AFLAGS' => 'asflags-y',
1768 'EXTRA_CFLAGS' => 'ccflags-y',
1769 'EXTRA_CPPFLAGS' => 'cppflags-y',
1770 'EXTRA_LDFLAGS' => 'ldflags-y',
1771 };
1772
1773 WARN("DEPRECATED_VARIABLE",
1774 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1775 }
1776
Andy Whitcroft5368df202008-10-15 22:02:27 -07001777# check we are in a valid source file if not then ignore this hunk
1778 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1779
Joe Perches6cd7f382012-12-17 16:01:54 -08001780#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001781 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001782 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001783 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001784 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08001785 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001786 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001787 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08001788 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001789 }
1790
Josh Triplettca56dc02012-03-23 15:02:21 -07001791# Check for user-visible strings broken across lines, which breaks the ability
1792# to grep for the string. Limited to strings used as parameters (those
1793# following an open parenthesis), which almost completely eliminates false
1794# positives, as well as warning only once per parameter rather than once per
1795# line of the string. Make an exception when the previous string ends in a
1796# newline (multiple lines in one string constant) or \n\t (common in inline
1797# assembly to indent the instruction on the following line).
1798 if ($line =~ /^\+\s*"/ &&
1799 $prevline =~ /"\s*$/ &&
1800 $prevline =~ /\(/ &&
1801 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1802 WARN("SPLIT_STRING",
1803 "quoted string split across lines\n" . $hereprev);
1804 }
1805
Joe Perches5e79d962010-03-05 13:43:55 -08001806# check for spaces before a quoted newline
1807 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001808 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1809 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001810 }
1811
Andy Whitcroft8905a672007-11-28 16:21:06 -08001812# check for adding lines without a newline.
1813 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001814 WARN("MISSING_EOF_NEWLINE",
1815 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001816 }
1817
Mike Frysinger42e41c52009-09-21 17:04:40 -07001818# Blackfin: use hi/lo macros
1819 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1820 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1821 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001822 ERROR("LO_MACRO",
1823 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001824 }
1825 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1826 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001827 ERROR("HI_MACRO",
1828 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001829 }
1830 }
1831
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001832# check we are in a valid source file C or perl if not then ignore this hunk
1833 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001834
1835# at the beginning of a line any tabs must come first and anything
1836# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001837 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1838 $rawline =~ /^\+\s* \s*/) {
1839 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001840 ERROR("CODE_INDENT",
1841 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001842 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001843 }
1844
Alberto Panizzo08e44362010-03-05 13:43:54 -08001845# check for space before tabs.
1846 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1847 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001848 WARN("SPACE_BEFORE_TAB",
1849 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001850 }
1851
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001852# check for && or || at the start of a line
1853 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1854 CHK("LOGICAL_CONTINUATIONS",
1855 "Logical continuations should be on the previous line\n" . $hereprev);
1856 }
1857
1858# check multi-line statement indentation matches previous line
1859 if ($^V && $^V ge 5.10.0 &&
1860 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1861 $prevline =~ /^\+(\t*)(.*)$/;
1862 my $oldindent = $1;
1863 my $rest = $2;
1864
1865 my $pos = pos_last_openparen($rest);
1866 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07001867 $line =~ /^(\+| )([ \t]*)/;
1868 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001869
1870 my $goodtabindent = $oldindent .
1871 "\t" x ($pos / 8) .
1872 " " x ($pos % 8);
1873 my $goodspaceindent = $oldindent . " " x $pos;
1874
1875 if ($newindent ne $goodtabindent &&
1876 $newindent ne $goodspaceindent) {
1877 CHK("PARENTHESIS_ALIGNMENT",
1878 "Alignment should match open parenthesis\n" . $hereprev);
1879 }
1880 }
1881 }
1882
Joe Perchesaad4f612012-03-23 15:02:19 -07001883 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1884 CHK("SPACING",
1885 "No space is necessary after a cast\n" . $hereprev);
1886 }
1887
Joe Perches05880602012-10-04 17:13:35 -07001888 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1889 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1890 $prevrawline =~ /^\+[ \t]*$/) {
1891 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1892 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1893 }
1894
1895 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08001896 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1897 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1898 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1899 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07001900 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1901 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1902 }
1903
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001904# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001905# Exceptions:
1906# 1) within comments
1907# 2) indented preprocessor commands
1908# 3) hanging labels
1909 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001910 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001911 WARN("LEADING_SPACE",
1912 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001913 }
1914
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001915# check we are in a valid C source file if not then ignore this hunk
1916 next if ($realfile !~ /\.(h|c)$/);
1917
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001918# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1919 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1920 WARN("CONFIG_EXPERIMENTAL",
1921 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1922 }
1923
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001924# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001925 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001926 WARN("CVS_KEYWORD",
1927 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001928 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001929
Mike Frysinger42e41c52009-09-21 17:04:40 -07001930# Blackfin: don't use __builtin_bfin_[cs]sync
1931 if ($line =~ /__builtin_bfin_csync/) {
1932 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001933 ERROR("CSYNC",
1934 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001935 }
1936 if ($line =~ /__builtin_bfin_ssync/) {
1937 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001938 ERROR("SSYNC",
1939 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001940 }
1941
Joe Perches56e77d72013-02-21 16:44:14 -08001942# check for old HOTPLUG __dev<foo> section markings
1943 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
1944 WARN("HOTPLUG_SECTION",
1945 "Using $1 is unnecessary\n" . $herecurr);
1946 }
1947
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001948# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001949 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1950 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001951#print "LINE<$line>\n";
1952 if ($linenr >= $suppress_statement &&
1953 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001954 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001955 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001956 $stat =~ s/\n./\n /g;
1957 $cond =~ s/\n./\n /g;
1958
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001959#print "linenr<$linenr> <$stat>\n";
1960 # If this statement has no statement boundaries within
1961 # it there is no point in retrying a statement scan
1962 # until we hit end of it.
1963 my $frag = $stat; $frag =~ s/;+\s*$//;
1964 if ($frag !~ /(?:{|;)/) {
1965#print "skip<$line_nr_next>\n";
1966 $suppress_statement = $line_nr_next;
1967 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001968
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001969 # Find the real next line.
1970 $realline_next = $line_nr_next;
1971 if (defined $realline_next &&
1972 (!defined $lines[$realline_next - 1] ||
1973 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1974 $realline_next++;
1975 }
1976
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001977 my $s = $stat;
1978 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001979
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001980 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001981 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001982
1983 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001984 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001985
Andy Whitcroft463f2862009-09-21 17:04:34 -07001986 } elsif ($s =~ /^.\s*else\b/s) {
1987
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001988 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001989 } 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 -07001990 my $type = $1;
1991 $type =~ s/\s+/ /g;
1992 possible($type, "A:" . $s);
1993
Andy Whitcroft8905a672007-11-28 16:21:06 -08001994 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001995 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001996 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001997 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001998
1999 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002000 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002001 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002002 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002003
2004 # Check for any sort of function declaration.
2005 # int foo(something bar, other baz);
2006 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002007 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 -08002008 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002009
Andy Whitcroftcf655042008-03-04 14:28:20 -08002010 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002011 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002012 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002013
Andy Whitcroft8905a672007-11-28 16:21:06 -08002014 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002015 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002016
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002017 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002018 }
2019 }
2020 }
2021
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002022 }
2023
Andy Whitcroft653d4872007-06-23 17:16:34 -07002024#
2025# Checks which may be anchored in the context.
2026#
2027
2028# Check for switch () and associated case and default
2029# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002030 if ($line=~/\bswitch\s*\(.*\)/) {
2031 my $err = '';
2032 my $sep = '';
2033 my @ctx = ctx_block_outer($linenr, $realcnt);
2034 shift(@ctx);
2035 for my $ctx (@ctx) {
2036 my ($clen, $cindent) = line_stats($ctx);
2037 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2038 $indent != $cindent) {
2039 $err .= "$sep$ctx\n";
2040 $sep = '';
2041 } else {
2042 $sep = "[...]\n";
2043 }
2044 }
2045 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002046 ERROR("SWITCH_CASE_INDENT_LEVEL",
2047 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002048 }
2049 }
2050
2051# if/while/etc brace do not go on next line, unless defining a do while loop,
2052# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002053 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002054 my $pre_ctx = "$1$2";
2055
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002056 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002057
2058 if ($line =~ /^\+\t{6,}/) {
2059 WARN("DEEP_INDENTATION",
2060 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2061 }
2062
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002063 my $ctx_cnt = $realcnt - $#ctx - 1;
2064 my $ctx = join("\n", @ctx);
2065
Andy Whitcroft548596d2008-07-23 21:29:01 -07002066 my $ctx_ln = $linenr;
2067 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002068
Andy Whitcroft548596d2008-07-23 21:29:01 -07002069 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2070 defined $lines[$ctx_ln - 1] &&
2071 $lines[$ctx_ln - 1] =~ /^-/)) {
2072 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2073 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002074 $ctx_ln++;
2075 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002076
Andy Whitcroft53210162008-07-23 21:29:03 -07002077 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2078 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002079
2080 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002081 ERROR("OPEN_BRACE",
2082 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002083 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002084 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002085 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2086 $ctx =~ /\)\s*\;\s*$/ &&
2087 defined $lines[$ctx_ln - 1])
2088 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002089 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2090 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002091 WARN("TRAILING_SEMICOLON",
2092 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002093 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002094 }
2095 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002096 }
2097
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002098# Check relative indent for conditionals and blocks.
2099 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002100 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2101 ctx_statement_block($linenr, $realcnt, 0)
2102 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002103 my ($s, $c) = ($stat, $cond);
2104
2105 substr($s, 0, length($c), '');
2106
2107 # Make sure we remove the line prefixes as we have
2108 # none on the first line, and are going to readd them
2109 # where necessary.
2110 $s =~ s/\n./\n/gs;
2111
2112 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002113 my @newlines = ($c =~ /\n/gs);
2114 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002115
2116 # We want to check the first line inside the block
2117 # starting at the end of the conditional, so remove:
2118 # 1) any blank line termination
2119 # 2) any opening brace { on end of the line
2120 # 3) any do (...) {
2121 my $continuation = 0;
2122 my $check = 0;
2123 $s =~ s/^.*\bdo\b//;
2124 $s =~ s/^\s*{//;
2125 if ($s =~ s/^\s*\\//) {
2126 $continuation = 1;
2127 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002128 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002129 $check = 1;
2130 $cond_lines++;
2131 }
2132
2133 # Also ignore a loop construct at the end of a
2134 # preprocessor statement.
2135 if (($prevline =~ /^.\s*#\s*define\s/ ||
2136 $prevline =~ /\\\s*$/) && $continuation == 0) {
2137 $check = 0;
2138 }
2139
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002140 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002141 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002142 while ($cond_ptr != $cond_lines) {
2143 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002144
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002145 # If we see an #else/#elif then the code
2146 # is not linear.
2147 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2148 $check = 0;
2149 }
2150
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002151 # Ignore:
2152 # 1) blank lines, they should be at 0,
2153 # 2) preprocessor lines, and
2154 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002155 if ($continuation ||
2156 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002157 $s =~ /^\s*#\s*?/ ||
2158 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002159 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002160 if ($s =~ s/^.*?\n//) {
2161 $cond_lines++;
2162 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002163 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002164 }
2165
2166 my (undef, $sindent) = line_stats("+" . $s);
2167 my $stat_real = raw_line($linenr, $cond_lines);
2168
2169 # Check if either of these lines are modified, else
2170 # this is not this patch's fault.
2171 if (!defined($stat_real) ||
2172 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2173 $check = 0;
2174 }
2175 if (defined($stat_real) && $cond_lines > 1) {
2176 $stat_real = "[...]\n$stat_real";
2177 }
2178
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002179 #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 -07002180
2181 if ($check && (($sindent % 8) != 0 ||
2182 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002183 WARN("SUSPECT_CODE_INDENT",
2184 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002185 }
2186 }
2187
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002188 # Track the 'values' across context and added lines.
2189 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002190 my ($curr_values, $curr_vars) =
2191 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002192 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002193 if ($dbg_values) {
2194 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002195 print "$linenr > .$outline\n";
2196 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002197 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002198 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002199 $prev_values = substr($curr_values, -1);
2200
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002201#ignore lines not being added
2202 if ($line=~/^[^\+]/) {next;}
2203
Andy Whitcroft653d4872007-06-23 17:16:34 -07002204# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002205 if ($dbg_type) {
2206 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002207 ERROR("TEST_TYPE",
2208 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002209 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002210 ERROR("TEST_NOT_TYPE",
2211 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002212 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002213 next;
2214 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002215# TEST: allow direct testing of the attribute matcher.
2216 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002217 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002218 ERROR("TEST_ATTR",
2219 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002220 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002221 ERROR("TEST_NOT_ATTR",
2222 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002223 }
2224 next;
2225 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002226
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002227# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002228 if ($line =~ /^.\s*{/ &&
2229 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002230 ERROR("OPEN_BRACE",
2231 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002232 }
2233
Andy Whitcroft653d4872007-06-23 17:16:34 -07002234#
2235# Checks which are anchored on the added line.
2236#
2237
2238# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002239 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002240 my $path = $1;
2241 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002242 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002243 "malformed #include filename\n" . $herecurr);
2244 }
2245 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2246 ERROR("UAPI_INCLUDE",
2247 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002248 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002249 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002250
2251# no C99 // comments
2252 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002253 ERROR("C99_COMMENTS",
2254 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002255 }
2256 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002257 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002258 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002259
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002260# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2261# the whole statement.
2262#print "APW <$lines[$realline_next - 1]>\n";
2263 if (defined $realline_next &&
2264 exists $lines[$realline_next - 1] &&
2265 !defined $suppress_export{$realline_next} &&
2266 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2267 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002268 # Handle definitions which produce identifiers with
2269 # a prefix:
2270 # XXX(foo);
2271 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002272 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002273 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002274 $name =~ /^${Ident}_$2/) {
2275#print "FOO C name<$name>\n";
2276 $suppress_export{$realline_next} = 1;
2277
2278 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002279 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002280 ^.DEFINE_$Ident\(\Q$name\E\)|
2281 ^.DECLARE_$Ident\(\Q$name\E\)|
2282 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002283 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2284 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002285 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002286#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2287 $suppress_export{$realline_next} = 2;
2288 } else {
2289 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002290 }
2291 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002292 if (!defined $suppress_export{$linenr} &&
2293 $prevline =~ /^.\s*$/ &&
2294 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2295 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2296#print "FOO B <$lines[$linenr - 1]>\n";
2297 $suppress_export{$linenr} = 2;
2298 }
2299 if (defined $suppress_export{$linenr} &&
2300 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002301 WARN("EXPORT_SYMBOL",
2302 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002303 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002304
Joe Eloff5150bda2010-08-09 17:21:00 -07002305# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002306 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002307 ERROR("GLOBAL_INITIALISERS",
2308 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002309 $herecurr);
2310 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002311# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002312 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002313 ERROR("INITIALISED_STATIC",
2314 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002315 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002316 }
2317
Joe Perchescb710ec2010-10-26 14:23:20 -07002318# check for static const char * arrays.
2319 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002320 WARN("STATIC_CONST_CHAR_ARRAY",
2321 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002322 $herecurr);
2323 }
2324
2325# check for static char foo[] = "bar" declarations.
2326 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002327 WARN("STATIC_CONST_CHAR_ARRAY",
2328 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002329 $herecurr);
2330 }
2331
Joe Perches93ed0e22010-10-26 14:23:21 -07002332# check for declarations of struct pci_device_id
2333 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002334 WARN("DEFINE_PCI_DEVICE_TABLE",
2335 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002336 }
2337
Andy Whitcroft653d4872007-06-23 17:16:34 -07002338# check for new typedefs, only function parameters and sparse annotations
2339# make sense.
2340 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002341 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002342 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002343 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002344 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002345 WARN("NEW_TYPEDEFS",
2346 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002347 }
2348
2349# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002350 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002351 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2352 #print "AA<$1>\n";
2353 my ($from, $to) = ($2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002354
Andy Whitcroft65863862009-01-06 14:41:21 -08002355 # Should start with a space.
2356 $to =~ s/^(\S)/ $1/;
2357 # Should not end with a space.
2358 $to =~ s/\s+$//;
2359 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002360 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002361 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002362
Andy Whitcroft65863862009-01-06 14:41:21 -08002363 #print "from<$from> to<$to>\n";
2364 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002365 ERROR("POINTER_LOCATION",
2366 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002367 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002368 }
2369 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2370 #print "BB<$1>\n";
2371 my ($from, $to, $ident) = ($2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002372
Andy Whitcroft65863862009-01-06 14:41:21 -08002373 # Should start with a space.
2374 $to =~ s/^(\S)/ $1/;
2375 # Should not end with a space.
2376 $to =~ s/\s+$//;
2377 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002378 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002379 }
2380 # Modifiers should have spaces.
2381 $to =~ s/(\b$Modifier$)/$1 /;
2382
Andy Whitcroft667026e2009-02-27 14:03:08 -08002383 #print "from<$from> to<$to> ident<$ident>\n";
2384 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002385 ERROR("POINTER_LOCATION",
2386 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002387 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002388 }
2389
2390# # no BUG() or BUG_ON()
2391# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2392# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2393# print "$herecurr";
2394# $clean = 0;
2395# }
2396
Andy Whitcroft8905a672007-11-28 16:21:06 -08002397 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002398 WARN("LINUX_VERSION_CODE",
2399 "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 -08002400 }
2401
Joe Perches17441222011-06-15 15:08:17 -07002402# check for uses of printk_ratelimit
2403 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002404 WARN("PRINTK_RATELIMITED",
2405"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002406 }
2407
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002408# printk should use KERN_* levels. Note that follow on printk's on the
2409# same line do not need a level, so we use the current block context
2410# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002411# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002412# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002413 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002414 my $ok = 0;
2415 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2416 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002417 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002418 # with "\n" ignore it, else it is to blame
2419 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2420 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2421 $ok = 1;
2422 }
2423 last;
2424 }
2425 }
2426 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002427 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2428 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002429 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002430 }
2431
Joe Perches243f3802012-05-31 16:26:09 -07002432 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2433 my $orig = $1;
2434 my $level = lc($orig);
2435 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002436 my $level2 = $level;
2437 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002438 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002439 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002440 }
2441
2442 if ($line =~ /\bpr_warning\s*\(/) {
2443 WARN("PREFER_PR_LEVEL",
2444 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2445 }
2446
Joe Perchesdc139312013-02-21 16:44:13 -08002447 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2448 my $orig = $1;
2449 my $level = lc($orig);
2450 $level = "warn" if ($level eq "warning");
2451 $level = "dbg" if ($level eq "debug");
2452 WARN("PREFER_DEV_LEVEL",
2453 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2454 }
2455
Andy Whitcroft653d4872007-06-23 17:16:34 -07002456# function brace can't be on same line, except for #defines of do while,
2457# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002458 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2459 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002460 ERROR("OPEN_BRACE",
2461 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002462 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002463
Andy Whitcroft8905a672007-11-28 16:21:06 -08002464# open braces for enum, union and struct go on the same line.
2465 if ($line =~ /^.\s*{/ &&
2466 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002467 ERROR("OPEN_BRACE",
2468 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002469 }
2470
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002471# missing space after union, struct or enum definition
2472 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002473 WARN("SPACING",
2474 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002475 }
2476
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002477# check for spacing round square brackets; allowed:
2478# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002479# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2480# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002481 while ($line =~ /(.*?\s)\[/g) {
2482 my ($where, $prefix) = ($-[1], $1);
2483 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002484 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002485 $prefix !~ /[{,]\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002486 ERROR("BRACKET_SPACE",
2487 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002488 }
2489 }
2490
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002491# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002492 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002493 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002494 my $ctx_before = substr($line, 0, $-[1]);
2495 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002496
2497 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002498 if ($name =~ /^(?:
2499 if|for|while|switch|return|case|
2500 volatile|__volatile__|
2501 __attribute__|format|__extension__|
2502 asm|__asm__)$/x)
2503 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002504
2505 # cpp #define statements have non-optional spaces, ie
2506 # if there is a space between the name and the open
2507 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002508 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002509
2510 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002511 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002512
2513 # If this whole things ends with a type its most
2514 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002515 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002516
2517 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002518 WARN("SPACING",
2519 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002520 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002521 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002522
2523# check for whitespace before a non-naked semicolon
2524 if ($line =~ /^\+.*\S\s+;/) {
2525 CHK("SPACING",
2526 "space prohibited before semicolon\n" . $herecurr);
2527 }
2528
Andy Whitcroft653d4872007-06-23 17:16:34 -07002529# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002530 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002531 my $ops = qr{
2532 <<=|>>=|<=|>=|==|!=|
2533 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2534 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002535 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2536 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002537 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002538 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002539 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002540
2541 my $blank = copy_spacing($opline);
2542
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002543 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002544 $off += length($elements[$n]);
2545
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002546 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002547 my $ca = substr($opline, 0, $off);
2548 my $cc = '';
2549 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2550 $cc = substr($opline, $off + length($elements[$n + 1]));
2551 }
2552 my $cb = "$ca$;$cc";
2553
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002554 my $a = '';
2555 $a = 'V' if ($elements[$n] ne '');
2556 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002557 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002558 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2559 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002560 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002561
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002562 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002563
2564 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002565 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002566 $c = 'V' if ($elements[$n + 2] ne '');
2567 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002568 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002569 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2570 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002571 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002572 } else {
2573 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002574 }
2575
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002576 my $ctx = "${a}x${c}";
2577
2578 my $at = "(ctx:$ctx)";
2579
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002580 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002581 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002582
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002583 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002584 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002585
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002586 # Get the full operator variant.
2587 my $opv = $op . substr($curr_vars, $off, 1);
2588
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002589 # Ignore operators passed as parameters.
2590 if ($op_type ne 'V' &&
2591 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2592
Andy Whitcroftcf655042008-03-04 14:28:20 -08002593# # Ignore comments
2594# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002595
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002596 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002597 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002598 if ($ctx !~ /.x[WEBC]/ &&
2599 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002600 ERROR("SPACING",
2601 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002602 }
2603
2604 # // is a comment
2605 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002606
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002607 # No spaces for:
2608 # ->
2609 # : when part of a bitfield
2610 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002611 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002612 ERROR("SPACING",
2613 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002614 }
2615
2616 # , must have a space on the right.
2617 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002618 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002619 ERROR("SPACING",
2620 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002621 }
2622
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002623 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002624 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002625 #warn "'*' is part of type\n";
2626
2627 # unary operators should have a space before and
2628 # none after. May be left adjacent to another
2629 # unary operator, or a cast
2630 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002631 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002632 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002633 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002634 ERROR("SPACING",
2635 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002636 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002637 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002638 # A unary '*' may be const
2639
2640 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002641 ERROR("SPACING",
2642 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002643 }
2644
2645 # unary ++ and unary -- are allowed no space on one side.
2646 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002647 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002648 ERROR("SPACING",
2649 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002650 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002651 if ($ctx =~ /Wx[BE]/ ||
2652 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002653 ERROR("SPACING",
2654 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002655 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002656 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002657 ERROR("SPACING",
2658 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002659 }
2660
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002661
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002662 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002663 } elsif ($op eq '<<' or $op eq '>>' or
2664 $op eq '&' or $op eq '^' or $op eq '|' or
2665 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002666 $op eq '*' or $op eq '/' or
2667 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002668 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002669 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002670 ERROR("SPACING",
2671 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002672 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002673 }
2674
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002675 # A colon needs no spaces before when it is
2676 # terminating a case value or a label.
2677 } elsif ($opv eq ':C' || $opv eq ':L') {
2678 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002679 ERROR("SPACING",
2680 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002681 }
2682
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002683 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002684 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002685 my $ok = 0;
2686
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002687 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002688 if (($op eq '<' &&
2689 $cc =~ /^\S+\@\S+>/) ||
2690 ($op eq '>' &&
2691 $ca =~ /<\S+\@\S+$/))
2692 {
2693 $ok = 1;
2694 }
2695
2696 # Ignore ?:
2697 if (($opv eq ':O' && $ca =~ /\?$/) ||
2698 ($op eq '?' && $cc =~ /^:/)) {
2699 $ok = 1;
2700 }
2701
2702 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002703 ERROR("SPACING",
2704 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002705 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002706 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002707 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002708 }
2709 }
2710
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002711# check for multiple assignments
2712 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002713 CHK("MULTIPLE_ASSIGNMENTS",
2714 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002715 }
2716
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002717## # check for multiple declarations, allowing for a function declaration
2718## # continuation.
2719## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2720## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2721##
2722## # Remove any bracketed sections to ensure we do not
2723## # falsly report the parameters of functions.
2724## my $ln = $line;
2725## while ($ln =~ s/\([^\(\)]*\)//g) {
2726## }
2727## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002728## WARN("MULTIPLE_DECLARATION",
2729## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002730## }
2731## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002732
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002733#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002734 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2735 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002736 ERROR("SPACING",
2737 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002738 }
2739
2740# closing brace should have a space following it when it has anything
2741# on the line
2742 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002743 ERROR("SPACING",
2744 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002745 }
2746
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002747# check spacing on square brackets
2748 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002749 ERROR("SPACING",
2750 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002751 }
2752 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002753 ERROR("SPACING",
2754 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002755 }
2756
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002757# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002758 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2759 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002760 ERROR("SPACING",
2761 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002762 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002763 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002764 $line !~ /for\s*\(.*;\s+\)/ &&
2765 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002766 ERROR("SPACING",
2767 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002768 }
2769
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002770#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002771 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002772 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002773 WARN("INDENTED_LABEL",
2774 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002775 }
2776
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002777# Return is not a function.
2778 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2779 my $spacing = $1;
2780 my $value = $2;
2781
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002782 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002783 $value =~ s/\(/ \(/g;
2784 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08002785 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002786 $value !~ /(?:$Ident|-?$Constant)\s*
2787 $Compare\s*
2788 (?:$Ident|-?$Constant)/x &&
2789 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002790 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002791#print "value<$value>\n";
2792 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002793 ERROR("RETURN_PARENTHESES",
2794 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002795
2796 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002797 ERROR("SPACING",
2798 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002799 }
2800 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002801# Return of what appears to be an errno should normally be -'ve
2802 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2803 my $name = $1;
2804 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002805 WARN("USE_NEGATIVE_ERRNO",
2806 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002807 }
2808 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002809
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002810# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002811 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002812 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002813 }
2814
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002815# Check for illegal assignment in if conditional -- and check for trailing
2816# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002817 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002818 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2819 ctx_statement_block($linenr, $realcnt, 0)
2820 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002821 my ($stat_next) = ctx_statement_block($line_nr_next,
2822 $remain_next, $off_next);
2823 $stat_next =~ s/\n./\n /g;
2824 ##print "stat<$stat> stat_next<$stat_next>\n";
2825
2826 if ($stat_next =~ /^\s*while\b/) {
2827 # If the statement carries leading newlines,
2828 # then count those as offsets.
2829 my ($whitespace) =
2830 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2831 my $offset =
2832 statement_rawlines($whitespace) - 1;
2833
2834 $suppress_whiletrailers{$line_nr_next +
2835 $offset} = 1;
2836 }
2837 }
2838 if (!defined $suppress_whiletrailers{$linenr} &&
2839 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002840 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002841
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002842 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002843 ERROR("ASSIGN_IN_IF",
2844 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002845 }
2846
2847 # Find out what is on the end of the line after the
2848 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002849 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002850 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002851 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002852 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2853 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002854 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002855 # Find out how long the conditional actually is.
2856 my @newlines = ($c =~ /\n/gs);
2857 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002858 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002859
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002860 $stat_real = raw_line($linenr, $cond_lines)
2861 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002862 if (defined($stat_real) && $cond_lines > 1) {
2863 $stat_real = "[...]\n$stat_real";
2864 }
2865
Joe Perches000d1cc12011-07-25 17:13:25 -07002866 ERROR("TRAILING_STATEMENTS",
2867 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002868 }
2869 }
2870
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002871# Check for bitwise tests written as boolean
2872 if ($line =~ /
2873 (?:
2874 (?:\[|\(|\&\&|\|\|)
2875 \s*0[xX][0-9]+\s*
2876 (?:\&\&|\|\|)
2877 |
2878 (?:\&\&|\|\|)
2879 \s*0[xX][0-9]+\s*
2880 (?:\&\&|\|\||\)|\])
2881 )/x)
2882 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002883 WARN("HEXADECIMAL_BOOLEAN_TEST",
2884 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002885 }
2886
Andy Whitcroft8905a672007-11-28 16:21:06 -08002887# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002888 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2889 my $s = $1;
2890 $s =~ s/$;//g; # Remove any comments
2891 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002892 ERROR("TRAILING_STATEMENTS",
2893 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002894 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002895 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002896# if should not continue a brace
2897 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002898 ERROR("TRAILING_STATEMENTS",
2899 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002900 $herecurr);
2901 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002902# case and default should not have general statements after them
2903 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2904 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002905 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002906 \s*return\s+
2907 )/xg)
2908 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002909 ERROR("TRAILING_STATEMENTS",
2910 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002911 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002912
2913 # Check for }<nl>else {, these must be at the same
2914 # indent level to be relevant to each other.
2915 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2916 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002917 ERROR("ELSE_AFTER_BRACE",
2918 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002919 }
2920
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002921 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2922 $previndent == $indent) {
2923 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2924
2925 # Find out what is on the end of the line after the
2926 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002927 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002928 $s =~ s/\n.*//g;
2929
2930 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002931 ERROR("WHILE_AFTER_BRACE",
2932 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002933 }
2934 }
2935
Joe Perches323c1262012-12-17 16:02:07 -08002936#CamelCase
2937 while ($line =~ m{($Constant|$Lval)}g) {
2938 my $var = $1;
2939 if ($var !~ /$Constant/ &&
2940 $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ &&
Joe Perchesbe987d92013-02-27 17:02:38 -08002941 $var !~ /"^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches323c1262012-12-17 16:02:07 -08002942 !defined $camelcase{$var}) {
2943 $camelcase{$var} = 1;
2944 WARN("CAMELCASE",
2945 "Avoid CamelCase: <$var>\n" . $herecurr);
2946 }
2947 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002948
2949#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002950 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002951 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2952 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002953 }
2954
Andy Whitcroft653d4872007-06-23 17:16:34 -07002955#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002956 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002957 my $file = "$1.h";
2958 my $checkfile = "include/linux/$file";
2959 if (-f "$root/$checkfile" &&
2960 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002961 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002962 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002963 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002964 CHK("ARCH_INCLUDE_LINUX",
2965 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002966 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002967 WARN("INCLUDE_LINUX",
2968 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002969 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002970 }
2971 }
2972
Andy Whitcroft653d4872007-06-23 17:16:34 -07002973# multi-statement macros should be enclosed in a do while loop, grab the
2974# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002975# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002976 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2977 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002978 my $ln = $linenr;
2979 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002980 my ($off, $dstat, $dcond, $rest);
2981 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002982 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002983 ctx_statement_block($linenr, $realcnt, 0);
2984 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002985 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002986 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002987
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002988 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002989 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002990 $dstat =~ s/\\\n.//g;
2991 $dstat =~ s/^\s*//s;
2992 $dstat =~ s/\s*$//s;
2993
2994 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002995 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2996 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08002997 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002998 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002999 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003000
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003001 # Flatten any obvious string concatentation.
3002 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3003 $dstat =~ s/$Ident\s*("X*")/$1/)
3004 {
3005 }
3006
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003007 my $exceptions = qr{
3008 $Declare|
3009 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003010 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003011 DECLARE_PER_CPU|
3012 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003013 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003014 union|
3015 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003016 \.$Ident\s*=\s*|
3017 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003018 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003019 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003020 if ($dstat ne '' &&
3021 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3022 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Andy Whitcroftfd1b57a2012-03-23 15:02:18 -07003023 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003024 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003025 $dstat !~ /$exceptions/ &&
3026 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003027 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003028 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003029 $dstat !~ /^for\s*$Constant$/ && # for (...)
3030 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3031 $dstat !~ /^do\s*{/ && # do {...
3032 $dstat !~ /^\({/) # ({...
3033 {
3034 $ctx =~ s/\n*$//;
3035 my $herectx = $here . "\n";
3036 my $cnt = statement_rawlines($ctx);
3037
3038 for (my $n = 0; $n < $cnt; $n++) {
3039 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003040 }
3041
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003042 if ($dstat =~ /;/) {
3043 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3044 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3045 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003046 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003047 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003048 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003049 }
Joe Perches5023d342012-12-17 16:01:47 -08003050
Joe Perches481eb482012-12-17 16:01:56 -08003051# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003052
3053 } else {
3054 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003055 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3056 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003057 $line =~ /^\+.*\\$/) {
3058 WARN("LINE_CONTINUATIONS",
3059 "Avoid unnecessary line continuations\n" . $herecurr);
3060 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003061 }
3062
Joe Perchesb13edf72012-07-30 14:41:24 -07003063# do {} while (0) macro tests:
3064# single-statement macros do not need to be enclosed in do while (0) loop,
3065# macro should not end with a semicolon
3066 if ($^V && $^V ge 5.10.0 &&
3067 $realfile !~ m@/vmlinux.lds.h$@ &&
3068 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3069 my $ln = $linenr;
3070 my $cnt = $realcnt;
3071 my ($off, $dstat, $dcond, $rest);
3072 my $ctx = '';
3073 ($dstat, $dcond, $ln, $cnt, $off) =
3074 ctx_statement_block($linenr, $realcnt, 0);
3075 $ctx = $dstat;
3076
3077 $dstat =~ s/\\\n.//g;
3078
3079 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3080 my $stmts = $2;
3081 my $semis = $3;
3082
3083 $ctx =~ s/\n*$//;
3084 my $cnt = statement_rawlines($ctx);
3085 my $herectx = $here . "\n";
3086
3087 for (my $n = 0; $n < $cnt; $n++) {
3088 $herectx .= raw_line($linenr, $n) . "\n";
3089 }
3090
Joe Perchesac8e97f2012-08-21 16:15:53 -07003091 if (($stmts =~ tr/;/;/) == 1 &&
3092 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003093 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3094 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3095 }
3096 if (defined $semis && $semis ne "") {
3097 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3098 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3099 }
3100 }
3101 }
3102
Mike Frysinger080ba922009-01-06 14:41:25 -08003103# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3104# all assignments may have only one of the following with an assignment:
3105# .
3106# ALIGN(...)
3107# VMLINUX_SYMBOL(...)
3108 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003109 WARN("MISSING_VMLINUX_SYMBOL",
3110 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003111 }
3112
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003113# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003114 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3115 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003116 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003117 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003118 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3119 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003120 my @allowed = ();
3121 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003122 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003123 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003124 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003125 for my $chunk (@chunks) {
3126 my ($cond, $block) = @{$chunk};
3127
Andy Whitcroft773647a2008-03-28 14:15:58 -07003128 # If the condition carries leading newlines, then count those as offsets.
3129 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3130 my $offset = statement_rawlines($whitespace) - 1;
3131
Joe Perchesaad4f612012-03-23 15:02:19 -07003132 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003133 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3134
3135 # We have looked at and allowed this specific line.
3136 $suppress_ifbraces{$ln + $offset} = 1;
3137
3138 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003139 $ln += statement_rawlines($block) - 1;
3140
Andy Whitcroft773647a2008-03-28 14:15:58 -07003141 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003142
3143 $seen++ if ($block =~ /^\s*{/);
3144
Joe Perchesaad4f612012-03-23 15:02:19 -07003145 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003146 if (statement_lines($cond) > 1) {
3147 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003148 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003149 }
3150 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003151 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003152 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003153 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003154 if (statement_block_size($block) > 1) {
3155 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003156 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003157 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003158 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003159 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003160 if ($seen) {
3161 my $sum_allowed = 0;
3162 foreach (@allowed) {
3163 $sum_allowed += $_;
3164 }
3165 if ($sum_allowed == 0) {
3166 WARN("BRACES",
3167 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3168 } elsif ($sum_allowed != $allow &&
3169 $seen != $allow) {
3170 CHK("BRACES",
3171 "braces {} should be used on all arms of this statement\n" . $herectx);
3172 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003173 }
3174 }
3175 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003176 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003177 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003178 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003179
Andy Whitcroftcf655042008-03-04 14:28:20 -08003180 # Check the pre-context.
3181 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3182 #print "APW: ALLOWED: pre<$1>\n";
3183 $allowed = 1;
3184 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003185
3186 my ($level, $endln, @chunks) =
3187 ctx_statement_full($linenr, $realcnt, $-[0]);
3188
Andy Whitcroftcf655042008-03-04 14:28:20 -08003189 # Check the condition.
3190 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003191 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003192 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003193 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003194 }
3195 if (statement_lines($cond) > 1) {
3196 #print "APW: ALLOWED: cond<$cond>\n";
3197 $allowed = 1;
3198 }
3199 if ($block =~/\b(?:if|for|while)\b/) {
3200 #print "APW: ALLOWED: block<$block>\n";
3201 $allowed = 1;
3202 }
3203 if (statement_block_size($block) > 1) {
3204 #print "APW: ALLOWED: lines block<$block>\n";
3205 $allowed = 1;
3206 }
3207 # Check the post-context.
3208 if (defined $chunks[1]) {
3209 my ($cond, $block) = @{$chunks[1]};
3210 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003211 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003212 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003213 if ($block =~ /^\s*\{/) {
3214 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3215 $allowed = 1;
3216 }
3217 }
3218 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003219 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003220 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003221
Andy Whitcroftf0556632008-10-15 22:02:23 -07003222 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003223 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003224 }
3225
Joe Perches000d1cc12011-07-25 17:13:25 -07003226 WARN("BRACES",
3227 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003228 }
3229 }
3230
Joe Perches0979ae62012-12-17 16:01:59 -08003231# check for unnecessary blank lines around braces
3232 if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) {
3233 CHK("BRACES",
3234 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3235 }
3236 if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3237 CHK("BRACES",
3238 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3239 }
3240
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003241# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003242 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3243 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003244 WARN("VOLATILE",
3245 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003246 }
3247
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003248# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003249 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003250 CHK("REDUNDANT_CODE",
3251 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003252 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003253 }
3254
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003255# check for needless "if (<foo>) fn(<foo>)" uses
3256 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3257 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3258 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3259 WARN('NEEDLESS_IF',
3260 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003261 }
3262 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003263
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003264# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003265 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003266 # ignore udelay's < 10, however
Bruce Allan37581c22013-02-21 16:44:19 -08003267 if (! ($1 < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003268 CHK("USLEEP_RANGE",
3269 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003270 }
3271 }
3272
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003273# warn about unexpectedly long msleep's
3274 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3275 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003276 WARN("MSLEEP",
3277 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003278 }
3279 }
3280
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003281# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003282# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003283# print "#ifdef in C files should be avoided\n";
3284# print "$herecurr";
3285# $clean = 0;
3286# }
3287
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003288# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003289 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003290 ERROR("SPACING",
3291 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003292 }
3293
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003294# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003295 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3296 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003297 my $which = $1;
3298 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003299 CHK("UNCOMMENTED_DEFINITION",
3300 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003301 }
3302 }
3303# check for memory barriers without a comment.
3304 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3305 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003306 CHK("MEMORY_BARRIER",
3307 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003308 }
3309 }
3310# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003311 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003312 CHK("ARCH_DEFINES",
3313 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003314 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003315
Tobias Klauserd4977c72010-05-24 14:33:30 -07003316# Check that the storage class is at the beginning of a declaration
3317 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003318 WARN("STORAGE_CLASS",
3319 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003320 }
3321
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003322# check the location of the inline attribute, that it is between
3323# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003324 if ($line =~ /\b$Type\s+$Inline\b/ ||
3325 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003326 ERROR("INLINE_LOCATION",
3327 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003328 }
3329
Andy Whitcroft8905a672007-11-28 16:21:06 -08003330# Check for __inline__ and __inline, prefer inline
3331 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003332 WARN("INLINE",
3333 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003334 }
3335
Joe Perches3d130fd2011-01-12 17:00:00 -08003336# Check for __attribute__ packed, prefer __packed
3337 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003338 WARN("PREFER_PACKED",
3339 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003340 }
3341
Joe Perches39b7e282011-07-25 17:13:24 -07003342# Check for __attribute__ aligned, prefer __aligned
3343 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003344 WARN("PREFER_ALIGNED",
3345 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003346 }
3347
Joe Perches5f14d3b2012-01-10 15:09:52 -08003348# Check for __attribute__ format(printf, prefer __printf
3349 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3350 WARN("PREFER_PRINTF",
3351 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3352 }
3353
Joe Perches6061d942012-03-23 15:02:16 -07003354# Check for __attribute__ format(scanf, prefer __scanf
3355 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3356 WARN("PREFER_SCANF",
3357 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3358 }
3359
Joe Perches8f53a9b2010-03-05 13:43:48 -08003360# check for sizeof(&)
3361 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003362 WARN("SIZEOF_ADDRESS",
3363 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003364 }
3365
Joe Perches66c80b62012-07-30 14:41:22 -07003366# check for sizeof without parenthesis
3367 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3368 WARN("SIZEOF_PARENTHESIS",
3369 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3370 }
3371
Joe Perches428e2fd2011-05-24 17:13:39 -07003372# check for line continuations in quoted strings with odd counts of "
3373 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003374 WARN("LINE_CONTINUATIONS",
3375 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003376 }
3377
Joe Perches88982fe2012-12-17 16:02:00 -08003378# check for struct spinlock declarations
3379 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3380 WARN("USE_SPINLOCK_T",
3381 "struct spinlock should be spinlock_t\n" . $herecurr);
3382 }
3383
Joe Perchesa6962d72013-04-29 16:18:13 -07003384# check for seq_printf uses that could be seq_puts
3385 if ($line =~ /\bseq_printf\s*\(/) {
3386 my $fmt = get_quoted_string($line, $rawline);
3387 if ($fmt !~ /[^\\]\%/) {
3388 WARN("PREFER_SEQ_PUTS",
3389 "Prefer seq_puts to seq_printf\n" . $herecurr);
3390 }
3391 }
3392
Andy Whitcroft554e1652012-01-10 15:09:57 -08003393# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003394 if ($^V && $^V ge 5.10.0 &&
3395 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003396 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003397
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003398 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003399 my $ms_val = $7;
3400 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003401
Andy Whitcroft554e1652012-01-10 15:09:57 -08003402 if ($ms_size =~ /^(0x|)0$/i) {
3403 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003404 "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 -08003405 } elsif ($ms_size =~ /^(0x|)1$/i) {
3406 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003407 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3408 }
3409 }
3410
3411# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003412 if ($^V && $^V ge 5.10.0 &&
3413 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003414 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003415 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003416 my $call = $1;
3417 my $cast1 = deparenthesize($2);
3418 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003419 my $cast2 = deparenthesize($7);
3420 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003421 my $cast;
3422
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003423 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003424 $cast = "$cast1 or $cast2";
3425 } elsif ($cast1 ne "") {
3426 $cast = $cast1;
3427 } else {
3428 $cast = $cast2;
3429 }
3430 WARN("MINMAX",
3431 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003432 }
3433 }
3434
Joe Perches4a273192012-07-30 14:41:20 -07003435# check usleep_range arguments
3436 if ($^V && $^V ge 5.10.0 &&
3437 defined $stat &&
3438 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3439 my $min = $1;
3440 my $max = $7;
3441 if ($min eq $max) {
3442 WARN("USLEEP_RANGE",
3443 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3444 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3445 $min > $max) {
3446 WARN("USLEEP_RANGE",
3447 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3448 }
3449 }
3450
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003451# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003452 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003453 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003454 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003455 my $function_name = $1;
3456 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003457
3458 my $s = $stat;
3459 if (defined $cond) {
3460 substr($s, 0, length($cond), '');
3461 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003462 if ($s =~ /^\s*;/ &&
3463 $function_name ne 'uninitialized_var')
3464 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003465 WARN("AVOID_EXTERNS",
3466 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003467 }
3468
3469 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003470 WARN("FUNCTION_ARGUMENTS",
3471 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003472 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003473
3474 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3475 $stat =~ /^.\s*extern\s+/)
3476 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003477 WARN("AVOID_EXTERNS",
3478 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003479 }
3480
3481# checks for new __setup's
3482 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3483 my $name = $1;
3484
3485 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003486 CHK("UNDOCUMENTED_SETUP",
3487 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003488 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003489 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003490
3491# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003492 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003493 WARN("UNNECESSARY_CASTS",
3494 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003495 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003496
Joe Perches972fdea2013-04-29 16:18:12 -07003497# check for krealloc arg reuse
3498 if ($^V && $^V ge 5.10.0 &&
3499 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3500 WARN("KREALLOC_ARG_REUSE",
3501 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3502 }
3503
Joe Perches5ce59ae2013-02-21 16:44:18 -08003504# check for alloc argument mismatch
3505 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3506 WARN("ALLOC_ARRAY_ARGS",
3507 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3508 }
3509
Joe Perchescaf2a542011-01-12 16:59:56 -08003510# check for multiple semicolons
3511 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08003512 WARN("ONE_SEMICOLON",
3513 "Statements terminations use 1 semicolon\n" . $herecurr);
3514 }
3515
3516# check for switch/default statements without a break;
3517 if ($^V && $^V ge 5.10.0 &&
3518 defined $stat &&
3519 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3520 my $ctx = '';
3521 my $herectx = $here . "\n";
3522 my $cnt = statement_rawlines($stat);
3523 for (my $n = 0; $n < $cnt; $n++) {
3524 $herectx .= raw_line($linenr, $n) . "\n";
3525 }
3526 WARN("DEFAULT_NO_BREAK",
3527 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08003528 }
3529
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003530# check for gcc specific __FUNCTION__
3531 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003532 WARN("USE_FUNC",
3533 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003534 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003535
Joe Perches2c924882012-03-23 15:02:20 -07003536# check for use of yield()
3537 if ($line =~ /\byield\s*\(\s*\)/) {
3538 WARN("YIELD",
3539 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3540 }
3541
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003542# check for semaphores initialized locked
3543 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003544 WARN("CONSIDER_COMPLETION",
3545 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003546 }
Joe Perches6712d852012-03-23 15:02:20 -07003547
Joe Perches67d0a072011-10-31 17:13:10 -07003548# recommend kstrto* over simple_strto* and strict_strto*
3549 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003550 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003551 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003552 }
Joe Perches6712d852012-03-23 15:02:20 -07003553
Michael Ellermanf3db6632008-07-23 21:28:57 -07003554# check for __initcall(), use device_initcall() explicitly please
3555 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003556 WARN("USE_DEVICE_INITCALL",
3557 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003558 }
Joe Perches6712d852012-03-23 15:02:20 -07003559
Emese Revfy79404842010-03-05 13:43:53 -08003560# check for various ops structs, ensure they are const.
3561 my $struct_ops = qr{acpi_dock_ops|
3562 address_space_operations|
3563 backlight_ops|
3564 block_device_operations|
3565 dentry_operations|
3566 dev_pm_ops|
3567 dma_map_ops|
3568 extent_io_ops|
3569 file_lock_operations|
3570 file_operations|
3571 hv_ops|
3572 ide_dma_ops|
3573 intel_dvo_dev_ops|
3574 item_operations|
3575 iwl_ops|
3576 kgdb_arch|
3577 kgdb_io|
3578 kset_uevent_ops|
3579 lock_manager_operations|
3580 microcode_ops|
3581 mtrr_ops|
3582 neigh_ops|
3583 nlmsvc_binding|
3584 pci_raw_ops|
3585 pipe_buf_operations|
3586 platform_hibernation_ops|
3587 platform_suspend_ops|
3588 proto_ops|
3589 rpc_pipe_ops|
3590 seq_operations|
3591 snd_ac97_build_ops|
3592 soc_pcmcia_socket_ops|
3593 stacktrace_ops|
3594 sysfs_ops|
3595 tty_operations|
3596 usb_mon_operations|
3597 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003598 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003599 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003600 WARN("CONST_STRUCT",
3601 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003602 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003603 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003604
3605# use of NR_CPUS is usually wrong
3606# ignore definitions of NR_CPUS and usage to define arrays as likely right
3607 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003608 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3609 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003610 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3611 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3612 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003613 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003614 WARN("NR_CPUS",
3615 "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 -07003616 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003617
3618# check for %L{u,d,i} in strings
3619 my $string;
3620 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3621 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003622 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003623 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003624 WARN("PRINTF_L",
3625 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003626 last;
3627 }
3628 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003629
3630# whine mightly about in_atomic
3631 if ($line =~ /\bin_atomic\s*\(/) {
3632 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003633 ERROR("IN_ATOMIC",
3634 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003635 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003636 WARN("IN_ATOMIC",
3637 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003638 }
3639 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003640
3641# check for lockdep_set_novalidate_class
3642 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3643 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3644 if ($realfile !~ m@^kernel/lockdep@ &&
3645 $realfile !~ m@^include/linux/lockdep@ &&
3646 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003647 ERROR("LOCKDEP",
3648 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003649 }
3650 }
Dave Jones88f88312011-01-12 16:59:59 -08003651
3652 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3653 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003654 WARN("EXPORTED_WORLD_WRITABLE",
3655 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003656 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003657 }
3658
3659 # If we have no input at all, then there is nothing to report on
3660 # so just keep quiet.
3661 if ($#rawlines == -1) {
3662 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003663 }
3664
Andy Whitcroft8905a672007-11-28 16:21:06 -08003665 # In mailback mode only produce a report in the negative, for
3666 # things that appear to be patches.
3667 if ($mailback && ($clean == 1 || !$is_patch)) {
3668 exit(0);
3669 }
3670
3671 # This is not a patch, and we are are in 'no-patch' mode so
3672 # just keep quiet.
3673 if (!$chk_patch && !$is_patch) {
3674 exit(0);
3675 }
3676
3677 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003678 ERROR("NOT_UNIFIED_DIFF",
3679 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003680 }
3681 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003682 ERROR("MISSING_SIGN_OFF",
3683 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003684 }
3685
Andy Whitcroft8905a672007-11-28 16:21:06 -08003686 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003687 if ($summary && !($clean == 1 && $quiet == 1)) {
3688 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003689 print "total: $cnt_error errors, $cnt_warn warnings, " .
3690 (($check)? "$cnt_chk checks, " : "") .
3691 "$cnt_lines lines checked\n";
3692 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003693 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003694
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003695 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003696
3697 if ($^V lt 5.10.0) {
3698 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3699 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3700 }
3701
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003702 # If there were whitespace errors which cleanpatch can fix
3703 # then suggest that.
3704 if ($rpt_cleaners) {
3705 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3706 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003707 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003708 }
3709 }
3710
Artem Bityutskiy11232682012-03-23 15:02:17 -07003711 if ($quiet == 0 && keys %ignore_type) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003712 print "NOTE: Ignored message types:";
3713 foreach my $ignore (sort keys %ignore_type) {
3714 print " $ignore";
3715 }
Artem Bityutskiy11232682012-03-23 15:02:17 -07003716 print "\n\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003717 }
3718
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003719 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003720 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003721 }
3722 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003723 print << "EOM";
3724$vname has style problems, please review.
3725
3726If any of these errors are false positives, please report
3727them to the maintainer, see CHECKPATCH in MAINTAINERS.
3728EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003729 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003730
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003731 return $clean;
3732}