blob: b28cc384a5bcf30952f66d7da5b349978e39b49a [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
Joe Perches000d1cc12011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070029my $show_types = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080031my %debug;
Joe Perches000d1cc12011-07-25 17:13:25 -070032my %ignore_type = ();
33my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070034my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070035my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080036my $max_line_length = 80;
Hannes Eder77f5b102009-09-21 17:04:37 -070037
38sub help {
39 my ($exitcode) = @_;
40
41 print << "EOM";
42Usage: $P [OPTION]... [FILE]...
43Version: $V
44
45Options:
46 -q, --quiet quiet
47 --no-tree run without a kernel tree
48 --no-signoff do not check for 'Signed-off-by' line
49 --patch treat FILE as patchfile (default)
50 --emacs emacs compile window format
51 --terse one line per report
52 -f, --file treat FILE as regular source file
53 --subjective, --strict enable more subjective tests
Joe Perches000d1cc12011-07-25 17:13:25 -070054 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080055 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070056 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070057 --root=PATH PATH to the kernel tree root
58 --no-summary suppress the per-file summary
59 --mailback only produce a report in case of warnings/errors
60 --summary-file include the filename in summary
61 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
62 'values', 'possible', 'type', and 'attr' (default
63 is all off)
64 --test-only=WORD report only warnings/errors containing WORD
65 literally
66 -h, --help, --version display this help and exit
67
68When FILE is - read standard input.
69EOM
70
71 exit($exitcode);
72}
73
Joe Perches000d1cc12011-07-25 17:13:25 -070074my $conf = which_conf($configuration_file);
75if (-f $conf) {
76 my @conf_args;
77 open(my $conffile, '<', "$conf")
78 or warn "$P: Can't find a readable $configuration_file file $!\n";
79
80 while (<$conffile>) {
81 my $line = $_;
82
83 $line =~ s/\s*\n?$//g;
84 $line =~ s/^\s*//g;
85 $line =~ s/\s+/ /g;
86
87 next if ($line =~ m/^\s*#/);
88 next if ($line =~ m/^\s*$/);
89
90 my @words = split(" ", $line);
91 foreach my $word (@words) {
92 last if ($word =~ m/^#/);
93 push (@conf_args, $word);
94 }
95 }
96 close($conffile);
97 unshift(@ARGV, @conf_args) if @conf_args;
98}
99
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700100GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700101 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700102 'tree!' => \$tree,
103 'signoff!' => \$chk_signoff,
104 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700105 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800106 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700107 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700108 'subjective!' => \$check,
109 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700110 'ignore=s' => \@ignore,
111 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800112 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700113 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800114 'summary!' => \$summary,
115 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800116 'summary-file!' => \$summary_file,
117
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800118 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700119 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700120 'h|help' => \$help,
121 'version' => \$help
122) or help(1);
123
124help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700125
126my $exit = 0;
127
128if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700129 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700130 exit(1);
131}
132
Joe Perches000d1cc12011-07-25 17:13:25 -0700133@ignore = split(/,/, join(',',@ignore));
134foreach my $word (@ignore) {
135 $word =~ s/\s*\n?$//g;
136 $word =~ s/^\s*//g;
137 $word =~ s/\s+/ /g;
138 $word =~ tr/[a-z]/[A-Z]/;
139
140 next if ($word =~ m/^\s*#/);
141 next if ($word =~ m/^\s*$/);
142
143 $ignore_type{$word}++;
144}
145
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800146my $dbg_values = 0;
147my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700148my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700149my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800150for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800151 ## no critic
152 eval "\${dbg_$key} = '$debug{$key}';";
153 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800154}
155
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700156my $rpt_cleaners = 0;
157
Andy Whitcroft8905a672007-11-28 16:21:06 -0800158if ($terse) {
159 $emacs = 1;
160 $quiet++;
161}
162
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700163if ($tree) {
164 if (defined $root) {
165 if (!top_of_kernel_tree($root)) {
166 die "$P: $root: --root does not point at a valid tree\n";
167 }
168 } else {
169 if (top_of_kernel_tree('.')) {
170 $root = '.';
171 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
172 top_of_kernel_tree($1)) {
173 $root = $1;
174 }
175 }
176
177 if (!defined $root) {
178 print "Must be run from the top-level dir. of a kernel tree\n";
179 exit(2);
180 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700181}
182
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700183my $emitted_corrupt = 0;
184
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700185our $Ident = qr{
186 [A-Za-z_][A-Za-z\d_]*
187 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
188 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700189our $Storage = qr{extern|static|asmlinkage};
190our $Sparse = qr{
191 __user|
192 __kernel|
193 __force|
194 __iomem|
195 __must_check|
196 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800197 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700198 __ref|
199 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800201
202# Notes to $Attribute:
203# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700204our $Attribute = qr{
205 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700206 __percpu|
207 __nocast|
208 __safe|
209 __bitwise__|
210 __packed__|
211 __packed2__|
212 __naked|
213 __maybe_unused|
214 __always_unused|
215 __noreturn|
216 __used|
217 __cold|
218 __noclone|
219 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700220 __read_mostly|
221 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800222 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700223 ____cacheline_aligned|
224 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800225 ____cacheline_internodealigned_in_smp|
226 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700227 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700228our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700229our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700230our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
231our $Lval = qr{$Ident(?:$Member)*};
232
Joe Perches326b1ff2013-02-04 14:28:51 -0800233our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
234our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
235our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800236our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800237our $Constant = qr{$Float|(?i)(?:0x[0-9a-f]+|[0-9]+)[ul]*};
238our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800239our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700240our $Operators = qr{
241 <=|>=|==|!=|
242 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800243 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700244 }x;
245
Andy Whitcroft8905a672007-11-28 16:21:06 -0800246our $NonptrType;
247our $Type;
248our $Declare;
249
Joe Perches15662b32011-10-31 17:13:12 -0700250our $NON_ASCII_UTF8 = qr{
251 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700252 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
253 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
254 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
255 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
256 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
257 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
258}x;
259
Joe Perches15662b32011-10-31 17:13:12 -0700260our $UTF8 = qr{
261 [\x09\x0A\x0D\x20-\x7E] # ASCII
262 | $NON_ASCII_UTF8
263}x;
264
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700265our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700266 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700267 atomic_t
268)};
269
Joe Perches691e6692010-03-05 13:43:51 -0800270our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700271 printk(?:_ratelimited|_once|)|
272 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
273 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700274 panic|
275 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800276)};
277
Joe Perches20112472011-07-25 17:13:23 -0700278our $signature_tags = qr{(?xi:
279 Signed-off-by:|
280 Acked-by:|
281 Tested-by:|
282 Reviewed-by:|
283 Reported-by:|
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 Whitcroft00df3442007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft00df3442007-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 Whitcroft00df3442007-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 Whitcroft00df3442007-06-08 13:47:06 -0700595 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700596 } elsif ($sanitise_quote eq $c) {
597 $sanitise_quote = '';
Andy Whitcroft00df3442007-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 Whitcroft00df3442007-06-08 13:47:06 -0700608 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700609 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-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 Whitcroft00df3442007-06-08 13:47:06 -0700628 return $res;
629}
630
Andy Whitcroft8905a672007-11-28 16:21:06 -0800631sub ctx_statement_block {
632 my ($linenr, $remain, $off) = @_;
633 my $line = $linenr - 1;
634 my $blk = '';
635 my $soff = $off;
636 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700637 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800638
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800639 my $loff = 0;
640
Andy Whitcroft8905a672007-11-28 16:21:06 -0800641 my $type = '';
642 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800643 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800644 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800645 my $c;
646 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800647
648 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800649 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800650 @stack = (['', 0]) if ($#stack == -1);
651
Andy Whitcroft773647a2008-03-28 14:15:58 -0700652 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800653 # If we are about to drop off the end, pull in more
654 # context.
655 if ($off >= $len) {
656 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700657 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800658 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800659 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800660 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800661 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800662 $len = length($blk);
663 $line++;
664 last;
665 }
666 # Bail if there is no further context.
667 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800668 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800669 last;
670 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800671 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
672 $level++;
673 $type = '#';
674 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800675 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800676 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800677 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800678 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800679
Andy Whitcroft773647a2008-03-28 14:15:58 -0700680 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800681
682 # Handle nested #if/#else.
683 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
684 push(@stack, [ $type, $level ]);
685 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
686 ($type, $level) = @{$stack[$#stack - 1]};
687 } elsif ($remainder =~ /^#\s*endif\b/) {
688 ($type, $level) = @{pop(@stack)};
689 }
690
Andy Whitcroft8905a672007-11-28 16:21:06 -0800691 # Statement ends at the ';' or a close '}' at the
692 # outermost level.
693 if ($level == 0 && $c eq ';') {
694 last;
695 }
696
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800697 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700698 if ($level == 0 && $coff_set == 0 &&
699 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
700 $remainder =~ /^(else)(?:\s|{)/ &&
701 $remainder !~ /^else\s+if\b/) {
702 $coff = $off + length($1) - 1;
703 $coff_set = 1;
704 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
705 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800706 }
707
Andy Whitcroft8905a672007-11-28 16:21:06 -0800708 if (($type eq '' || $type eq '(') && $c eq '(') {
709 $level++;
710 $type = '(';
711 }
712 if ($type eq '(' && $c eq ')') {
713 $level--;
714 $type = ($level != 0)? '(' : '';
715
716 if ($level == 0 && $coff < $soff) {
717 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700718 $coff_set = 1;
719 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800720 }
721 }
722 if (($type eq '' || $type eq '{') && $c eq '{') {
723 $level++;
724 $type = '{';
725 }
726 if ($type eq '{' && $c eq '}') {
727 $level--;
728 $type = ($level != 0)? '{' : '';
729
730 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700731 if (substr($blk, $off + 1, 1) eq ';') {
732 $off++;
733 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800734 last;
735 }
736 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800737 # Preprocessor commands end at the newline unless escaped.
738 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
739 $level--;
740 $type = '';
741 $off++;
742 last;
743 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800744 $off++;
745 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700746 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800747 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700748 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800749 $line++;
750 $remain--;
751 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800752
753 my $statement = substr($blk, $soff, $off - $soff + 1);
754 my $condition = substr($blk, $soff, $coff - $soff + 1);
755
756 #warn "STATEMENT<$statement>\n";
757 #warn "CONDITION<$condition>\n";
758
Andy Whitcroft773647a2008-03-28 14:15:58 -0700759 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800760
761 return ($statement, $condition,
762 $line, $remain + 1, $off - $loff + 1, $level);
763}
764
Andy Whitcroftcf655042008-03-04 14:28:20 -0800765sub statement_lines {
766 my ($stmt) = @_;
767
768 # Strip the diff line prefixes and rip blank lines at start and end.
769 $stmt =~ s/(^|\n)./$1/g;
770 $stmt =~ s/^\s*//;
771 $stmt =~ s/\s*$//;
772
773 my @stmt_lines = ($stmt =~ /\n/g);
774
775 return $#stmt_lines + 2;
776}
777
778sub statement_rawlines {
779 my ($stmt) = @_;
780
781 my @stmt_lines = ($stmt =~ /\n/g);
782
783 return $#stmt_lines + 2;
784}
785
786sub statement_block_size {
787 my ($stmt) = @_;
788
789 $stmt =~ s/(^|\n)./$1/g;
790 $stmt =~ s/^\s*{//;
791 $stmt =~ s/}\s*$//;
792 $stmt =~ s/^\s*//;
793 $stmt =~ s/\s*$//;
794
795 my @stmt_lines = ($stmt =~ /\n/g);
796 my @stmt_statements = ($stmt =~ /;/g);
797
798 my $stmt_lines = $#stmt_lines + 2;
799 my $stmt_statements = $#stmt_statements + 1;
800
801 if ($stmt_lines > $stmt_statements) {
802 return $stmt_lines;
803 } else {
804 return $stmt_statements;
805 }
806}
807
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800808sub ctx_statement_full {
809 my ($linenr, $remain, $off) = @_;
810 my ($statement, $condition, $level);
811
812 my (@chunks);
813
Andy Whitcroftcf655042008-03-04 14:28:20 -0800814 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800815 ($statement, $condition, $linenr, $remain, $off, $level) =
816 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700817 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800818 push(@chunks, [ $condition, $statement ]);
819 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
820 return ($level, $linenr, @chunks);
821 }
822
823 # Pull in the following conditional/block pairs and see if they
824 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800825 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800826 ($statement, $condition, $linenr, $remain, $off, $level) =
827 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800828 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700829 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800830 #print "C: push\n";
831 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800832 }
833
834 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800835}
836
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700837sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700838 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700839 my $line;
840 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700841 my $blk = '';
842 my @o;
843 my @c;
844 my @res = ();
845
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700846 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800847 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700848 for ($line = $start; $remain > 0; $line++) {
849 next if ($rawlines[$line] =~ /^-/);
850 $remain--;
851
852 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800853
854 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700855 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800856 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700857 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800858 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700859 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800860 $level = pop(@stack);
861 }
862
Andy Whitcroft01464f32010-10-26 14:23:19 -0700863 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700864 ##print "C<$c>L<$level><$open$close>O<$off>\n";
865 if ($off > 0) {
866 $off--;
867 next;
868 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700869
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700870 if ($c eq $close && $level > 0) {
871 $level--;
872 last if ($level == 0);
873 } elsif ($c eq $open) {
874 $level++;
875 }
876 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700877
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700878 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700879 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700880 }
881
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700882 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700883 }
884
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700885 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700886}
887sub ctx_block_outer {
888 my ($linenr, $remain) = @_;
889
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700890 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
891 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700892}
893sub ctx_block {
894 my ($linenr, $remain) = @_;
895
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700896 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
897 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700898}
899sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700900 my ($linenr, $remain, $off) = @_;
901
902 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
903 return @r;
904}
905sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700906 my ($linenr, $remain) = @_;
907
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700908 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700909}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700910sub ctx_statement_level {
911 my ($linenr, $remain, $off) = @_;
912
913 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
914}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700915
916sub ctx_locate_comment {
917 my ($first_line, $end_line) = @_;
918
919 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700920 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700921 return $current_comment if (defined $current_comment);
922
923 # Look through the context and try and figure out if there is a
924 # comment.
925 my $in_comment = 0;
926 $current_comment = '';
927 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700928 my $line = $rawlines[$linenr - 1];
929 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700930 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
931 $in_comment = 1;
932 }
933 if ($line =~ m@/\*@) {
934 $in_comment = 1;
935 }
936 if (!$in_comment && $current_comment ne '') {
937 $current_comment = '';
938 }
939 $current_comment .= $line . "\n" if ($in_comment);
940 if ($line =~ m@\*/@) {
941 $in_comment = 0;
942 }
943 }
944
945 chomp($current_comment);
946 return($current_comment);
947}
948sub ctx_has_comment {
949 my ($first_line, $end_line) = @_;
950 my $cmt = ctx_locate_comment($first_line, $end_line);
951
Andy Whitcroft00df3442007-06-08 13:47:06 -0700952 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700953 ##print "CMMT: $cmt\n";
954
955 return ($cmt ne '');
956}
957
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700958sub raw_line {
959 my ($linenr, $cnt) = @_;
960
961 my $offset = $linenr - 1;
962 $cnt++;
963
964 my $line;
965 while ($cnt) {
966 $line = $rawlines[$offset++];
967 next if (defined($line) && $line =~ /^-/);
968 $cnt--;
969 }
970
971 return $line;
972}
973
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700974sub cat_vet {
975 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700976 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700977
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700978 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700979 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
980 $res .= $1;
981 if ($2 ne '') {
982 $coded = sprintf("^%c", unpack('C', $2) + 64);
983 $res .= $coded;
984 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700985 }
986 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700987
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700988 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700989}
990
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800991my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800992my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800993my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700994my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800995
996sub annotate_reset {
997 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800998 $av_pending = '_';
999 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001000 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001001}
1002
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001003sub annotate_values {
1004 my ($stream, $type) = @_;
1005
1006 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001007 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001008 my $cur = $stream;
1009
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001011
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001012 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001013 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001014 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001015 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001016 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001017 print "WS($1)\n" if ($dbg_values > 1);
1018 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001019 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001020 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001021 }
1022
Florian Micklerc023e4732011-01-12 16:59:58 -08001023 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001024 print "CAST($1)\n" if ($dbg_values > 1);
1025 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001026 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001027
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001028 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001029 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001030 $type = 'T';
1031
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001032 } elsif ($cur =~ /^($Modifier)\s*/) {
1033 print "MODIFIER($1)\n" if ($dbg_values > 1);
1034 $type = 'T';
1035
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001036 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001037 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001038 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001039 push(@av_paren_type, $type);
1040 if ($2 ne '') {
1041 $av_pending = 'N';
1042 }
1043 $type = 'E';
1044
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001045 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001046 print "UNDEF($1)\n" if ($dbg_values > 1);
1047 $av_preprocessor = 1;
1048 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001049
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001050 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001051 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001052 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001053
1054 push(@av_paren_type, $type);
1055 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001056 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001057
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001058 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001059 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1060 $av_preprocessor = 1;
1061
1062 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1063
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001064 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001065
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001066 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001067 print "PRE_END($1)\n" if ($dbg_values > 1);
1068
1069 $av_preprocessor = 1;
1070
1071 # Assume all arms of the conditional end as this
1072 # one does, and continue as if the #endif was not here.
1073 pop(@av_paren_type);
1074 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001075 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001076
1077 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001078 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001079
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001080 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1081 print "ATTR($1)\n" if ($dbg_values > 1);
1082 $av_pending = $type;
1083 $type = 'N';
1084
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001085 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001087 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001088 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001089 }
1090 $type = 'N';
1091
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001092 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001093 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001094 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001095 $type = 'N';
1096
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001097 } elsif ($cur =~/^(case)/o) {
1098 print "CASE($1)\n" if ($dbg_values > 1);
1099 $av_pend_colon = 'C';
1100 $type = 'N';
1101
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001102 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001103 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001104 $type = 'N';
1105
1106 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001107 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001108 push(@av_paren_type, $av_pending);
1109 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001110 $type = 'N';
1111
1112 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001113 my $new_type = pop(@av_paren_type);
1114 if ($new_type ne '_') {
1115 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001116 print "PAREN('$1') -> $type\n"
1117 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001118 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001119 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001120 }
1121
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001122 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001123 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001124 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001125 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001126
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001127 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1128 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001129 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001130 } elsif ($type eq 'E') {
1131 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001132 }
1133 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1134 $type = 'V';
1135
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001136 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001137 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001138 $type = 'V';
1139
1140 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001141 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001142 $type = 'N';
1143
Andy Whitcroftcf655042008-03-04 14:28:20 -08001144 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001145 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001146 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001147 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001148
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001149 } elsif ($cur =~/^(,)/) {
1150 print "COMMA($1)\n" if ($dbg_values > 1);
1151 $type = 'C';
1152
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001153 } elsif ($cur =~ /^(\?)/o) {
1154 print "QUESTION($1)\n" if ($dbg_values > 1);
1155 $type = 'N';
1156
1157 } elsif ($cur =~ /^(:)/o) {
1158 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1159
1160 substr($var, length($res), 1, $av_pend_colon);
1161 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1162 $type = 'E';
1163 } else {
1164 $type = 'N';
1165 }
1166 $av_pend_colon = 'O';
1167
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001168 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001169 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001170 $type = 'N';
1171
Andy Whitcroft0d413862008-10-15 22:02:16 -07001172 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001173 my $variant;
1174
1175 print "OPV($1)\n" if ($dbg_values > 1);
1176 if ($type eq 'V') {
1177 $variant = 'B';
1178 } else {
1179 $variant = 'U';
1180 }
1181
1182 substr($var, length($res), 1, $variant);
1183 $type = 'N';
1184
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001185 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001186 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001187 if ($1 ne '++' && $1 ne '--') {
1188 $type = 'N';
1189 }
1190
1191 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001192 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 }
1194 if (defined $1) {
1195 $cur = substr($cur, length($1));
1196 $res .= $type x length($1);
1197 }
1198 }
1199
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001200 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001201}
1202
Andy Whitcroft8905a672007-11-28 16:21:06 -08001203sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001204 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001205 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001206 ^(?:
1207 $Modifier|
1208 $Storage|
1209 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001210 DEFINE_\S+
1211 )$|
1212 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001213 goto|
1214 return|
1215 case|
1216 else|
1217 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001218 do|
1219 \#|
1220 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001221 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001222 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001223 )}x;
1224 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1225 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001226 # Check for modifiers.
1227 $possible =~ s/\s*$Storage\s*//g;
1228 $possible =~ s/\s*$Sparse\s*//g;
1229 if ($possible =~ /^\s*$/) {
1230
1231 } elsif ($possible =~ /\s/) {
1232 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001233 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001234 if ($modifier !~ $notPermitted) {
1235 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1236 push(@modifierList, $modifier);
1237 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001238 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001239
1240 } else {
1241 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1242 push(@typeList, $possible);
1243 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001244 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001245 } else {
1246 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001247 }
1248}
1249
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001250my $prefix = '';
1251
Joe Perches000d1cc12011-07-25 17:13:25 -07001252sub show_type {
1253 return !defined $ignore_type{$_[0]};
1254}
1255
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001256sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001257 if (!show_type($_[1]) ||
1258 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001259 return 0;
1260 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001261 my $line;
1262 if ($show_types) {
1263 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1264 } else {
1265 $line = "$prefix$_[0]: $_[2]\n";
1266 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001267 $line = (split('\n', $line))[0] . "\n" if ($terse);
1268
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001269 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001270
1271 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001272}
1273sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001274 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001275}
Joe Perches000d1cc12011-07-25 17:13:25 -07001276
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001277sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001278 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001279 our $clean = 0;
1280 our $cnt_error++;
1281 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001282}
1283sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001284 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001285 our $clean = 0;
1286 our $cnt_warn++;
1287 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001288}
1289sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001290 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001291 our $clean = 0;
1292 our $cnt_chk++;
1293 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001294}
1295
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001296sub check_absolute_file {
1297 my ($absolute, $herecurr) = @_;
1298 my $file = $absolute;
1299
1300 ##print "absolute<$absolute>\n";
1301
1302 # See if any suffix of this path is a path within the tree.
1303 while ($file =~ s@^[^/]*/@@) {
1304 if (-f "$root/$file") {
1305 ##print "file<$file>\n";
1306 last;
1307 }
1308 }
1309 if (! -f _) {
1310 return 0;
1311 }
1312
1313 # It is, so see if the prefix is acceptable.
1314 my $prefix = $absolute;
1315 substr($prefix, -length($file)) = '';
1316
1317 ##print "prefix<$prefix>\n";
1318 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001319 WARN("USE_RELATIVE_PATH",
1320 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001321 }
1322}
1323
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001324sub pos_last_openparen {
1325 my ($line) = @_;
1326
1327 my $pos = 0;
1328
1329 my $opens = $line =~ tr/\(/\(/;
1330 my $closes = $line =~ tr/\)/\)/;
1331
1332 my $last_openparen = 0;
1333
1334 if (($opens == 0) || ($closes >= $opens)) {
1335 return -1;
1336 }
1337
1338 my $len = length($line);
1339
1340 for ($pos = 0; $pos < $len; $pos++) {
1341 my $string = substr($line, $pos);
1342 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1343 $pos += length($1) - 1;
1344 } elsif (substr($line, $pos, 1) eq '(') {
1345 $last_openparen = $pos;
1346 } elsif (index($string, '(') == -1) {
1347 last;
1348 }
1349 }
1350
1351 return $last_openparen + 1;
1352}
1353
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001354sub process {
1355 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001356
1357 my $linenr=0;
1358 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001359 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001360 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001361 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001362
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001363 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001364 my $indent;
1365 my $previndent=0;
1366 my $stashindent=0;
1367
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001368 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001369 my $signoff = 0;
1370 my $is_patch = 0;
1371
Joe Perches15662b32011-10-31 17:13:12 -07001372 my $in_header_lines = 1;
1373 my $in_commit_log = 0; #Scanning lines before patch
1374
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001375 my $non_utf8_charset = 0;
1376
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001377 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001378 our $cnt_lines = 0;
1379 our $cnt_error = 0;
1380 our $cnt_warn = 0;
1381 our $cnt_chk = 0;
1382
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001383 # Trace the real file/line as we go.
1384 my $realfile = '';
1385 my $realline = 0;
1386 my $realcnt = 0;
1387 my $here = '';
1388 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001389 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001390 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001391 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001392
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001393 my $prev_values = 'E';
1394
1395 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001396 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001397 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001398 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001399 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001400
Joe Perches323c1262012-12-17 16:02:07 -08001401 my %camelcase = ();
1402
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001403 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001404 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001405 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001406 my @setup_docs = ();
1407 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001408
1409 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001410 my $line;
1411 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001412 $linenr++;
1413 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001414
Andy Whitcroft773647a2008-03-28 14:15:58 -07001415 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001416 $setup_docs = 0;
1417 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1418 $setup_docs = 1;
1419 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001420 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001421 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001422 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1423 $realline=$1-1;
1424 if (defined $2) {
1425 $realcnt=$3+1;
1426 } else {
1427 $realcnt=1+1;
1428 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001429 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001430
1431 # Guestimate if this is a continuing comment. Run
1432 # the context looking for a comment "edge". If this
1433 # edge is a close comment then we must be in a comment
1434 # at context start.
1435 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001436 my $cnt = $realcnt;
1437 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1438 next if (defined $rawlines[$ln - 1] &&
1439 $rawlines[$ln - 1] =~ /^-/);
1440 $cnt--;
1441 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001442 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001443 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1444 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1445 ($edge) = $1;
1446 last;
1447 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001448 }
1449 if (defined $edge && $edge eq '*/') {
1450 $in_comment = 1;
1451 }
1452
1453 # Guestimate if this is a continuing comment. If this
1454 # is the start of a diff block and this line starts
1455 # ' *' then it is very likely a comment.
1456 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001457 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001458 {
1459 $in_comment = 1;
1460 }
1461
1462 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1463 sanitise_line_reset($in_comment);
1464
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001465 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001466 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001467 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001468 $line = sanitise_line($rawline);
1469 }
1470 push(@lines, $line);
1471
1472 if ($realcnt > 1) {
1473 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1474 } else {
1475 $realcnt = 0;
1476 }
1477
1478 #print "==>$rawline\n";
1479 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001480
1481 if ($setup_docs && $line =~ /^\+/) {
1482 push(@setup_docs, $line);
1483 }
1484 }
1485
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001486 $prefix = '';
1487
Andy Whitcroft773647a2008-03-28 14:15:58 -07001488 $realcnt = 0;
1489 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001490 foreach my $line (@lines) {
1491 $linenr++;
1492
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001493 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001494
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001495#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001496 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001497 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001498 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001499 $realline=$1-1;
1500 if (defined $2) {
1501 $realcnt=$3+1;
1502 } else {
1503 $realcnt=1+1;
1504 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001505 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001506 $prev_values = 'E';
1507
Andy Whitcroft773647a2008-03-28 14:15:58 -07001508 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001509 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001510 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001511 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001512 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001513
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001514# track the line number as we move through the hunk, note that
1515# new versions of GNU diff omit the leading space on completely
1516# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001517 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001518 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001519 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001520
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001521 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001522 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001523
1524 # Track the previous line.
1525 ($prevline, $stashline) = ($stashline, $line);
1526 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001527 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1528
Andy Whitcroft773647a2008-03-28 14:15:58 -07001529 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001530
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001531 } elsif ($realcnt == 1) {
1532 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001533 }
1534
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001535 my $hunk_line = ($realcnt != 0);
1536
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001537#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001538 $prefix = "$filename:$realline: " if ($emacs && $file);
1539 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1540
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001541 $here = "#$linenr: " if (!$file);
1542 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001543
1544 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001545 if ($line =~ /^diff --git.*?(\S+)$/) {
1546 $realfile = $1;
1547 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001548 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001549 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001550 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001551 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001552 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001553
1554 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001555 if (!$file && $tree && $p1_prefix ne '' &&
1556 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001557 WARN("PATCH_PREFIX",
1558 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001559 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001560
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001561 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001562 ERROR("MODIFIED_INCLUDE_ASM",
1563 "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 -07001564 }
1565 next;
1566 }
1567
Randy Dunlap389834b2007-06-08 13:47:03 -07001568 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001569
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001570 my $hereline = "$here\n$rawline\n";
1571 my $herecurr = "$here\n$rawline\n";
1572 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001573
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001574 $cnt_lines++ if ($realcnt != 0);
1575
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001576# Check for incorrect file permissions
1577 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1578 my $permhere = $here . "FILE: $realfile\n";
1579 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001580 ERROR("EXECUTE_PERMISSIONS",
1581 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001582 }
1583 }
1584
Joe Perches20112472011-07-25 17:13:23 -07001585# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001586 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001587 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001588 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001589 }
1590
1591# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001592 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001593 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001594 my $space_before = $1;
1595 my $sign_off = $2;
1596 my $space_after = $3;
1597 my $email = $4;
1598 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1599
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001600 if ($sign_off !~ /$signature_tags/) {
1601 WARN("BAD_SIGN_OFF",
1602 "Non-standard signature: $sign_off\n" . $herecurr);
1603 }
Joe Perches20112472011-07-25 17:13:23 -07001604 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001605 WARN("BAD_SIGN_OFF",
1606 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001607 }
Joe Perches20112472011-07-25 17:13:23 -07001608 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001609 WARN("BAD_SIGN_OFF",
1610 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001611 }
1612 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001613 WARN("BAD_SIGN_OFF",
1614 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001615 }
1616
1617 my ($email_name, $email_address, $comment) = parse_email($email);
1618 my $suggested_email = format_email(($email_name, $email_address));
1619 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001620 ERROR("BAD_SIGN_OFF",
1621 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001622 } else {
1623 my $dequoted = $suggested_email;
1624 $dequoted =~ s/^"//;
1625 $dequoted =~ s/" </ </;
1626 # Don't force email to have quotes
1627 # Allow just an angle bracketed address
1628 if ("$dequoted$comment" ne $email &&
1629 "<$email_address>$comment" ne $email &&
1630 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001631 WARN("BAD_SIGN_OFF",
1632 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001633 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001634 }
1635 }
1636
Andy Whitcroft00df3442007-06-08 13:47:06 -07001637# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001638 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001639 ERROR("CORRUPTED_PATCH",
1640 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001641 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001642 }
1643
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001644# Check for absolute kernel paths.
1645 if ($tree) {
1646 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1647 my $file = $1;
1648
1649 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1650 check_absolute_file($1, $herecurr)) {
1651 #
1652 } else {
1653 check_absolute_file($file, $herecurr);
1654 }
1655 }
1656 }
1657
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001658# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1659 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001660 $rawline !~ m/^$UTF8*$/) {
1661 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1662
1663 my $blank = copy_spacing($rawline);
1664 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1665 my $hereptr = "$hereline$ptr\n";
1666
Joe Perches34d99212011-07-25 17:13:26 -07001667 CHK("INVALID_UTF8",
1668 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001669 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001670
Joe Perches15662b32011-10-31 17:13:12 -07001671# Check if it's the start of a commit log
1672# (not a header line and we haven't seen the patch filename)
1673 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001674 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001675 $in_header_lines = 0;
1676 $in_commit_log = 1;
1677 }
1678
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001679# Check if there is UTF-8 in a commit log when a mail header has explicitly
1680# declined it, i.e defined some charset where it is missing.
1681 if ($in_header_lines &&
1682 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1683 $1 !~ /utf-8/i) {
1684 $non_utf8_charset = 1;
1685 }
1686
1687 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001688 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001689 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001690 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1691 }
1692
Andy Whitcroft306708542008-10-15 22:02:28 -07001693# ignore non-hunk lines and lines being removed
1694 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001695
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001696#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001697 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001698 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001699 ERROR("DOS_LINE_ENDINGS",
1700 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001701
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001702 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1703 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001704 ERROR("TRAILING_WHITESPACE",
1705 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001706 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001707 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001708
Andi Kleen33549572010-05-24 14:33:29 -07001709# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001710# Only applies when adding the entry originally, after that we do not have
1711# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001712 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001713 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001714 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001715 my $cnt = $realcnt;
1716 my $ln = $linenr + 1;
1717 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001718 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001719 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001720 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001721 $f = $lines[$ln - 1];
1722 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1723 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001724
1725 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001726
1727 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1728 $is_start = 1;
1729 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1730 $length = -1;
1731 }
1732
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001733 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001734 $f =~ s/#.*//;
1735 $f =~ s/^\s+//;
1736 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001737 if ($f =~ /^\s*config\s/) {
1738 $is_end = 1;
1739 last;
1740 }
Andi Kleen33549572010-05-24 14:33:29 -07001741 $length++;
1742 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001743 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001744 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1745 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001746 }
1747
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001748# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1749 if ($realfile =~ /Kconfig/ &&
1750 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1751 WARN("CONFIG_EXPERIMENTAL",
1752 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1753 }
1754
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001755 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1756 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1757 my $flag = $1;
1758 my $replacement = {
1759 'EXTRA_AFLAGS' => 'asflags-y',
1760 'EXTRA_CFLAGS' => 'ccflags-y',
1761 'EXTRA_CPPFLAGS' => 'cppflags-y',
1762 'EXTRA_LDFLAGS' => 'ldflags-y',
1763 };
1764
1765 WARN("DEPRECATED_VARIABLE",
1766 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1767 }
1768
Andy Whitcroft5368df22008-10-15 22:02:27 -07001769# check we are in a valid source file if not then ignore this hunk
1770 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1771
Joe Perches6cd7f382012-12-17 16:01:54 -08001772#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001773 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001774 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001775 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001776 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08001777 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001778 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001779 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08001780 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001781 }
1782
Josh Triplettca56dc02012-03-23 15:02:21 -07001783# Check for user-visible strings broken across lines, which breaks the ability
1784# to grep for the string. Limited to strings used as parameters (those
1785# following an open parenthesis), which almost completely eliminates false
1786# positives, as well as warning only once per parameter rather than once per
1787# line of the string. Make an exception when the previous string ends in a
1788# newline (multiple lines in one string constant) or \n\t (common in inline
1789# assembly to indent the instruction on the following line).
1790 if ($line =~ /^\+\s*"/ &&
1791 $prevline =~ /"\s*$/ &&
1792 $prevline =~ /\(/ &&
1793 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1794 WARN("SPLIT_STRING",
1795 "quoted string split across lines\n" . $hereprev);
1796 }
1797
Joe Perches5e79d962010-03-05 13:43:55 -08001798# check for spaces before a quoted newline
1799 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001800 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1801 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001802 }
1803
Andy Whitcroft8905a672007-11-28 16:21:06 -08001804# check for adding lines without a newline.
1805 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001806 WARN("MISSING_EOF_NEWLINE",
1807 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001808 }
1809
Mike Frysinger42e41c52009-09-21 17:04:40 -07001810# Blackfin: use hi/lo macros
1811 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1812 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1813 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001814 ERROR("LO_MACRO",
1815 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001816 }
1817 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1818 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001819 ERROR("HI_MACRO",
1820 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001821 }
1822 }
1823
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001824# check we are in a valid source file C or perl if not then ignore this hunk
1825 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001826
1827# at the beginning of a line any tabs must come first and anything
1828# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001829 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1830 $rawline =~ /^\+\s* \s*/) {
1831 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001832 ERROR("CODE_INDENT",
1833 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001834 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001835 }
1836
Alberto Panizzo08e44362010-03-05 13:43:54 -08001837# check for space before tabs.
1838 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1839 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001840 WARN("SPACE_BEFORE_TAB",
1841 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001842 }
1843
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001844# check for && or || at the start of a line
1845 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1846 CHK("LOGICAL_CONTINUATIONS",
1847 "Logical continuations should be on the previous line\n" . $hereprev);
1848 }
1849
1850# check multi-line statement indentation matches previous line
1851 if ($^V && $^V ge 5.10.0 &&
1852 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1853 $prevline =~ /^\+(\t*)(.*)$/;
1854 my $oldindent = $1;
1855 my $rest = $2;
1856
1857 my $pos = pos_last_openparen($rest);
1858 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07001859 $line =~ /^(\+| )([ \t]*)/;
1860 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001861
1862 my $goodtabindent = $oldindent .
1863 "\t" x ($pos / 8) .
1864 " " x ($pos % 8);
1865 my $goodspaceindent = $oldindent . " " x $pos;
1866
1867 if ($newindent ne $goodtabindent &&
1868 $newindent ne $goodspaceindent) {
1869 CHK("PARENTHESIS_ALIGNMENT",
1870 "Alignment should match open parenthesis\n" . $hereprev);
1871 }
1872 }
1873 }
1874
Joe Perchesaad4f612012-03-23 15:02:19 -07001875 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1876 CHK("SPACING",
1877 "No space is necessary after a cast\n" . $hereprev);
1878 }
1879
Joe Perches05880602012-10-04 17:13:35 -07001880 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1881 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1882 $prevrawline =~ /^\+[ \t]*$/) {
1883 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1884 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1885 }
1886
1887 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08001888 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1889 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1890 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1891 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07001892 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1893 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1894 }
1895
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001896# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001897# Exceptions:
1898# 1) within comments
1899# 2) indented preprocessor commands
1900# 3) hanging labels
1901 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001902 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001903 WARN("LEADING_SPACE",
1904 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001905 }
1906
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001907# check we are in a valid C source file if not then ignore this hunk
1908 next if ($realfile !~ /\.(h|c)$/);
1909
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001910# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1911 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1912 WARN("CONFIG_EXPERIMENTAL",
1913 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1914 }
1915
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001916# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001917 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001918 WARN("CVS_KEYWORD",
1919 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001920 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001921
Mike Frysinger42e41c52009-09-21 17:04:40 -07001922# Blackfin: don't use __builtin_bfin_[cs]sync
1923 if ($line =~ /__builtin_bfin_csync/) {
1924 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001925 ERROR("CSYNC",
1926 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001927 }
1928 if ($line =~ /__builtin_bfin_ssync/) {
1929 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001930 ERROR("SSYNC",
1931 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001932 }
1933
Joe Perches56e77d72013-02-21 16:44:14 -08001934# check for old HOTPLUG __dev<foo> section markings
1935 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
1936 WARN("HOTPLUG_SECTION",
1937 "Using $1 is unnecessary\n" . $herecurr);
1938 }
1939
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001940# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001941 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1942 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001943#print "LINE<$line>\n";
1944 if ($linenr >= $suppress_statement &&
1945 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001946 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001947 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001948 $stat =~ s/\n./\n /g;
1949 $cond =~ s/\n./\n /g;
1950
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001951#print "linenr<$linenr> <$stat>\n";
1952 # If this statement has no statement boundaries within
1953 # it there is no point in retrying a statement scan
1954 # until we hit end of it.
1955 my $frag = $stat; $frag =~ s/;+\s*$//;
1956 if ($frag !~ /(?:{|;)/) {
1957#print "skip<$line_nr_next>\n";
1958 $suppress_statement = $line_nr_next;
1959 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001960
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001961 # Find the real next line.
1962 $realline_next = $line_nr_next;
1963 if (defined $realline_next &&
1964 (!defined $lines[$realline_next - 1] ||
1965 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1966 $realline_next++;
1967 }
1968
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001969 my $s = $stat;
1970 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001971
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001972 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001973 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001974
1975 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001976 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001977
Andy Whitcroft463f2862009-09-21 17:04:34 -07001978 } elsif ($s =~ /^.\s*else\b/s) {
1979
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001980 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001981 } 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 -07001982 my $type = $1;
1983 $type =~ s/\s+/ /g;
1984 possible($type, "A:" . $s);
1985
Andy Whitcroft8905a672007-11-28 16:21:06 -08001986 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001987 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001988 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001989 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001990
1991 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001992 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001993 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001994 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001995
1996 # Check for any sort of function declaration.
1997 # int foo(something bar, other baz);
1998 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001999 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 -08002000 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002001
Andy Whitcroftcf655042008-03-04 14:28:20 -08002002 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002003 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002004 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002005
Andy Whitcroft8905a672007-11-28 16:21:06 -08002006 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002007 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002008
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002009 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002010 }
2011 }
2012 }
2013
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002014 }
2015
Andy Whitcroft653d4872007-06-23 17:16:34 -07002016#
2017# Checks which may be anchored in the context.
2018#
2019
2020# Check for switch () and associated case and default
2021# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002022 if ($line=~/\bswitch\s*\(.*\)/) {
2023 my $err = '';
2024 my $sep = '';
2025 my @ctx = ctx_block_outer($linenr, $realcnt);
2026 shift(@ctx);
2027 for my $ctx (@ctx) {
2028 my ($clen, $cindent) = line_stats($ctx);
2029 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2030 $indent != $cindent) {
2031 $err .= "$sep$ctx\n";
2032 $sep = '';
2033 } else {
2034 $sep = "[...]\n";
2035 }
2036 }
2037 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002038 ERROR("SWITCH_CASE_INDENT_LEVEL",
2039 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002040 }
2041 }
2042
2043# if/while/etc brace do not go on next line, unless defining a do while loop,
2044# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002045 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002046 my $pre_ctx = "$1$2";
2047
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002048 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002049
2050 if ($line =~ /^\+\t{6,}/) {
2051 WARN("DEEP_INDENTATION",
2052 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2053 }
2054
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002055 my $ctx_cnt = $realcnt - $#ctx - 1;
2056 my $ctx = join("\n", @ctx);
2057
Andy Whitcroft548596d2008-07-23 21:29:01 -07002058 my $ctx_ln = $linenr;
2059 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002060
Andy Whitcroft548596d2008-07-23 21:29:01 -07002061 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2062 defined $lines[$ctx_ln - 1] &&
2063 $lines[$ctx_ln - 1] =~ /^-/)) {
2064 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2065 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002066 $ctx_ln++;
2067 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002068
Andy Whitcroft53210162008-07-23 21:29:03 -07002069 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2070 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002071
2072 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002073 ERROR("OPEN_BRACE",
2074 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002075 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002076 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002077 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2078 $ctx =~ /\)\s*\;\s*$/ &&
2079 defined $lines[$ctx_ln - 1])
2080 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002081 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2082 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002083 WARN("TRAILING_SEMICOLON",
2084 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002085 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002086 }
2087 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002088 }
2089
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002090# Check relative indent for conditionals and blocks.
2091 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002092 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2093 ctx_statement_block($linenr, $realcnt, 0)
2094 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002095 my ($s, $c) = ($stat, $cond);
2096
2097 substr($s, 0, length($c), '');
2098
2099 # Make sure we remove the line prefixes as we have
2100 # none on the first line, and are going to readd them
2101 # where necessary.
2102 $s =~ s/\n./\n/gs;
2103
2104 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002105 my @newlines = ($c =~ /\n/gs);
2106 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002107
2108 # We want to check the first line inside the block
2109 # starting at the end of the conditional, so remove:
2110 # 1) any blank line termination
2111 # 2) any opening brace { on end of the line
2112 # 3) any do (...) {
2113 my $continuation = 0;
2114 my $check = 0;
2115 $s =~ s/^.*\bdo\b//;
2116 $s =~ s/^\s*{//;
2117 if ($s =~ s/^\s*\\//) {
2118 $continuation = 1;
2119 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002120 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002121 $check = 1;
2122 $cond_lines++;
2123 }
2124
2125 # Also ignore a loop construct at the end of a
2126 # preprocessor statement.
2127 if (($prevline =~ /^.\s*#\s*define\s/ ||
2128 $prevline =~ /\\\s*$/) && $continuation == 0) {
2129 $check = 0;
2130 }
2131
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002132 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002133 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002134 while ($cond_ptr != $cond_lines) {
2135 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002136
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002137 # If we see an #else/#elif then the code
2138 # is not linear.
2139 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2140 $check = 0;
2141 }
2142
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002143 # Ignore:
2144 # 1) blank lines, they should be at 0,
2145 # 2) preprocessor lines, and
2146 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002147 if ($continuation ||
2148 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002149 $s =~ /^\s*#\s*?/ ||
2150 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002151 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002152 if ($s =~ s/^.*?\n//) {
2153 $cond_lines++;
2154 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002155 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002156 }
2157
2158 my (undef, $sindent) = line_stats("+" . $s);
2159 my $stat_real = raw_line($linenr, $cond_lines);
2160
2161 # Check if either of these lines are modified, else
2162 # this is not this patch's fault.
2163 if (!defined($stat_real) ||
2164 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2165 $check = 0;
2166 }
2167 if (defined($stat_real) && $cond_lines > 1) {
2168 $stat_real = "[...]\n$stat_real";
2169 }
2170
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002171 #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 -07002172
2173 if ($check && (($sindent % 8) != 0 ||
2174 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002175 WARN("SUSPECT_CODE_INDENT",
2176 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002177 }
2178 }
2179
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002180 # Track the 'values' across context and added lines.
2181 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002182 my ($curr_values, $curr_vars) =
2183 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002184 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002185 if ($dbg_values) {
2186 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002187 print "$linenr > .$outline\n";
2188 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002189 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002190 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002191 $prev_values = substr($curr_values, -1);
2192
Andy Whitcroft00df3442007-06-08 13:47:06 -07002193#ignore lines not being added
2194 if ($line=~/^[^\+]/) {next;}
2195
Andy Whitcroft653d4872007-06-23 17:16:34 -07002196# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002197 if ($dbg_type) {
2198 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002199 ERROR("TEST_TYPE",
2200 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002201 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002202 ERROR("TEST_NOT_TYPE",
2203 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002204 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002205 next;
2206 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002207# TEST: allow direct testing of the attribute matcher.
2208 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002209 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002210 ERROR("TEST_ATTR",
2211 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002212 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002213 ERROR("TEST_NOT_ATTR",
2214 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002215 }
2216 next;
2217 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002218
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002219# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002220 if ($line =~ /^.\s*{/ &&
2221 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002222 ERROR("OPEN_BRACE",
2223 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002224 }
2225
Andy Whitcroft653d4872007-06-23 17:16:34 -07002226#
2227# Checks which are anchored on the added line.
2228#
2229
2230# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002231 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002232 my $path = $1;
2233 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002234 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002235 "malformed #include filename\n" . $herecurr);
2236 }
2237 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2238 ERROR("UAPI_INCLUDE",
2239 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002240 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002241 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002242
2243# no C99 // comments
2244 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002245 ERROR("C99_COMMENTS",
2246 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002247 }
2248 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002249 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002250 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002251
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002252# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2253# the whole statement.
2254#print "APW <$lines[$realline_next - 1]>\n";
2255 if (defined $realline_next &&
2256 exists $lines[$realline_next - 1] &&
2257 !defined $suppress_export{$realline_next} &&
2258 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2259 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002260 # Handle definitions which produce identifiers with
2261 # a prefix:
2262 # XXX(foo);
2263 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002264 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002265 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002266 $name =~ /^${Ident}_$2/) {
2267#print "FOO C name<$name>\n";
2268 $suppress_export{$realline_next} = 1;
2269
2270 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002271 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002272 ^.DEFINE_$Ident\(\Q$name\E\)|
2273 ^.DECLARE_$Ident\(\Q$name\E\)|
2274 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002275 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2276 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002277 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002278#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2279 $suppress_export{$realline_next} = 2;
2280 } else {
2281 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002282 }
2283 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002284 if (!defined $suppress_export{$linenr} &&
2285 $prevline =~ /^.\s*$/ &&
2286 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2287 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2288#print "FOO B <$lines[$linenr - 1]>\n";
2289 $suppress_export{$linenr} = 2;
2290 }
2291 if (defined $suppress_export{$linenr} &&
2292 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002293 WARN("EXPORT_SYMBOL",
2294 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002295 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002296
Joe Eloff5150bda2010-08-09 17:21:00 -07002297# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002298 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002299 ERROR("GLOBAL_INITIALISERS",
2300 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002301 $herecurr);
2302 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002303# check for static initialisers.
Andy Whitcroft2d1bafd72009-01-06 14:41:28 -08002304 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002305 ERROR("INITIALISED_STATIC",
2306 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002307 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002308 }
2309
Joe Perchescb710ec2010-10-26 14:23:20 -07002310# check for static const char * arrays.
2311 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002312 WARN("STATIC_CONST_CHAR_ARRAY",
2313 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002314 $herecurr);
2315 }
2316
2317# check for static char foo[] = "bar" declarations.
2318 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002319 WARN("STATIC_CONST_CHAR_ARRAY",
2320 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002321 $herecurr);
2322 }
2323
Joe Perches93ed0e22010-10-26 14:23:21 -07002324# check for declarations of struct pci_device_id
2325 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002326 WARN("DEFINE_PCI_DEVICE_TABLE",
2327 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002328 }
2329
Andy Whitcroft653d4872007-06-23 17:16:34 -07002330# check for new typedefs, only function parameters and sparse annotations
2331# make sense.
2332 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002333 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002334 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002335 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002336 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002337 WARN("NEW_TYPEDEFS",
2338 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002339 }
2340
2341# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002342 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002343 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2344 #print "AA<$1>\n";
2345 my ($from, $to) = ($2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002346
Andy Whitcroft65863862009-01-06 14:41:21 -08002347 # Should start with a space.
2348 $to =~ s/^(\S)/ $1/;
2349 # Should not end with a space.
2350 $to =~ s/\s+$//;
2351 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002352 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002353 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002354
Andy Whitcroft65863862009-01-06 14:41:21 -08002355 #print "from<$from> to<$to>\n";
2356 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002357 ERROR("POINTER_LOCATION",
2358 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002359 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002360 }
2361 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2362 #print "BB<$1>\n";
2363 my ($from, $to, $ident) = ($2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002364
Andy Whitcroft65863862009-01-06 14:41:21 -08002365 # Should start with a space.
2366 $to =~ s/^(\S)/ $1/;
2367 # Should not end with a space.
2368 $to =~ s/\s+$//;
2369 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002370 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002371 }
2372 # Modifiers should have spaces.
2373 $to =~ s/(\b$Modifier$)/$1 /;
2374
Andy Whitcroft667026e2009-02-27 14:03:08 -08002375 #print "from<$from> to<$to> ident<$ident>\n";
2376 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002377 ERROR("POINTER_LOCATION",
2378 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002379 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002380 }
2381
2382# # no BUG() or BUG_ON()
2383# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2384# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2385# print "$herecurr";
2386# $clean = 0;
2387# }
2388
Andy Whitcroft8905a672007-11-28 16:21:06 -08002389 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002390 WARN("LINUX_VERSION_CODE",
2391 "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 -08002392 }
2393
Joe Perches17441222011-06-15 15:08:17 -07002394# check for uses of printk_ratelimit
2395 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002396 WARN("PRINTK_RATELIMITED",
2397"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002398 }
2399
Andy Whitcroft00df3442007-06-08 13:47:06 -07002400# printk should use KERN_* levels. Note that follow on printk's on the
2401# same line do not need a level, so we use the current block context
2402# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002403# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002404# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002405 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002406 my $ok = 0;
2407 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2408 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002409 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002410 # with "\n" ignore it, else it is to blame
2411 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2412 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2413 $ok = 1;
2414 }
2415 last;
2416 }
2417 }
2418 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002419 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2420 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002421 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002422 }
2423
Joe Perches243f3802012-05-31 16:26:09 -07002424 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2425 my $orig = $1;
2426 my $level = lc($orig);
2427 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002428 my $level2 = $level;
2429 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002430 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002431 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002432 }
2433
2434 if ($line =~ /\bpr_warning\s*\(/) {
2435 WARN("PREFER_PR_LEVEL",
2436 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2437 }
2438
Joe Perchesdc139312013-02-21 16:44:13 -08002439 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2440 my $orig = $1;
2441 my $level = lc($orig);
2442 $level = "warn" if ($level eq "warning");
2443 $level = "dbg" if ($level eq "debug");
2444 WARN("PREFER_DEV_LEVEL",
2445 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2446 }
2447
Andy Whitcroft653d4872007-06-23 17:16:34 -07002448# function brace can't be on same line, except for #defines of do while,
2449# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002450 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2451 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002452 ERROR("OPEN_BRACE",
2453 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002454 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002455
Andy Whitcroft8905a672007-11-28 16:21:06 -08002456# open braces for enum, union and struct go on the same line.
2457 if ($line =~ /^.\s*{/ &&
2458 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002459 ERROR("OPEN_BRACE",
2460 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002461 }
2462
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002463# missing space after union, struct or enum definition
2464 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002465 WARN("SPACING",
2466 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002467 }
2468
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002469# check for spacing round square brackets; allowed:
2470# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002471# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2472# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002473 while ($line =~ /(.*?\s)\[/g) {
2474 my ($where, $prefix) = ($-[1], $1);
2475 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002476 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002477 $prefix !~ /[{,]\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002478 ERROR("BRACKET_SPACE",
2479 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002480 }
2481 }
2482
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002483# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002484 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002485 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002486 my $ctx_before = substr($line, 0, $-[1]);
2487 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002488
2489 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002490 if ($name =~ /^(?:
2491 if|for|while|switch|return|case|
2492 volatile|__volatile__|
2493 __attribute__|format|__extension__|
2494 asm|__asm__)$/x)
2495 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002496
2497 # cpp #define statements have non-optional spaces, ie
2498 # if there is a space between the name and the open
2499 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002500 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002501
2502 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002503 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002504
2505 # If this whole things ends with a type its most
2506 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002507 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002508
2509 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002510 WARN("SPACING",
2511 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002512 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002513 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002514
2515# check for whitespace before a non-naked semicolon
2516 if ($line =~ /^\+.*\S\s+;/) {
2517 CHK("SPACING",
2518 "space prohibited before semicolon\n" . $herecurr);
2519 }
2520
Andy Whitcroft653d4872007-06-23 17:16:34 -07002521# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002522 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002523 my $ops = qr{
2524 <<=|>>=|<=|>=|==|!=|
2525 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2526 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002527 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2528 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002529 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002530 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002531 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002532
2533 my $blank = copy_spacing($opline);
2534
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002535 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002536 $off += length($elements[$n]);
2537
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002538 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002539 my $ca = substr($opline, 0, $off);
2540 my $cc = '';
2541 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2542 $cc = substr($opline, $off + length($elements[$n + 1]));
2543 }
2544 my $cb = "$ca$;$cc";
2545
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002546 my $a = '';
2547 $a = 'V' if ($elements[$n] ne '');
2548 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002549 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002550 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2551 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002552 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002553
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002554 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002555
2556 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002557 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002558 $c = 'V' if ($elements[$n + 2] ne '');
2559 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002560 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002561 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2562 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002563 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002564 } else {
2565 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002566 }
2567
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002568 my $ctx = "${a}x${c}";
2569
2570 my $at = "(ctx:$ctx)";
2571
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002572 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002573 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002574
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002575 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002576 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002577
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002578 # Get the full operator variant.
2579 my $opv = $op . substr($curr_vars, $off, 1);
2580
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002581 # Ignore operators passed as parameters.
2582 if ($op_type ne 'V' &&
2583 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2584
Andy Whitcroftcf655042008-03-04 14:28:20 -08002585# # Ignore comments
2586# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002587
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002588 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002589 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002590 if ($ctx !~ /.x[WEBC]/ &&
2591 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002592 ERROR("SPACING",
2593 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002594 }
2595
2596 # // is a comment
2597 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002598
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002599 # No spaces for:
2600 # ->
2601 # : when part of a bitfield
2602 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002603 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002604 ERROR("SPACING",
2605 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002606 }
2607
2608 # , must have a space on the right.
2609 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002610 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002611 ERROR("SPACING",
2612 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002613 }
2614
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002615 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002616 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002617 #warn "'*' is part of type\n";
2618
2619 # unary operators should have a space before and
2620 # none after. May be left adjacent to another
2621 # unary operator, or a cast
2622 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002623 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002624 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002625 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002626 ERROR("SPACING",
2627 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002628 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002629 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002630 # A unary '*' may be const
2631
2632 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002633 ERROR("SPACING",
2634 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002635 }
2636
2637 # unary ++ and unary -- are allowed no space on one side.
2638 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002639 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002640 ERROR("SPACING",
2641 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002642 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002643 if ($ctx =~ /Wx[BE]/ ||
2644 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002645 ERROR("SPACING",
2646 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002647 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002648 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002649 ERROR("SPACING",
2650 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002651 }
2652
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002653
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002654 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002655 } elsif ($op eq '<<' or $op eq '>>' or
2656 $op eq '&' or $op eq '^' or $op eq '|' or
2657 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002658 $op eq '*' or $op eq '/' or
2659 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002660 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002661 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002662 ERROR("SPACING",
2663 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002664 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002665 }
2666
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002667 # A colon needs no spaces before when it is
2668 # terminating a case value or a label.
2669 } elsif ($opv eq ':C' || $opv eq ':L') {
2670 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002671 ERROR("SPACING",
2672 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002673 }
2674
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002675 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002676 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002677 my $ok = 0;
2678
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002679 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002680 if (($op eq '<' &&
2681 $cc =~ /^\S+\@\S+>/) ||
2682 ($op eq '>' &&
2683 $ca =~ /<\S+\@\S+$/))
2684 {
2685 $ok = 1;
2686 }
2687
2688 # Ignore ?:
2689 if (($opv eq ':O' && $ca =~ /\?$/) ||
2690 ($op eq '?' && $cc =~ /^:/)) {
2691 $ok = 1;
2692 }
2693
2694 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002695 ERROR("SPACING",
2696 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002697 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002698 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002699 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002700 }
2701 }
2702
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002703# check for multiple assignments
2704 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002705 CHK("MULTIPLE_ASSIGNMENTS",
2706 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002707 }
2708
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002709## # check for multiple declarations, allowing for a function declaration
2710## # continuation.
2711## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2712## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2713##
2714## # Remove any bracketed sections to ensure we do not
2715## # falsly report the parameters of functions.
2716## my $ln = $line;
2717## while ($ln =~ s/\([^\(\)]*\)//g) {
2718## }
2719## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002720## WARN("MULTIPLE_DECLARATION",
2721## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002722## }
2723## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002724
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002725#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002726 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2727 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002728 ERROR("SPACING",
2729 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002730 }
2731
2732# closing brace should have a space following it when it has anything
2733# on the line
2734 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002735 ERROR("SPACING",
2736 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002737 }
2738
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002739# check spacing on square brackets
2740 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002741 ERROR("SPACING",
2742 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002743 }
2744 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002745 ERROR("SPACING",
2746 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002747 }
2748
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002749# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002750 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2751 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002752 ERROR("SPACING",
2753 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002754 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002755 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002756 $line !~ /for\s*\(.*;\s+\)/ &&
2757 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002758 ERROR("SPACING",
2759 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002760 }
2761
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002762#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002763 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002764 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002765 WARN("INDENTED_LABEL",
2766 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002767 }
2768
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002769# Return is not a function.
2770 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2771 my $spacing = $1;
2772 my $value = $2;
2773
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002774 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002775 $value =~ s/\(/ \(/g;
2776 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08002777 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002778 $value !~ /(?:$Ident|-?$Constant)\s*
2779 $Compare\s*
2780 (?:$Ident|-?$Constant)/x &&
2781 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002782 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002783#print "value<$value>\n";
2784 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002785 ERROR("RETURN_PARENTHESES",
2786 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002787
2788 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002789 ERROR("SPACING",
2790 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002791 }
2792 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002793# Return of what appears to be an errno should normally be -'ve
2794 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2795 my $name = $1;
2796 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002797 WARN("USE_NEGATIVE_ERRNO",
2798 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002799 }
2800 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002801
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002802# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002803 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002804 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002805 }
2806
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002807# Check for illegal assignment in if conditional -- and check for trailing
2808# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002809 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002810 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2811 ctx_statement_block($linenr, $realcnt, 0)
2812 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002813 my ($stat_next) = ctx_statement_block($line_nr_next,
2814 $remain_next, $off_next);
2815 $stat_next =~ s/\n./\n /g;
2816 ##print "stat<$stat> stat_next<$stat_next>\n";
2817
2818 if ($stat_next =~ /^\s*while\b/) {
2819 # If the statement carries leading newlines,
2820 # then count those as offsets.
2821 my ($whitespace) =
2822 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2823 my $offset =
2824 statement_rawlines($whitespace) - 1;
2825
2826 $suppress_whiletrailers{$line_nr_next +
2827 $offset} = 1;
2828 }
2829 }
2830 if (!defined $suppress_whiletrailers{$linenr} &&
2831 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002832 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002833
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002834 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002835 ERROR("ASSIGN_IN_IF",
2836 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002837 }
2838
2839 # Find out what is on the end of the line after the
2840 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002841 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002842 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002843 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002844 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2845 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002846 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002847 # Find out how long the conditional actually is.
2848 my @newlines = ($c =~ /\n/gs);
2849 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002850 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002851
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002852 $stat_real = raw_line($linenr, $cond_lines)
2853 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002854 if (defined($stat_real) && $cond_lines > 1) {
2855 $stat_real = "[...]\n$stat_real";
2856 }
2857
Joe Perches000d1cc12011-07-25 17:13:25 -07002858 ERROR("TRAILING_STATEMENTS",
2859 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002860 }
2861 }
2862
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002863# Check for bitwise tests written as boolean
2864 if ($line =~ /
2865 (?:
2866 (?:\[|\(|\&\&|\|\|)
2867 \s*0[xX][0-9]+\s*
2868 (?:\&\&|\|\|)
2869 |
2870 (?:\&\&|\|\|)
2871 \s*0[xX][0-9]+\s*
2872 (?:\&\&|\|\||\)|\])
2873 )/x)
2874 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002875 WARN("HEXADECIMAL_BOOLEAN_TEST",
2876 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002877 }
2878
Andy Whitcroft8905a672007-11-28 16:21:06 -08002879# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002880 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2881 my $s = $1;
2882 $s =~ s/$;//g; # Remove any comments
2883 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002884 ERROR("TRAILING_STATEMENTS",
2885 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002886 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002887 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002888# if should not continue a brace
2889 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002890 ERROR("TRAILING_STATEMENTS",
2891 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002892 $herecurr);
2893 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002894# case and default should not have general statements after them
2895 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2896 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002897 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002898 \s*return\s+
2899 )/xg)
2900 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002901 ERROR("TRAILING_STATEMENTS",
2902 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002903 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002904
2905 # Check for }<nl>else {, these must be at the same
2906 # indent level to be relevant to each other.
2907 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2908 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002909 ERROR("ELSE_AFTER_BRACE",
2910 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002911 }
2912
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002913 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2914 $previndent == $indent) {
2915 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2916
2917 # Find out what is on the end of the line after the
2918 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002919 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002920 $s =~ s/\n.*//g;
2921
2922 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002923 ERROR("WHILE_AFTER_BRACE",
2924 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002925 }
2926 }
2927
Joe Perches323c1262012-12-17 16:02:07 -08002928#CamelCase
2929 while ($line =~ m{($Constant|$Lval)}g) {
2930 my $var = $1;
2931 if ($var !~ /$Constant/ &&
2932 $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ &&
Joe Perchesbe987d92013-02-27 17:02:38 -08002933 $var !~ /"^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches323c1262012-12-17 16:02:07 -08002934 !defined $camelcase{$var}) {
2935 $camelcase{$var} = 1;
2936 WARN("CAMELCASE",
2937 "Avoid CamelCase: <$var>\n" . $herecurr);
2938 }
2939 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002940
2941#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002942 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002943 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2944 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002945 }
2946
Andy Whitcroft653d4872007-06-23 17:16:34 -07002947#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002948 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002949 my $file = "$1.h";
2950 my $checkfile = "include/linux/$file";
2951 if (-f "$root/$checkfile" &&
2952 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002953 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002954 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002955 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002956 CHK("ARCH_INCLUDE_LINUX",
2957 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002958 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002959 WARN("INCLUDE_LINUX",
2960 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002961 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002962 }
2963 }
2964
Andy Whitcroft653d4872007-06-23 17:16:34 -07002965# multi-statement macros should be enclosed in a do while loop, grab the
2966# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002967# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002968 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2969 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002970 my $ln = $linenr;
2971 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002972 my ($off, $dstat, $dcond, $rest);
2973 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002974 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002975 ctx_statement_block($linenr, $realcnt, 0);
2976 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002977 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002978 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002979
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002980 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002981 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002982 $dstat =~ s/\\\n.//g;
2983 $dstat =~ s/^\s*//s;
2984 $dstat =~ s/\s*$//s;
2985
2986 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002987 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2988 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08002989 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002990 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002991 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002992
Andy Whitcrofte45bab82012-03-23 15:02:18 -07002993 # Flatten any obvious string concatentation.
2994 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
2995 $dstat =~ s/$Ident\s*("X*")/$1/)
2996 {
2997 }
2998
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002999 my $exceptions = qr{
3000 $Declare|
3001 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003002 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003003 DECLARE_PER_CPU|
3004 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003005 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003006 union|
3007 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003008 \.$Ident\s*=\s*|
3009 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003010 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003011 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003012 if ($dstat ne '' &&
3013 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3014 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Andy Whitcroftfd1b57a2012-03-23 15:02:18 -07003015 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003016 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003017 $dstat !~ /$exceptions/ &&
3018 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003019 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003020 $dstat !~ /^for\s*$Constant$/ && # for (...)
3021 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3022 $dstat !~ /^do\s*{/ && # do {...
3023 $dstat !~ /^\({/) # ({...
3024 {
3025 $ctx =~ s/\n*$//;
3026 my $herectx = $here . "\n";
3027 my $cnt = statement_rawlines($ctx);
3028
3029 for (my $n = 0; $n < $cnt; $n++) {
3030 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003031 }
3032
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003033 if ($dstat =~ /;/) {
3034 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3035 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3036 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003037 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003038 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003039 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003040 }
Joe Perches5023d342012-12-17 16:01:47 -08003041
Joe Perches481eb482012-12-17 16:01:56 -08003042# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003043
3044 } else {
3045 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003046 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3047 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003048 $line =~ /^\+.*\\$/) {
3049 WARN("LINE_CONTINUATIONS",
3050 "Avoid unnecessary line continuations\n" . $herecurr);
3051 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003052 }
3053
Joe Perchesb13edf72012-07-30 14:41:24 -07003054# do {} while (0) macro tests:
3055# single-statement macros do not need to be enclosed in do while (0) loop,
3056# macro should not end with a semicolon
3057 if ($^V && $^V ge 5.10.0 &&
3058 $realfile !~ m@/vmlinux.lds.h$@ &&
3059 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3060 my $ln = $linenr;
3061 my $cnt = $realcnt;
3062 my ($off, $dstat, $dcond, $rest);
3063 my $ctx = '';
3064 ($dstat, $dcond, $ln, $cnt, $off) =
3065 ctx_statement_block($linenr, $realcnt, 0);
3066 $ctx = $dstat;
3067
3068 $dstat =~ s/\\\n.//g;
3069
3070 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3071 my $stmts = $2;
3072 my $semis = $3;
3073
3074 $ctx =~ s/\n*$//;
3075 my $cnt = statement_rawlines($ctx);
3076 my $herectx = $here . "\n";
3077
3078 for (my $n = 0; $n < $cnt; $n++) {
3079 $herectx .= raw_line($linenr, $n) . "\n";
3080 }
3081
Joe Perchesac8e97f2012-08-21 16:15:53 -07003082 if (($stmts =~ tr/;/;/) == 1 &&
3083 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003084 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3085 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3086 }
3087 if (defined $semis && $semis ne "") {
3088 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3089 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3090 }
3091 }
3092 }
3093
Mike Frysinger080ba922009-01-06 14:41:25 -08003094# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3095# all assignments may have only one of the following with an assignment:
3096# .
3097# ALIGN(...)
3098# VMLINUX_SYMBOL(...)
3099 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003100 WARN("MISSING_VMLINUX_SYMBOL",
3101 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003102 }
3103
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003104# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003105 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3106 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003107 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003108 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003109 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3110 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003111 my @allowed = ();
3112 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003113 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003114 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003115 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003116 for my $chunk (@chunks) {
3117 my ($cond, $block) = @{$chunk};
3118
Andy Whitcroft773647a2008-03-28 14:15:58 -07003119 # If the condition carries leading newlines, then count those as offsets.
3120 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3121 my $offset = statement_rawlines($whitespace) - 1;
3122
Joe Perchesaad4f612012-03-23 15:02:19 -07003123 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003124 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3125
3126 # We have looked at and allowed this specific line.
3127 $suppress_ifbraces{$ln + $offset} = 1;
3128
3129 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003130 $ln += statement_rawlines($block) - 1;
3131
Andy Whitcroft773647a2008-03-28 14:15:58 -07003132 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003133
3134 $seen++ if ($block =~ /^\s*{/);
3135
Joe Perchesaad4f612012-03-23 15:02:19 -07003136 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003137 if (statement_lines($cond) > 1) {
3138 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003139 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003140 }
3141 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003142 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003143 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003144 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003145 if (statement_block_size($block) > 1) {
3146 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003147 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003148 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003149 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003150 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003151 if ($seen) {
3152 my $sum_allowed = 0;
3153 foreach (@allowed) {
3154 $sum_allowed += $_;
3155 }
3156 if ($sum_allowed == 0) {
3157 WARN("BRACES",
3158 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3159 } elsif ($sum_allowed != $allow &&
3160 $seen != $allow) {
3161 CHK("BRACES",
3162 "braces {} should be used on all arms of this statement\n" . $herectx);
3163 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003164 }
3165 }
3166 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003167 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003168 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003169 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003170
Andy Whitcroftcf655042008-03-04 14:28:20 -08003171 # Check the pre-context.
3172 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3173 #print "APW: ALLOWED: pre<$1>\n";
3174 $allowed = 1;
3175 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003176
3177 my ($level, $endln, @chunks) =
3178 ctx_statement_full($linenr, $realcnt, $-[0]);
3179
Andy Whitcroftcf655042008-03-04 14:28:20 -08003180 # Check the condition.
3181 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003182 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003183 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003184 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003185 }
3186 if (statement_lines($cond) > 1) {
3187 #print "APW: ALLOWED: cond<$cond>\n";
3188 $allowed = 1;
3189 }
3190 if ($block =~/\b(?:if|for|while)\b/) {
3191 #print "APW: ALLOWED: block<$block>\n";
3192 $allowed = 1;
3193 }
3194 if (statement_block_size($block) > 1) {
3195 #print "APW: ALLOWED: lines block<$block>\n";
3196 $allowed = 1;
3197 }
3198 # Check the post-context.
3199 if (defined $chunks[1]) {
3200 my ($cond, $block) = @{$chunks[1]};
3201 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003202 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003203 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003204 if ($block =~ /^\s*\{/) {
3205 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3206 $allowed = 1;
3207 }
3208 }
3209 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003210 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003211 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003212
Andy Whitcroftf0556632008-10-15 22:02:23 -07003213 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003214 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003215 }
3216
Joe Perches000d1cc12011-07-25 17:13:25 -07003217 WARN("BRACES",
3218 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003219 }
3220 }
3221
Joe Perches0979ae62012-12-17 16:01:59 -08003222# check for unnecessary blank lines around braces
3223 if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) {
3224 CHK("BRACES",
3225 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3226 }
3227 if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3228 CHK("BRACES",
3229 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3230 }
3231
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003232# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003233 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3234 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003235 WARN("VOLATILE",
3236 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003237 }
3238
Andy Whitcroft00df3442007-06-08 13:47:06 -07003239# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003240 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003241 CHK("REDUNDANT_CODE",
3242 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003243 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003244 }
3245
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003246# check for needless "if (<foo>) fn(<foo>)" uses
3247 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3248 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3249 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3250 WARN('NEEDLESS_IF',
3251 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003252 }
3253 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003254
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003255# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003256 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003257 # ignore udelay's < 10, however
Bruce Allan37581c22013-02-21 16:44:19 -08003258 if (! ($1 < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003259 CHK("USLEEP_RANGE",
3260 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003261 }
3262 }
3263
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003264# warn about unexpectedly long msleep's
3265 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3266 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003267 WARN("MSLEEP",
3268 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003269 }
3270 }
3271
Andy Whitcroft00df3442007-06-08 13:47:06 -07003272# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003273# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003274# print "#ifdef in C files should be avoided\n";
3275# print "$herecurr";
3276# $clean = 0;
3277# }
3278
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003279# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003280 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003281 ERROR("SPACING",
3282 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003283 }
3284
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003285# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003286 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3287 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003288 my $which = $1;
3289 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003290 CHK("UNCOMMENTED_DEFINITION",
3291 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003292 }
3293 }
3294# check for memory barriers without a comment.
3295 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3296 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003297 CHK("MEMORY_BARRIER",
3298 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003299 }
3300 }
3301# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003302 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003303 CHK("ARCH_DEFINES",
3304 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003305 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003306
Tobias Klauserd4977c72010-05-24 14:33:30 -07003307# Check that the storage class is at the beginning of a declaration
3308 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003309 WARN("STORAGE_CLASS",
3310 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003311 }
3312
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003313# check the location of the inline attribute, that it is between
3314# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003315 if ($line =~ /\b$Type\s+$Inline\b/ ||
3316 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003317 ERROR("INLINE_LOCATION",
3318 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003319 }
3320
Andy Whitcroft8905a672007-11-28 16:21:06 -08003321# Check for __inline__ and __inline, prefer inline
3322 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003323 WARN("INLINE",
3324 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003325 }
3326
Joe Perches3d130fd2011-01-12 17:00:00 -08003327# Check for __attribute__ packed, prefer __packed
3328 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003329 WARN("PREFER_PACKED",
3330 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003331 }
3332
Joe Perches39b7e282011-07-25 17:13:24 -07003333# Check for __attribute__ aligned, prefer __aligned
3334 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003335 WARN("PREFER_ALIGNED",
3336 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003337 }
3338
Joe Perches5f14d3b2012-01-10 15:09:52 -08003339# Check for __attribute__ format(printf, prefer __printf
3340 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3341 WARN("PREFER_PRINTF",
3342 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3343 }
3344
Joe Perches6061d942012-03-23 15:02:16 -07003345# Check for __attribute__ format(scanf, prefer __scanf
3346 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3347 WARN("PREFER_SCANF",
3348 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3349 }
3350
Joe Perches8f53a9b2010-03-05 13:43:48 -08003351# check for sizeof(&)
3352 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003353 WARN("SIZEOF_ADDRESS",
3354 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003355 }
3356
Joe Perches66c80b62012-07-30 14:41:22 -07003357# check for sizeof without parenthesis
3358 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3359 WARN("SIZEOF_PARENTHESIS",
3360 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3361 }
3362
Joe Perches428e2fd2011-05-24 17:13:39 -07003363# check for line continuations in quoted strings with odd counts of "
3364 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003365 WARN("LINE_CONTINUATIONS",
3366 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003367 }
3368
Joe Perches88982fe2012-12-17 16:02:00 -08003369# check for struct spinlock declarations
3370 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3371 WARN("USE_SPINLOCK_T",
3372 "struct spinlock should be spinlock_t\n" . $herecurr);
3373 }
3374
Andy Whitcroft554e1652012-01-10 15:09:57 -08003375# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003376 if ($^V && $^V ge 5.10.0 &&
3377 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003378 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003379
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003380 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003381 my $ms_val = $7;
3382 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003383
Andy Whitcroft554e1652012-01-10 15:09:57 -08003384 if ($ms_size =~ /^(0x|)0$/i) {
3385 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003386 "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 -08003387 } elsif ($ms_size =~ /^(0x|)1$/i) {
3388 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003389 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3390 }
3391 }
3392
3393# typecasts on min/max could be min_t/max_t
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 =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003397 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003398 my $call = $1;
3399 my $cast1 = deparenthesize($2);
3400 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003401 my $cast2 = deparenthesize($7);
3402 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003403 my $cast;
3404
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003405 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003406 $cast = "$cast1 or $cast2";
3407 } elsif ($cast1 ne "") {
3408 $cast = $cast1;
3409 } else {
3410 $cast = $cast2;
3411 }
3412 WARN("MINMAX",
3413 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003414 }
3415 }
3416
Joe Perches4a273192012-07-30 14:41:20 -07003417# check usleep_range arguments
3418 if ($^V && $^V ge 5.10.0 &&
3419 defined $stat &&
3420 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3421 my $min = $1;
3422 my $max = $7;
3423 if ($min eq $max) {
3424 WARN("USLEEP_RANGE",
3425 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3426 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3427 $min > $max) {
3428 WARN("USLEEP_RANGE",
3429 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3430 }
3431 }
3432
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003433# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003434 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003435 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003436 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003437 my $function_name = $1;
3438 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003439
3440 my $s = $stat;
3441 if (defined $cond) {
3442 substr($s, 0, length($cond), '');
3443 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003444 if ($s =~ /^\s*;/ &&
3445 $function_name ne 'uninitialized_var')
3446 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003447 WARN("AVOID_EXTERNS",
3448 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003449 }
3450
3451 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003452 WARN("FUNCTION_ARGUMENTS",
3453 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003454 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003455
3456 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3457 $stat =~ /^.\s*extern\s+/)
3458 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003459 WARN("AVOID_EXTERNS",
3460 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003461 }
3462
3463# checks for new __setup's
3464 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3465 my $name = $1;
3466
3467 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003468 CHK("UNDOCUMENTED_SETUP",
3469 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003470 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003471 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003472
3473# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003474 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003475 WARN("UNNECESSARY_CASTS",
3476 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003477 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003478
Joe Perches5ce59ae2013-02-21 16:44:18 -08003479# check for alloc argument mismatch
3480 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3481 WARN("ALLOC_ARRAY_ARGS",
3482 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3483 }
3484
Joe Perchescaf2a542011-01-12 16:59:56 -08003485# check for multiple semicolons
3486 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08003487 WARN("ONE_SEMICOLON",
3488 "Statements terminations use 1 semicolon\n" . $herecurr);
3489 }
3490
3491# check for switch/default statements without a break;
3492 if ($^V && $^V ge 5.10.0 &&
3493 defined $stat &&
3494 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3495 my $ctx = '';
3496 my $herectx = $here . "\n";
3497 my $cnt = statement_rawlines($stat);
3498 for (my $n = 0; $n < $cnt; $n++) {
3499 $herectx .= raw_line($linenr, $n) . "\n";
3500 }
3501 WARN("DEFAULT_NO_BREAK",
3502 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08003503 }
3504
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003505# check for gcc specific __FUNCTION__
3506 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003507 WARN("USE_FUNC",
3508 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003509 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003510
Joe Perches2c924882012-03-23 15:02:20 -07003511# check for use of yield()
3512 if ($line =~ /\byield\s*\(\s*\)/) {
3513 WARN("YIELD",
3514 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3515 }
3516
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003517# check for semaphores initialized locked
3518 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003519 WARN("CONSIDER_COMPLETION",
3520 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003521 }
Joe Perches6712d852012-03-23 15:02:20 -07003522
Joe Perches67d0a072011-10-31 17:13:10 -07003523# recommend kstrto* over simple_strto* and strict_strto*
3524 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003525 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003526 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003527 }
Joe Perches6712d852012-03-23 15:02:20 -07003528
Michael Ellermanf3db6632008-07-23 21:28:57 -07003529# check for __initcall(), use device_initcall() explicitly please
3530 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003531 WARN("USE_DEVICE_INITCALL",
3532 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003533 }
Joe Perches6712d852012-03-23 15:02:20 -07003534
Emese Revfy79404842010-03-05 13:43:53 -08003535# check for various ops structs, ensure they are const.
3536 my $struct_ops = qr{acpi_dock_ops|
3537 address_space_operations|
3538 backlight_ops|
3539 block_device_operations|
3540 dentry_operations|
3541 dev_pm_ops|
3542 dma_map_ops|
3543 extent_io_ops|
3544 file_lock_operations|
3545 file_operations|
3546 hv_ops|
3547 ide_dma_ops|
3548 intel_dvo_dev_ops|
3549 item_operations|
3550 iwl_ops|
3551 kgdb_arch|
3552 kgdb_io|
3553 kset_uevent_ops|
3554 lock_manager_operations|
3555 microcode_ops|
3556 mtrr_ops|
3557 neigh_ops|
3558 nlmsvc_binding|
3559 pci_raw_ops|
3560 pipe_buf_operations|
3561 platform_hibernation_ops|
3562 platform_suspend_ops|
3563 proto_ops|
3564 rpc_pipe_ops|
3565 seq_operations|
3566 snd_ac97_build_ops|
3567 soc_pcmcia_socket_ops|
3568 stacktrace_ops|
3569 sysfs_ops|
3570 tty_operations|
3571 usb_mon_operations|
3572 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003573 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003574 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003575 WARN("CONST_STRUCT",
3576 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003577 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003578 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003579
3580# use of NR_CPUS is usually wrong
3581# ignore definitions of NR_CPUS and usage to define arrays as likely right
3582 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003583 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3584 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003585 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3586 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3587 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003588 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003589 WARN("NR_CPUS",
3590 "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 -07003591 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003592
3593# check for %L{u,d,i} in strings
3594 my $string;
3595 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3596 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003597 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003598 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003599 WARN("PRINTF_L",
3600 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003601 last;
3602 }
3603 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003604
3605# whine mightly about in_atomic
3606 if ($line =~ /\bin_atomic\s*\(/) {
3607 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003608 ERROR("IN_ATOMIC",
3609 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003610 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003611 WARN("IN_ATOMIC",
3612 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003613 }
3614 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003615
3616# check for lockdep_set_novalidate_class
3617 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3618 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3619 if ($realfile !~ m@^kernel/lockdep@ &&
3620 $realfile !~ m@^include/linux/lockdep@ &&
3621 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003622 ERROR("LOCKDEP",
3623 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003624 }
3625 }
Dave Jones88f88312011-01-12 16:59:59 -08003626
3627 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3628 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003629 WARN("EXPORTED_WORLD_WRITABLE",
3630 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003631 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003632 }
3633
3634 # If we have no input at all, then there is nothing to report on
3635 # so just keep quiet.
3636 if ($#rawlines == -1) {
3637 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003638 }
3639
Andy Whitcroft8905a672007-11-28 16:21:06 -08003640 # In mailback mode only produce a report in the negative, for
3641 # things that appear to be patches.
3642 if ($mailback && ($clean == 1 || !$is_patch)) {
3643 exit(0);
3644 }
3645
3646 # This is not a patch, and we are are in 'no-patch' mode so
3647 # just keep quiet.
3648 if (!$chk_patch && !$is_patch) {
3649 exit(0);
3650 }
3651
3652 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003653 ERROR("NOT_UNIFIED_DIFF",
3654 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003655 }
3656 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003657 ERROR("MISSING_SIGN_OFF",
3658 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003659 }
3660
Andy Whitcroft8905a672007-11-28 16:21:06 -08003661 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003662 if ($summary && !($clean == 1 && $quiet == 1)) {
3663 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003664 print "total: $cnt_error errors, $cnt_warn warnings, " .
3665 (($check)? "$cnt_chk checks, " : "") .
3666 "$cnt_lines lines checked\n";
3667 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003668 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003669
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003670 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003671
3672 if ($^V lt 5.10.0) {
3673 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3674 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3675 }
3676
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003677 # If there were whitespace errors which cleanpatch can fix
3678 # then suggest that.
3679 if ($rpt_cleaners) {
3680 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3681 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003682 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003683 }
3684 }
3685
Artem Bityutskiy11232682012-03-23 15:02:17 -07003686 if ($quiet == 0 && keys %ignore_type) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003687 print "NOTE: Ignored message types:";
3688 foreach my $ignore (sort keys %ignore_type) {
3689 print " $ignore";
3690 }
Artem Bityutskiy11232682012-03-23 15:02:17 -07003691 print "\n\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003692 }
3693
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003694 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003695 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003696 }
3697 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003698 print << "EOM";
3699$vname has style problems, please review.
3700
3701If any of these errors are false positives, please report
3702them to the maintainer, see CHECKPATCH in MAINTAINERS.
3703EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003704 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003705
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003706 return $clean;
3707}