blob: 9de3a69260e1f30559dff572837d07406322b24c [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070012
Joe Perches000d1cc12011-07-25 17:13:25 -070013my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070029my $show_types = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080031my %debug;
Joe Perches000d1cc12011-07-25 17:13:25 -070032my %ignore_type = ();
33my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070034my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070035my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080036my $max_line_length = 80;
Hannes Eder77f5b102009-09-21 17:04:37 -070037
38sub help {
39 my ($exitcode) = @_;
40
41 print << "EOM";
42Usage: $P [OPTION]... [FILE]...
43Version: $V
44
45Options:
46 -q, --quiet quiet
47 --no-tree run without a kernel tree
48 --no-signoff do not check for 'Signed-off-by' line
49 --patch treat FILE as patchfile (default)
50 --emacs emacs compile window format
51 --terse one line per report
52 -f, --file treat FILE as regular source file
53 --subjective, --strict enable more subjective tests
Joe Perches000d1cc12011-07-25 17:13:25 -070054 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080055 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070056 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070057 --root=PATH PATH to the kernel tree root
58 --no-summary suppress the per-file summary
59 --mailback only produce a report in case of warnings/errors
60 --summary-file include the filename in summary
61 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
62 'values', 'possible', 'type', and 'attr' (default
63 is all off)
64 --test-only=WORD report only warnings/errors containing WORD
65 literally
66 -h, --help, --version display this help and exit
67
68When FILE is - read standard input.
69EOM
70
71 exit($exitcode);
72}
73
Joe Perches000d1cc12011-07-25 17:13:25 -070074my $conf = which_conf($configuration_file);
75if (-f $conf) {
76 my @conf_args;
77 open(my $conffile, '<', "$conf")
78 or warn "$P: Can't find a readable $configuration_file file $!\n";
79
80 while (<$conffile>) {
81 my $line = $_;
82
83 $line =~ s/\s*\n?$//g;
84 $line =~ s/^\s*//g;
85 $line =~ s/\s+/ /g;
86
87 next if ($line =~ m/^\s*#/);
88 next if ($line =~ m/^\s*$/);
89
90 my @words = split(" ", $line);
91 foreach my $word (@words) {
92 last if ($word =~ m/^#/);
93 push (@conf_args, $word);
94 }
95 }
96 close($conffile);
97 unshift(@ARGV, @conf_args) if @conf_args;
98}
99
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700100GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700101 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700102 'tree!' => \$tree,
103 'signoff!' => \$chk_signoff,
104 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700105 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800106 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700107 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700108 'subjective!' => \$check,
109 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700110 'ignore=s' => \@ignore,
111 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800112 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700113 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800114 'summary!' => \$summary,
115 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800116 'summary-file!' => \$summary_file,
117
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800118 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700119 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700120 'h|help' => \$help,
121 'version' => \$help
122) or help(1);
123
124help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700125
126my $exit = 0;
127
128if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700129 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700130 exit(1);
131}
132
Joe Perches000d1cc12011-07-25 17:13:25 -0700133@ignore = split(/,/, join(',',@ignore));
134foreach my $word (@ignore) {
135 $word =~ s/\s*\n?$//g;
136 $word =~ s/^\s*//g;
137 $word =~ s/\s+/ /g;
138 $word =~ tr/[a-z]/[A-Z]/;
139
140 next if ($word =~ m/^\s*#/);
141 next if ($word =~ m/^\s*$/);
142
143 $ignore_type{$word}++;
144}
145
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800146my $dbg_values = 0;
147my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700148my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700149my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800150for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800151 ## no critic
152 eval "\${dbg_$key} = '$debug{$key}';";
153 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800154}
155
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700156my $rpt_cleaners = 0;
157
Andy Whitcroft8905a672007-11-28 16:21:06 -0800158if ($terse) {
159 $emacs = 1;
160 $quiet++;
161}
162
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700163if ($tree) {
164 if (defined $root) {
165 if (!top_of_kernel_tree($root)) {
166 die "$P: $root: --root does not point at a valid tree\n";
167 }
168 } else {
169 if (top_of_kernel_tree('.')) {
170 $root = '.';
171 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
172 top_of_kernel_tree($1)) {
173 $root = $1;
174 }
175 }
176
177 if (!defined $root) {
178 print "Must be run from the top-level dir. of a kernel tree\n";
179 exit(2);
180 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700181}
182
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700183my $emitted_corrupt = 0;
184
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700185our $Ident = qr{
186 [A-Za-z_][A-Za-z\d_]*
187 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
188 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700189our $Storage = qr{extern|static|asmlinkage};
190our $Sparse = qr{
191 __user|
192 __kernel|
193 __force|
194 __iomem|
195 __must_check|
196 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800197 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700198 __ref|
199 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800201
202# Notes to $Attribute:
203# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700204our $Attribute = qr{
205 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700206 __percpu|
207 __nocast|
208 __safe|
209 __bitwise__|
210 __packed__|
211 __packed2__|
212 __naked|
213 __maybe_unused|
214 __always_unused|
215 __noreturn|
216 __used|
217 __cold|
218 __noclone|
219 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700220 __read_mostly|
221 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800222 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700223 ____cacheline_aligned|
224 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800225 ____cacheline_internodealigned_in_smp|
226 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700227 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700228our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700229our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700230our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
231our $Lval = qr{$Ident(?:$Member)*};
232
Joe Perches74349bc2012-12-17 16:02:05 -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]?)};
236our $Float = qr{$Float_hex|$Float_dec|$Float_int};
237our $Constant = qr{(?:$Float|(?i:(?:0x[0-9a-f]+|[0-9]+)[ul]*))};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700238our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800239our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700240our $Operators = qr{
241 <=|>=|==|!=|
242 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800243 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700244 }x;
245
Andy Whitcroft8905a672007-11-28 16:21:06 -0800246our $NonptrType;
247our $Type;
248our $Declare;
249
Joe Perches15662b32011-10-31 17:13:12 -0700250our $NON_ASCII_UTF8 = qr{
251 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700252 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
253 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
254 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
255 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
256 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
257 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
258}x;
259
Joe Perches15662b32011-10-31 17:13:12 -0700260our $UTF8 = qr{
261 [\x09\x0A\x0D\x20-\x7E] # ASCII
262 | $NON_ASCII_UTF8
263}x;
264
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700265our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700266 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700267 atomic_t
268)};
269
Joe Perches691e6692010-03-05 13:43:51 -0800270our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700271 printk(?:_ratelimited|_once|)|
272 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
273 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700274 panic|
275 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800276)};
277
Joe Perches20112472011-07-25 17:13:23 -0700278our $signature_tags = qr{(?xi:
279 Signed-off-by:|
280 Acked-by:|
281 Tested-by:|
282 Reviewed-by:|
283 Reported-by:|
284 To:|
285 Cc:
286)};
287
Andy Whitcroft8905a672007-11-28 16:21:06 -0800288our @typeList = (
289 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700290 qr{(?:unsigned\s+)?char},
291 qr{(?:unsigned\s+)?short},
292 qr{(?:unsigned\s+)?int},
293 qr{(?:unsigned\s+)?long},
294 qr{(?:unsigned\s+)?long\s+int},
295 qr{(?:unsigned\s+)?long\s+long},
296 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800297 qr{unsigned},
298 qr{float},
299 qr{double},
300 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800301 qr{struct\s+$Ident},
302 qr{union\s+$Ident},
303 qr{enum\s+$Ident},
304 qr{${Ident}_t},
305 qr{${Ident}_handler},
306 qr{${Ident}_handler_fn},
307);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700308our @modifierList = (
309 qr{fastcall},
310);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311
Wolfram Sang7840a942010-08-09 17:20:57 -0700312our $allowed_asm_includes = qr{(?x:
313 irq|
314 memory
315)};
316# memory.h: ARM has a custom one
317
Andy Whitcroft8905a672007-11-28 16:21:06 -0800318sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700319 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
320 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700321 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800322 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700323 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800324 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800325 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700326 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700327 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800328 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700329 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800330 }x;
331 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700332 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700333 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700334 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800335 }x;
336 $Declare = qr{(?:$Storage\s+)?$Type};
337}
338build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700339
Joe Perches7d2367a2011-07-25 17:13:22 -0700340
341our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700342
343# Using $balanced_parens, $LvalOrFunc, or $FuncArg
344# requires at least perl version v5.10.0
345# Any use must be runtime checked with $^V
346
347our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
348our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800349our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700350
351sub deparenthesize {
352 my ($string) = @_;
353 return "" if (!defined($string));
354 $string =~ s@^\s*\(\s*@@g;
355 $string =~ s@\s*\)\s*$@@g;
356 $string =~ s@\s+@ @g;
357 return $string;
358}
359
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700360$chk_signoff = 0 if ($file);
361
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700362my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800363my @lines = ();
364my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700365for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800366 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700367 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800368 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700369 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800370 } elsif ($filename eq '-') {
371 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700372 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800373 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700374 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700375 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800376 if ($filename eq '-') {
377 $vname = 'Your patch';
378 } else {
379 $vname = $filename;
380 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800381 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700382 chomp;
383 push(@rawlines, $_);
384 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800385 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800386 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700387 $exit = 1;
388 }
389 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800390 @lines = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700391}
392
393exit($exit);
394
395sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700396 my ($root) = @_;
397
398 my @tree_check = (
399 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
400 "README", "Documentation", "arch", "include", "drivers",
401 "fs", "init", "ipc", "kernel", "lib", "scripts",
402 );
403
404 foreach my $check (@tree_check) {
405 if (! -e $root . '/' . $check) {
406 return 0;
407 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700408 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700409 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700410}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700411
Joe Perches20112472011-07-25 17:13:23 -0700412sub parse_email {
413 my ($formatted_email) = @_;
414
415 my $name = "";
416 my $address = "";
417 my $comment = "";
418
419 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
420 $name = $1;
421 $address = $2;
422 $comment = $3 if defined $3;
423 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
424 $address = $1;
425 $comment = $2 if defined $2;
426 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
427 $address = $1;
428 $comment = $2 if defined $2;
429 $formatted_email =~ s/$address.*$//;
430 $name = $formatted_email;
431 $name =~ s/^\s+|\s+$//g;
432 $name =~ s/^\"|\"$//g;
433 # If there's a name left after stripping spaces and
434 # leading quotes, and the address doesn't have both
435 # leading and trailing angle brackets, the address
436 # is invalid. ie:
437 # "joe smith joe@smith.com" bad
438 # "joe smith <joe@smith.com" bad
439 if ($name ne "" && $address !~ /^<[^>]+>$/) {
440 $name = "";
441 $address = "";
442 $comment = "";
443 }
444 }
445
446 $name =~ s/^\s+|\s+$//g;
447 $name =~ s/^\"|\"$//g;
448 $address =~ s/^\s+|\s+$//g;
449 $address =~ s/^\<|\>$//g;
450
451 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
452 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
453 $name = "\"$name\"";
454 }
455
456 return ($name, $address, $comment);
457}
458
459sub format_email {
460 my ($name, $address) = @_;
461
462 my $formatted_email;
463
464 $name =~ s/^\s+|\s+$//g;
465 $name =~ s/^\"|\"$//g;
466 $address =~ s/^\s+|\s+$//g;
467
468 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
469 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
470 $name = "\"$name\"";
471 }
472
473 if ("$name" eq "") {
474 $formatted_email = "$address";
475 } else {
476 $formatted_email = "$name <$address>";
477 }
478
479 return $formatted_email;
480}
481
Joe Perches000d1cc12011-07-25 17:13:25 -0700482sub which_conf {
483 my ($conf) = @_;
484
485 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
486 if (-e "$path/$conf") {
487 return "$path/$conf";
488 }
489 }
490
491 return "";
492}
493
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700494sub expand_tabs {
495 my ($str) = @_;
496
497 my $res = '';
498 my $n = 0;
499 for my $c (split(//, $str)) {
500 if ($c eq "\t") {
501 $res .= ' ';
502 $n++;
503 for (; ($n % 8) != 0; $n++) {
504 $res .= ' ';
505 }
506 next;
507 }
508 $res .= $c;
509 $n++;
510 }
511
512 return $res;
513}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700514sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700515 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700516 return $res;
517}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700518
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700519sub line_stats {
520 my ($line) = @_;
521
522 # Drop the diff line leader and expand tabs
523 $line =~ s/^.//;
524 $line = expand_tabs($line);
525
526 # Pick the indent from the front of the line.
527 my ($white) = ($line =~ /^(\s*)/);
528
529 return (length($line), length($white));
530}
531
Andy Whitcroft773647a2008-03-28 14:15:58 -0700532my $sanitise_quote = '';
533
534sub sanitise_line_reset {
535 my ($in_comment) = @_;
536
537 if ($in_comment) {
538 $sanitise_quote = '*/';
539 } else {
540 $sanitise_quote = '';
541 }
542}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700543sub sanitise_line {
544 my ($line) = @_;
545
546 my $res = '';
547 my $l = '';
548
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800549 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700550 my $off = 0;
551 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700552
Andy Whitcroft773647a2008-03-28 14:15:58 -0700553 # Always copy over the diff marker.
554 $res = substr($line, 0, 1);
555
556 for ($off = 1; $off < length($line); $off++) {
557 $c = substr($line, $off, 1);
558
559 # Comments we are wacking completly including the begin
560 # and end, all to $;.
561 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
562 $sanitise_quote = '*/';
563
564 substr($res, $off, 2, "$;$;");
565 $off++;
566 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800567 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700568 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700569 $sanitise_quote = '';
570 substr($res, $off, 2, "$;$;");
571 $off++;
572 next;
573 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700574 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
575 $sanitise_quote = '//';
576
577 substr($res, $off, 2, $sanitise_quote);
578 $off++;
579 next;
580 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700581
582 # A \ in a string means ignore the next character.
583 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
584 $c eq "\\") {
585 substr($res, $off, 2, 'XX');
586 $off++;
587 next;
588 }
589 # Regular quotes.
590 if ($c eq "'" || $c eq '"') {
591 if ($sanitise_quote eq '') {
592 $sanitise_quote = $c;
593
594 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700595 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700596 } elsif ($sanitise_quote eq $c) {
597 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700598 }
599 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700600
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800601 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700602 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
603 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700604 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
605 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700606 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
607 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700608 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700609 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700610 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800611 }
612
Daniel Walker113f04a2009-09-21 17:04:35 -0700613 if ($sanitise_quote eq '//') {
614 $sanitise_quote = '';
615 }
616
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800617 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700618 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800619 my $clean = 'X' x length($1);
620 $res =~ s@\<.*\>@<$clean>@;
621
622 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700623 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800624 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700625 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800626 }
627
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700628 return $res;
629}
630
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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700974sub cat_vet {
975 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700976 my ($res, $coded);
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700987
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700988 return $res;
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -07001354sub process {
1355 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001356
1357 my $linenr=0;
1358 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001359 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001360 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001361 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001362
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001363 my $length;
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -07001390 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001391 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-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
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001401 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001402 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001403 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001404 my @setup_docs = ();
1405 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001406
1407 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001408 my $line;
1409 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001410 $linenr++;
1411 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001412
Andy Whitcroft773647a2008-03-28 14:15:58 -07001413 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001414 $setup_docs = 0;
1415 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1416 $setup_docs = 1;
1417 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001418 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001419 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001420 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1421 $realline=$1-1;
1422 if (defined $2) {
1423 $realcnt=$3+1;
1424 } else {
1425 $realcnt=1+1;
1426 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001427 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001428
1429 # Guestimate if this is a continuing comment. Run
1430 # the context looking for a comment "edge". If this
1431 # edge is a close comment then we must be in a comment
1432 # at context start.
1433 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001434 my $cnt = $realcnt;
1435 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1436 next if (defined $rawlines[$ln - 1] &&
1437 $rawlines[$ln - 1] =~ /^-/);
1438 $cnt--;
1439 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001440 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001441 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1442 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1443 ($edge) = $1;
1444 last;
1445 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001446 }
1447 if (defined $edge && $edge eq '*/') {
1448 $in_comment = 1;
1449 }
1450
1451 # Guestimate if this is a continuing comment. If this
1452 # is the start of a diff block and this line starts
1453 # ' *' then it is very likely a comment.
1454 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001455 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001456 {
1457 $in_comment = 1;
1458 }
1459
1460 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1461 sanitise_line_reset($in_comment);
1462
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001463 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001464 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001465 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001466 $line = sanitise_line($rawline);
1467 }
1468 push(@lines, $line);
1469
1470 if ($realcnt > 1) {
1471 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1472 } else {
1473 $realcnt = 0;
1474 }
1475
1476 #print "==>$rawline\n";
1477 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001478
1479 if ($setup_docs && $line =~ /^\+/) {
1480 push(@setup_docs, $line);
1481 }
1482 }
1483
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001484 $prefix = '';
1485
Andy Whitcroft773647a2008-03-28 14:15:58 -07001486 $realcnt = 0;
1487 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001488 foreach my $line (@lines) {
1489 $linenr++;
1490
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001491 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001492
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001493#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001494 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001495 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001496 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001497 $realline=$1-1;
1498 if (defined $2) {
1499 $realcnt=$3+1;
1500 } else {
1501 $realcnt=1+1;
1502 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001503 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001504 $prev_values = 'E';
1505
Andy Whitcroft773647a2008-03-28 14:15:58 -07001506 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001507 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001508 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001509 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001510 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001511
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001512# track the line number as we move through the hunk, note that
1513# new versions of GNU diff omit the leading space on completely
1514# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001515 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001516 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001517 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001518
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001519 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001520 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001521
1522 # Track the previous line.
1523 ($prevline, $stashline) = ($stashline, $line);
1524 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001525 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1526
Andy Whitcroft773647a2008-03-28 14:15:58 -07001527 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001528
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001529 } elsif ($realcnt == 1) {
1530 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001531 }
1532
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001533 my $hunk_line = ($realcnt != 0);
1534
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001535#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001536 $prefix = "$filename:$realline: " if ($emacs && $file);
1537 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1538
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001539 $here = "#$linenr: " if (!$file);
1540 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001541
1542 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001543 if ($line =~ /^diff --git.*?(\S+)$/) {
1544 $realfile = $1;
1545 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001546 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001547 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001548 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001549 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001550 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001551
1552 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001553 if (!$file && $tree && $p1_prefix ne '' &&
1554 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001555 WARN("PATCH_PREFIX",
1556 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001557 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001558
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001559 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001560 ERROR("MODIFIED_INCLUDE_ASM",
1561 "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 -07001562 }
1563 next;
1564 }
1565
Randy Dunlap389834b2007-06-08 13:47:03 -07001566 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001567
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001568 my $hereline = "$here\n$rawline\n";
1569 my $herecurr = "$here\n$rawline\n";
1570 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001571
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001572 $cnt_lines++ if ($realcnt != 0);
1573
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001574# Check for incorrect file permissions
1575 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1576 my $permhere = $here . "FILE: $realfile\n";
1577 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001578 ERROR("EXECUTE_PERMISSIONS",
1579 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001580 }
1581 }
1582
Joe Perches20112472011-07-25 17:13:23 -07001583# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001584 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001585 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001586 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001587 }
1588
1589# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001590 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001591 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001592 my $space_before = $1;
1593 my $sign_off = $2;
1594 my $space_after = $3;
1595 my $email = $4;
1596 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1597
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001598 if ($sign_off !~ /$signature_tags/) {
1599 WARN("BAD_SIGN_OFF",
1600 "Non-standard signature: $sign_off\n" . $herecurr);
1601 }
Joe Perches20112472011-07-25 17:13:23 -07001602 if (defined $space_before && $space_before ne "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001603 WARN("BAD_SIGN_OFF",
1604 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001605 }
Joe Perches20112472011-07-25 17:13:23 -07001606 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001607 WARN("BAD_SIGN_OFF",
1608 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001609 }
1610 if (!defined $space_after || $space_after ne " ") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001611 WARN("BAD_SIGN_OFF",
1612 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001613 }
1614
1615 my ($email_name, $email_address, $comment) = parse_email($email);
1616 my $suggested_email = format_email(($email_name, $email_address));
1617 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001618 ERROR("BAD_SIGN_OFF",
1619 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001620 } else {
1621 my $dequoted = $suggested_email;
1622 $dequoted =~ s/^"//;
1623 $dequoted =~ s/" </ </;
1624 # Don't force email to have quotes
1625 # Allow just an angle bracketed address
1626 if ("$dequoted$comment" ne $email &&
1627 "<$email_address>$comment" ne $email &&
1628 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001629 WARN("BAD_SIGN_OFF",
1630 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001631 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001632 }
1633 }
1634
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001635# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001636 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001637 ERROR("CORRUPTED_PATCH",
1638 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001639 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001640 }
1641
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001642# Check for absolute kernel paths.
1643 if ($tree) {
1644 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1645 my $file = $1;
1646
1647 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1648 check_absolute_file($1, $herecurr)) {
1649 #
1650 } else {
1651 check_absolute_file($file, $herecurr);
1652 }
1653 }
1654 }
1655
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001656# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1657 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001658 $rawline !~ m/^$UTF8*$/) {
1659 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1660
1661 my $blank = copy_spacing($rawline);
1662 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1663 my $hereptr = "$hereline$ptr\n";
1664
Joe Perches34d99212011-07-25 17:13:26 -07001665 CHK("INVALID_UTF8",
1666 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001667 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001668
Joe Perches15662b32011-10-31 17:13:12 -07001669# Check if it's the start of a commit log
1670# (not a header line and we haven't seen the patch filename)
1671 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001672 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001673 $in_header_lines = 0;
1674 $in_commit_log = 1;
1675 }
1676
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001677# Check if there is UTF-8 in a commit log when a mail header has explicitly
1678# declined it, i.e defined some charset where it is missing.
1679 if ($in_header_lines &&
1680 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1681 $1 !~ /utf-8/i) {
1682 $non_utf8_charset = 1;
1683 }
1684
1685 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001686 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001687 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001688 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1689 }
1690
Andy Whitcroft306708542008-10-15 22:02:28 -07001691# ignore non-hunk lines and lines being removed
1692 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001693
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001694#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001695 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001696 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001697 ERROR("DOS_LINE_ENDINGS",
1698 "DOS line endings\n" . $herevet);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001699
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001700 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1701 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001702 ERROR("TRAILING_WHITESPACE",
1703 "trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001704 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001705 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001706
Andi Kleen33549572010-05-24 14:33:29 -07001707# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001708# Only applies when adding the entry originally, after that we do not have
1709# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001710 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001711 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001712 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001713 my $cnt = $realcnt;
1714 my $ln = $linenr + 1;
1715 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001716 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001717 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001718 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001719 $f = $lines[$ln - 1];
1720 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1721 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001722
1723 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001724
1725 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1726 $is_start = 1;
1727 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1728 $length = -1;
1729 }
1730
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001731 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001732 $f =~ s/#.*//;
1733 $f =~ s/^\s+//;
1734 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001735 if ($f =~ /^\s*config\s/) {
1736 $is_end = 1;
1737 last;
1738 }
Andi Kleen33549572010-05-24 14:33:29 -07001739 $length++;
1740 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001741 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001742 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1743 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001744 }
1745
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001746# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1747 if ($realfile =~ /Kconfig/ &&
1748 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1749 WARN("CONFIG_EXPERIMENTAL",
1750 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1751 }
1752
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001753 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1754 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1755 my $flag = $1;
1756 my $replacement = {
1757 'EXTRA_AFLAGS' => 'asflags-y',
1758 'EXTRA_CFLAGS' => 'ccflags-y',
1759 'EXTRA_CPPFLAGS' => 'cppflags-y',
1760 'EXTRA_LDFLAGS' => 'ldflags-y',
1761 };
1762
1763 WARN("DEPRECATED_VARIABLE",
1764 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1765 }
1766
Andy Whitcroft5368df202008-10-15 22:02:27 -07001767# check we are in a valid source file if not then ignore this hunk
1768 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1769
Joe Perches6cd7f382012-12-17 16:01:54 -08001770#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001771 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001772 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001773 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001774 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08001775 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001776 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001777 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08001778 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001779 }
1780
Josh Triplettca56dc02012-03-23 15:02:21 -07001781# Check for user-visible strings broken across lines, which breaks the ability
1782# to grep for the string. Limited to strings used as parameters (those
1783# following an open parenthesis), which almost completely eliminates false
1784# positives, as well as warning only once per parameter rather than once per
1785# line of the string. Make an exception when the previous string ends in a
1786# newline (multiple lines in one string constant) or \n\t (common in inline
1787# assembly to indent the instruction on the following line).
1788 if ($line =~ /^\+\s*"/ &&
1789 $prevline =~ /"\s*$/ &&
1790 $prevline =~ /\(/ &&
1791 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1792 WARN("SPLIT_STRING",
1793 "quoted string split across lines\n" . $hereprev);
1794 }
1795
Joe Perches5e79d962010-03-05 13:43:55 -08001796# check for spaces before a quoted newline
1797 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001798 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1799 "unnecessary whitespace before a quoted newline\n" . $herecurr);
Joe Perches5e79d962010-03-05 13:43:55 -08001800 }
1801
Andy Whitcroft8905a672007-11-28 16:21:06 -08001802# check for adding lines without a newline.
1803 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001804 WARN("MISSING_EOF_NEWLINE",
1805 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001806 }
1807
Mike Frysinger42e41c52009-09-21 17:04:40 -07001808# Blackfin: use hi/lo macros
1809 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1810 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1811 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001812 ERROR("LO_MACRO",
1813 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001814 }
1815 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1816 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001817 ERROR("HI_MACRO",
1818 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001819 }
1820 }
1821
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001822# check we are in a valid source file C or perl if not then ignore this hunk
1823 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001824
1825# at the beginning of a line any tabs must come first and anything
1826# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001827 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1828 $rawline =~ /^\+\s* \s*/) {
1829 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001830 ERROR("CODE_INDENT",
1831 "code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001832 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001833 }
1834
Alberto Panizzo08e44362010-03-05 13:43:54 -08001835# check for space before tabs.
1836 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1837 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001838 WARN("SPACE_BEFORE_TAB",
1839 "please, no space before tabs\n" . $herevet);
Alberto Panizzo08e44362010-03-05 13:43:54 -08001840 }
1841
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001842# check for && or || at the start of a line
1843 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1844 CHK("LOGICAL_CONTINUATIONS",
1845 "Logical continuations should be on the previous line\n" . $hereprev);
1846 }
1847
1848# check multi-line statement indentation matches previous line
1849 if ($^V && $^V ge 5.10.0 &&
1850 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1851 $prevline =~ /^\+(\t*)(.*)$/;
1852 my $oldindent = $1;
1853 my $rest = $2;
1854
1855 my $pos = pos_last_openparen($rest);
1856 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07001857 $line =~ /^(\+| )([ \t]*)/;
1858 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001859
1860 my $goodtabindent = $oldindent .
1861 "\t" x ($pos / 8) .
1862 " " x ($pos % 8);
1863 my $goodspaceindent = $oldindent . " " x $pos;
1864
1865 if ($newindent ne $goodtabindent &&
1866 $newindent ne $goodspaceindent) {
1867 CHK("PARENTHESIS_ALIGNMENT",
1868 "Alignment should match open parenthesis\n" . $hereprev);
1869 }
1870 }
1871 }
1872
Joe Perchesaad4f612012-03-23 15:02:19 -07001873 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1874 CHK("SPACING",
1875 "No space is necessary after a cast\n" . $hereprev);
1876 }
1877
Joe Perches05880602012-10-04 17:13:35 -07001878 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1879 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1880 $prevrawline =~ /^\+[ \t]*$/) {
1881 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1882 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1883 }
1884
1885 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08001886 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1887 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1888 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1889 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07001890 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1891 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1892 }
1893
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001894# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001895# Exceptions:
1896# 1) within comments
1897# 2) indented preprocessor commands
1898# 3) hanging labels
1899 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001900 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001901 WARN("LEADING_SPACE",
1902 "please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001903 }
1904
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001905# check we are in a valid C source file if not then ignore this hunk
1906 next if ($realfile !~ /\.(h|c)$/);
1907
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001908# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1909 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1910 WARN("CONFIG_EXPERIMENTAL",
1911 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1912 }
1913
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001914# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001915 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001916 WARN("CVS_KEYWORD",
1917 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001918 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001919
Mike Frysinger42e41c52009-09-21 17:04:40 -07001920# Blackfin: don't use __builtin_bfin_[cs]sync
1921 if ($line =~ /__builtin_bfin_csync/) {
1922 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001923 ERROR("CSYNC",
1924 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001925 }
1926 if ($line =~ /__builtin_bfin_ssync/) {
1927 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001928 ERROR("SSYNC",
1929 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001930 }
1931
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001932# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001933 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1934 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001935#print "LINE<$line>\n";
1936 if ($linenr >= $suppress_statement &&
1937 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001938 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001939 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001940 $stat =~ s/\n./\n /g;
1941 $cond =~ s/\n./\n /g;
1942
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001943#print "linenr<$linenr> <$stat>\n";
1944 # If this statement has no statement boundaries within
1945 # it there is no point in retrying a statement scan
1946 # until we hit end of it.
1947 my $frag = $stat; $frag =~ s/;+\s*$//;
1948 if ($frag !~ /(?:{|;)/) {
1949#print "skip<$line_nr_next>\n";
1950 $suppress_statement = $line_nr_next;
1951 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001952
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001953 # Find the real next line.
1954 $realline_next = $line_nr_next;
1955 if (defined $realline_next &&
1956 (!defined $lines[$realline_next - 1] ||
1957 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1958 $realline_next++;
1959 }
1960
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001961 my $s = $stat;
1962 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001963
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001964 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001965 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001966
1967 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001968 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001969
Andy Whitcroft463f2862009-09-21 17:04:34 -07001970 } elsif ($s =~ /^.\s*else\b/s) {
1971
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001972 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001973 } 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 -07001974 my $type = $1;
1975 $type =~ s/\s+/ /g;
1976 possible($type, "A:" . $s);
1977
Andy Whitcroft8905a672007-11-28 16:21:06 -08001978 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001979 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001980 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001981 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001982
1983 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001984 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001985 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001986 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001987
1988 # Check for any sort of function declaration.
1989 # int foo(something bar, other baz);
1990 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001991 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 -08001992 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001993
Andy Whitcroftcf655042008-03-04 14:28:20 -08001994 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001995 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001996 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001997
Andy Whitcroft8905a672007-11-28 16:21:06 -08001998 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001999 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002000
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002001 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002002 }
2003 }
2004 }
2005
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002006 }
2007
Andy Whitcroft653d4872007-06-23 17:16:34 -07002008#
2009# Checks which may be anchored in the context.
2010#
2011
2012# Check for switch () and associated case and default
2013# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002014 if ($line=~/\bswitch\s*\(.*\)/) {
2015 my $err = '';
2016 my $sep = '';
2017 my @ctx = ctx_block_outer($linenr, $realcnt);
2018 shift(@ctx);
2019 for my $ctx (@ctx) {
2020 my ($clen, $cindent) = line_stats($ctx);
2021 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2022 $indent != $cindent) {
2023 $err .= "$sep$ctx\n";
2024 $sep = '';
2025 } else {
2026 $sep = "[...]\n";
2027 }
2028 }
2029 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002030 ERROR("SWITCH_CASE_INDENT_LEVEL",
2031 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002032 }
2033 }
2034
2035# if/while/etc brace do not go on next line, unless defining a do while loop,
2036# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002037 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002038 my $pre_ctx = "$1$2";
2039
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002040 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002041
2042 if ($line =~ /^\+\t{6,}/) {
2043 WARN("DEEP_INDENTATION",
2044 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2045 }
2046
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002047 my $ctx_cnt = $realcnt - $#ctx - 1;
2048 my $ctx = join("\n", @ctx);
2049
Andy Whitcroft548596d2008-07-23 21:29:01 -07002050 my $ctx_ln = $linenr;
2051 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002052
Andy Whitcroft548596d2008-07-23 21:29:01 -07002053 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2054 defined $lines[$ctx_ln - 1] &&
2055 $lines[$ctx_ln - 1] =~ /^-/)) {
2056 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2057 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002058 $ctx_ln++;
2059 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002060
Andy Whitcroft53210162008-07-23 21:29:03 -07002061 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2062 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002063
2064 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002065 ERROR("OPEN_BRACE",
2066 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002067 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002068 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002069 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2070 $ctx =~ /\)\s*\;\s*$/ &&
2071 defined $lines[$ctx_ln - 1])
2072 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002073 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2074 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002075 WARN("TRAILING_SEMICOLON",
2076 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002077 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002078 }
2079 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002080 }
2081
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002082# Check relative indent for conditionals and blocks.
2083 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002084 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2085 ctx_statement_block($linenr, $realcnt, 0)
2086 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002087 my ($s, $c) = ($stat, $cond);
2088
2089 substr($s, 0, length($c), '');
2090
2091 # Make sure we remove the line prefixes as we have
2092 # none on the first line, and are going to readd them
2093 # where necessary.
2094 $s =~ s/\n./\n/gs;
2095
2096 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002097 my @newlines = ($c =~ /\n/gs);
2098 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002099
2100 # We want to check the first line inside the block
2101 # starting at the end of the conditional, so remove:
2102 # 1) any blank line termination
2103 # 2) any opening brace { on end of the line
2104 # 3) any do (...) {
2105 my $continuation = 0;
2106 my $check = 0;
2107 $s =~ s/^.*\bdo\b//;
2108 $s =~ s/^\s*{//;
2109 if ($s =~ s/^\s*\\//) {
2110 $continuation = 1;
2111 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002112 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002113 $check = 1;
2114 $cond_lines++;
2115 }
2116
2117 # Also ignore a loop construct at the end of a
2118 # preprocessor statement.
2119 if (($prevline =~ /^.\s*#\s*define\s/ ||
2120 $prevline =~ /\\\s*$/) && $continuation == 0) {
2121 $check = 0;
2122 }
2123
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002124 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002125 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002126 while ($cond_ptr != $cond_lines) {
2127 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002128
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002129 # If we see an #else/#elif then the code
2130 # is not linear.
2131 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2132 $check = 0;
2133 }
2134
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002135 # Ignore:
2136 # 1) blank lines, they should be at 0,
2137 # 2) preprocessor lines, and
2138 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002139 if ($continuation ||
2140 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002141 $s =~ /^\s*#\s*?/ ||
2142 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002143 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002144 if ($s =~ s/^.*?\n//) {
2145 $cond_lines++;
2146 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002147 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002148 }
2149
2150 my (undef, $sindent) = line_stats("+" . $s);
2151 my $stat_real = raw_line($linenr, $cond_lines);
2152
2153 # Check if either of these lines are modified, else
2154 # this is not this patch's fault.
2155 if (!defined($stat_real) ||
2156 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2157 $check = 0;
2158 }
2159 if (defined($stat_real) && $cond_lines > 1) {
2160 $stat_real = "[...]\n$stat_real";
2161 }
2162
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002163 #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 -07002164
2165 if ($check && (($sindent % 8) != 0 ||
2166 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002167 WARN("SUSPECT_CODE_INDENT",
2168 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002169 }
2170 }
2171
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002172 # Track the 'values' across context and added lines.
2173 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002174 my ($curr_values, $curr_vars) =
2175 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002176 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002177 if ($dbg_values) {
2178 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002179 print "$linenr > .$outline\n";
2180 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002181 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002182 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002183 $prev_values = substr($curr_values, -1);
2184
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002185#ignore lines not being added
2186 if ($line=~/^[^\+]/) {next;}
2187
Andy Whitcroft653d4872007-06-23 17:16:34 -07002188# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002189 if ($dbg_type) {
2190 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002191 ERROR("TEST_TYPE",
2192 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002193 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002194 ERROR("TEST_NOT_TYPE",
2195 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002196 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002197 next;
2198 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002199# TEST: allow direct testing of the attribute matcher.
2200 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002201 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002202 ERROR("TEST_ATTR",
2203 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002204 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002205 ERROR("TEST_NOT_ATTR",
2206 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002207 }
2208 next;
2209 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002210
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002211# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002212 if ($line =~ /^.\s*{/ &&
2213 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002214 ERROR("OPEN_BRACE",
2215 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002216 }
2217
Andy Whitcroft653d4872007-06-23 17:16:34 -07002218#
2219# Checks which are anchored on the added line.
2220#
2221
2222# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002223 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002224 my $path = $1;
2225 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002226 ERROR("MALFORMED_INCLUDE",
2227 "malformed #include filename\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002228 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002229 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002230 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002231
2232# no C99 // comments
2233 if ($line =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002234 ERROR("C99_COMMENTS",
2235 "do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002236 }
2237 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002238 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002239 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002240
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002241# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2242# the whole statement.
2243#print "APW <$lines[$realline_next - 1]>\n";
2244 if (defined $realline_next &&
2245 exists $lines[$realline_next - 1] &&
2246 !defined $suppress_export{$realline_next} &&
2247 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2248 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002249 # Handle definitions which produce identifiers with
2250 # a prefix:
2251 # XXX(foo);
2252 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002253 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002254 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002255 $name =~ /^${Ident}_$2/) {
2256#print "FOO C name<$name>\n";
2257 $suppress_export{$realline_next} = 1;
2258
2259 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002260 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002261 ^.DEFINE_$Ident\(\Q$name\E\)|
2262 ^.DECLARE_$Ident\(\Q$name\E\)|
2263 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002264 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2265 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002266 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002267#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2268 $suppress_export{$realline_next} = 2;
2269 } else {
2270 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002271 }
2272 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002273 if (!defined $suppress_export{$linenr} &&
2274 $prevline =~ /^.\s*$/ &&
2275 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2276 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2277#print "FOO B <$lines[$linenr - 1]>\n";
2278 $suppress_export{$linenr} = 2;
2279 }
2280 if (defined $suppress_export{$linenr} &&
2281 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002282 WARN("EXPORT_SYMBOL",
2283 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002284 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002285
Joe Eloff5150bda2010-08-09 17:21:00 -07002286# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002287 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002288 ERROR("GLOBAL_INITIALISERS",
2289 "do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002290 $herecurr);
2291 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002292# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08002293 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002294 ERROR("INITIALISED_STATIC",
2295 "do not initialise statics to 0 or NULL\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002296 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002297 }
2298
Joe Perchescb710ec2010-10-26 14:23:20 -07002299# check for static const char * arrays.
2300 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002301 WARN("STATIC_CONST_CHAR_ARRAY",
2302 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002303 $herecurr);
2304 }
2305
2306# check for static char foo[] = "bar" declarations.
2307 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002308 WARN("STATIC_CONST_CHAR_ARRAY",
2309 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002310 $herecurr);
2311 }
2312
Joe Perches93ed0e22010-10-26 14:23:21 -07002313# check for declarations of struct pci_device_id
2314 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002315 WARN("DEFINE_PCI_DEVICE_TABLE",
2316 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002317 }
2318
Andy Whitcroft653d4872007-06-23 17:16:34 -07002319# check for new typedefs, only function parameters and sparse annotations
2320# make sense.
2321 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002322 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002323 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002324 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002325 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002326 WARN("NEW_TYPEDEFS",
2327 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002328 }
2329
2330# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002331 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002332 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2333 #print "AA<$1>\n";
2334 my ($from, $to) = ($2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002335
Andy Whitcroft65863862009-01-06 14:41:21 -08002336 # Should start with a space.
2337 $to =~ s/^(\S)/ $1/;
2338 # Should not end with a space.
2339 $to =~ s/\s+$//;
2340 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002341 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002342 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002343
Andy Whitcroft65863862009-01-06 14:41:21 -08002344 #print "from<$from> to<$to>\n";
2345 if ($from ne $to) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002346 ERROR("POINTER_LOCATION",
2347 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002348 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002349 }
2350 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2351 #print "BB<$1>\n";
2352 my ($from, $to, $ident) = ($2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002353
Andy Whitcroft65863862009-01-06 14:41:21 -08002354 # Should start with a space.
2355 $to =~ s/^(\S)/ $1/;
2356 # Should not end with a space.
2357 $to =~ s/\s+$//;
2358 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002359 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002360 }
2361 # Modifiers should have spaces.
2362 $to =~ s/(\b$Modifier$)/$1 /;
2363
Andy Whitcroft667026e2009-02-27 14:03:08 -08002364 #print "from<$from> to<$to> ident<$ident>\n";
2365 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002366 ERROR("POINTER_LOCATION",
2367 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
Andy Whitcroft65863862009-01-06 14:41:21 -08002368 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002369 }
2370
2371# # no BUG() or BUG_ON()
2372# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2373# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2374# print "$herecurr";
2375# $clean = 0;
2376# }
2377
Andy Whitcroft8905a672007-11-28 16:21:06 -08002378 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002379 WARN("LINUX_VERSION_CODE",
2380 "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 -08002381 }
2382
Joe Perches17441222011-06-15 15:08:17 -07002383# check for uses of printk_ratelimit
2384 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002385 WARN("PRINTK_RATELIMITED",
2386"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002387 }
2388
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002389# printk should use KERN_* levels. Note that follow on printk's on the
2390# same line do not need a level, so we use the current block context
2391# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002392# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002393# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002394 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002395 my $ok = 0;
2396 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2397 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002398 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002399 # with "\n" ignore it, else it is to blame
2400 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2401 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2402 $ok = 1;
2403 }
2404 last;
2405 }
2406 }
2407 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002408 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2409 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002410 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002411 }
2412
Joe Perches243f3802012-05-31 16:26:09 -07002413 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2414 my $orig = $1;
2415 my $level = lc($orig);
2416 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002417 my $level2 = $level;
2418 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002419 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002420 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002421 }
2422
2423 if ($line =~ /\bpr_warning\s*\(/) {
2424 WARN("PREFER_PR_LEVEL",
2425 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2426 }
2427
Andy Whitcroft653d4872007-06-23 17:16:34 -07002428# function brace can't be on same line, except for #defines of do while,
2429# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002430 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2431 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002432 ERROR("OPEN_BRACE",
2433 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002434 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002435
Andy Whitcroft8905a672007-11-28 16:21:06 -08002436# open braces for enum, union and struct go on the same line.
2437 if ($line =~ /^.\s*{/ &&
2438 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002439 ERROR("OPEN_BRACE",
2440 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002441 }
2442
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002443# missing space after union, struct or enum definition
2444 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002445 WARN("SPACING",
2446 "missing space after $1 definition\n" . $herecurr);
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002447 }
2448
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002449# check for spacing round square brackets; allowed:
2450# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002451# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2452# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002453 while ($line =~ /(.*?\s)\[/g) {
2454 my ($where, $prefix) = ($-[1], $1);
2455 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002456 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002457 $prefix !~ /[{,]\s+$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002458 ERROR("BRACKET_SPACE",
2459 "space prohibited before open square bracket '['\n" . $herecurr);
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002460 }
2461 }
2462
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002463# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002464 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002465 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002466 my $ctx_before = substr($line, 0, $-[1]);
2467 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002468
2469 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002470 if ($name =~ /^(?:
2471 if|for|while|switch|return|case|
2472 volatile|__volatile__|
2473 __attribute__|format|__extension__|
2474 asm|__asm__)$/x)
2475 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002476
2477 # cpp #define statements have non-optional spaces, ie
2478 # if there is a space between the name and the open
2479 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002480 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002481
2482 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002483 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002484
2485 # If this whole things ends with a type its most
2486 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002487 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002488
2489 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002490 WARN("SPACING",
2491 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002492 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002493 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002494
2495# check for whitespace before a non-naked semicolon
2496 if ($line =~ /^\+.*\S\s+;/) {
2497 CHK("SPACING",
2498 "space prohibited before semicolon\n" . $herecurr);
2499 }
2500
Andy Whitcroft653d4872007-06-23 17:16:34 -07002501# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002502 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002503 my $ops = qr{
2504 <<=|>>=|<=|>=|==|!=|
2505 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2506 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002507 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2508 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002509 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002510 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002511 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002512
2513 my $blank = copy_spacing($opline);
2514
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002515 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002516 $off += length($elements[$n]);
2517
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002518 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002519 my $ca = substr($opline, 0, $off);
2520 my $cc = '';
2521 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2522 $cc = substr($opline, $off + length($elements[$n + 1]));
2523 }
2524 my $cb = "$ca$;$cc";
2525
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002526 my $a = '';
2527 $a = 'V' if ($elements[$n] ne '');
2528 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002529 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002530 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2531 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002532 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002533
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002534 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002535
2536 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002537 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002538 $c = 'V' if ($elements[$n + 2] ne '');
2539 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002540 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002541 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2542 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002543 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002544 } else {
2545 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002546 }
2547
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002548 my $ctx = "${a}x${c}";
2549
2550 my $at = "(ctx:$ctx)";
2551
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002552 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002553 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002554
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002555 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002556 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002557
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002558 # Get the full operator variant.
2559 my $opv = $op . substr($curr_vars, $off, 1);
2560
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002561 # Ignore operators passed as parameters.
2562 if ($op_type ne 'V' &&
2563 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2564
Andy Whitcroftcf655042008-03-04 14:28:20 -08002565# # Ignore comments
2566# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002567
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002568 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002569 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002570 if ($ctx !~ /.x[WEBC]/ &&
2571 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002572 ERROR("SPACING",
2573 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002574 }
2575
2576 # // is a comment
2577 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002578
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002579 # No spaces for:
2580 # ->
2581 # : when part of a bitfield
2582 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002583 if ($ctx =~ /Wx.|.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002584 ERROR("SPACING",
2585 "spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002586 }
2587
2588 # , must have a space on the right.
2589 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002590 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002591 ERROR("SPACING",
2592 "space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002593 }
2594
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002595 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002596 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002597 #warn "'*' is part of type\n";
2598
2599 # unary operators should have a space before and
2600 # none after. May be left adjacent to another
2601 # unary operator, or a cast
2602 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002603 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002604 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002605 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002606 ERROR("SPACING",
2607 "space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002608 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002609 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002610 # A unary '*' may be const
2611
2612 } elsif ($ctx =~ /.xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002613 ERROR("SPACING",
2614 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002615 }
2616
2617 # unary ++ and unary -- are allowed no space on one side.
2618 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002619 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002620 ERROR("SPACING",
2621 "space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002622 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002623 if ($ctx =~ /Wx[BE]/ ||
2624 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002625 ERROR("SPACING",
2626 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002627 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002628 if ($ctx =~ /ExW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002629 ERROR("SPACING",
2630 "space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002631 }
2632
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002633
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002634 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002635 } elsif ($op eq '<<' or $op eq '>>' or
2636 $op eq '&' or $op eq '^' or $op eq '|' or
2637 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002638 $op eq '*' or $op eq '/' or
2639 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002640 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002641 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002642 ERROR("SPACING",
2643 "need consistent spacing around '$op' $at\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002644 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002645 }
2646
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002647 # A colon needs no spaces before when it is
2648 # terminating a case value or a label.
2649 } elsif ($opv eq ':C' || $opv eq ':L') {
2650 if ($ctx =~ /Wx./) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002651 ERROR("SPACING",
2652 "space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002653 }
2654
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002655 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002656 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002657 my $ok = 0;
2658
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002659 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002660 if (($op eq '<' &&
2661 $cc =~ /^\S+\@\S+>/) ||
2662 ($op eq '>' &&
2663 $ca =~ /<\S+\@\S+$/))
2664 {
2665 $ok = 1;
2666 }
2667
2668 # Ignore ?:
2669 if (($opv eq ':O' && $ca =~ /\?$/) ||
2670 ($op eq '?' && $cc =~ /^:/)) {
2671 $ok = 1;
2672 }
2673
2674 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002675 ERROR("SPACING",
2676 "spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002677 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002678 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002679 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002680 }
2681 }
2682
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002683# check for multiple assignments
2684 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002685 CHK("MULTIPLE_ASSIGNMENTS",
2686 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002687 }
2688
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002689## # check for multiple declarations, allowing for a function declaration
2690## # continuation.
2691## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2692## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2693##
2694## # Remove any bracketed sections to ensure we do not
2695## # falsly report the parameters of functions.
2696## my $ln = $line;
2697## while ($ln =~ s/\([^\(\)]*\)//g) {
2698## }
2699## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002700## WARN("MULTIPLE_DECLARATION",
2701## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002702## }
2703## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002704
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002705#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002706 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2707 $line =~ /do{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002708 ERROR("SPACING",
2709 "space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002710 }
2711
2712# closing brace should have a space following it when it has anything
2713# on the line
2714 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002715 ERROR("SPACING",
2716 "space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002717 }
2718
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002719# check spacing on square brackets
2720 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002721 ERROR("SPACING",
2722 "space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002723 }
2724 if ($line =~ /\s\]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002725 ERROR("SPACING",
2726 "space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002727 }
2728
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002729# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002730 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2731 $line !~ /for\s*\(\s+;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002732 ERROR("SPACING",
2733 "space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002734 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002735 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002736 $line !~ /for\s*\(.*;\s+\)/ &&
2737 $line !~ /:\s+\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002738 ERROR("SPACING",
2739 "space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002740 }
2741
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002742#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002743 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002744 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002745 WARN("INDENTED_LABEL",
2746 "labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002747 }
2748
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002749# Return is not a function.
2750 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2751 my $spacing = $1;
2752 my $value = $2;
2753
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002754 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002755 $value =~ s/\(/ \(/g;
2756 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08002757 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002758 $value !~ /(?:$Ident|-?$Constant)\s*
2759 $Compare\s*
2760 (?:$Ident|-?$Constant)/x &&
2761 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002762 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002763#print "value<$value>\n";
2764 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002765 ERROR("RETURN_PARENTHESES",
2766 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002767
2768 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002769 ERROR("SPACING",
2770 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002771 }
2772 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002773# Return of what appears to be an errno should normally be -'ve
2774 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2775 my $name = $1;
2776 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002777 WARN("USE_NEGATIVE_ERRNO",
2778 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002779 }
2780 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002781
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002782# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002783 if ($line=~/\b(if|while|for|switch)\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002784 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002785 }
2786
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002787# Check for illegal assignment in if conditional -- and check for trailing
2788# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002789 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002790 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2791 ctx_statement_block($linenr, $realcnt, 0)
2792 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002793 my ($stat_next) = ctx_statement_block($line_nr_next,
2794 $remain_next, $off_next);
2795 $stat_next =~ s/\n./\n /g;
2796 ##print "stat<$stat> stat_next<$stat_next>\n";
2797
2798 if ($stat_next =~ /^\s*while\b/) {
2799 # If the statement carries leading newlines,
2800 # then count those as offsets.
2801 my ($whitespace) =
2802 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2803 my $offset =
2804 statement_rawlines($whitespace) - 1;
2805
2806 $suppress_whiletrailers{$line_nr_next +
2807 $offset} = 1;
2808 }
2809 }
2810 if (!defined $suppress_whiletrailers{$linenr} &&
2811 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002812 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002813
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002814 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002815 ERROR("ASSIGN_IN_IF",
2816 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002817 }
2818
2819 # Find out what is on the end of the line after the
2820 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002821 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002822 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002823 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002824 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2825 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002826 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002827 # Find out how long the conditional actually is.
2828 my @newlines = ($c =~ /\n/gs);
2829 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002830 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002831
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002832 $stat_real = raw_line($linenr, $cond_lines)
2833 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002834 if (defined($stat_real) && $cond_lines > 1) {
2835 $stat_real = "[...]\n$stat_real";
2836 }
2837
Joe Perches000d1cc12011-07-25 17:13:25 -07002838 ERROR("TRAILING_STATEMENTS",
2839 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002840 }
2841 }
2842
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002843# Check for bitwise tests written as boolean
2844 if ($line =~ /
2845 (?:
2846 (?:\[|\(|\&\&|\|\|)
2847 \s*0[xX][0-9]+\s*
2848 (?:\&\&|\|\|)
2849 |
2850 (?:\&\&|\|\|)
2851 \s*0[xX][0-9]+\s*
2852 (?:\&\&|\|\||\)|\])
2853 )/x)
2854 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002855 WARN("HEXADECIMAL_BOOLEAN_TEST",
2856 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002857 }
2858
Andy Whitcroft8905a672007-11-28 16:21:06 -08002859# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002860 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2861 my $s = $1;
2862 $s =~ s/$;//g; # Remove any comments
2863 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002864 ERROR("TRAILING_STATEMENTS",
2865 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002866 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002867 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002868# if should not continue a brace
2869 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002870 ERROR("TRAILING_STATEMENTS",
2871 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08002872 $herecurr);
2873 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002874# case and default should not have general statements after them
2875 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2876 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002877 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002878 \s*return\s+
2879 )/xg)
2880 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002881 ERROR("TRAILING_STATEMENTS",
2882 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002883 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002884
2885 # Check for }<nl>else {, these must be at the same
2886 # indent level to be relevant to each other.
2887 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2888 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002889 ERROR("ELSE_AFTER_BRACE",
2890 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002891 }
2892
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002893 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2894 $previndent == $indent) {
2895 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2896
2897 # Find out what is on the end of the line after the
2898 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002899 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002900 $s =~ s/\n.*//g;
2901
2902 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002903 ERROR("WHILE_AFTER_BRACE",
2904 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002905 }
2906 }
2907
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002908#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2909# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2910# print "No studly caps, use _\n";
2911# print "$herecurr";
2912# $clean = 0;
2913# }
2914
2915#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002916 if ($line=~/\#\s*define.*\\\s$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002917 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2918 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002919 }
2920
Andy Whitcroft653d4872007-06-23 17:16:34 -07002921#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002922 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002923 my $file = "$1.h";
2924 my $checkfile = "include/linux/$file";
2925 if (-f "$root/$checkfile" &&
2926 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002927 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002928 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002929 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002930 CHK("ARCH_INCLUDE_LINUX",
2931 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002932 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07002933 WARN("INCLUDE_LINUX",
2934 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002935 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002936 }
2937 }
2938
Andy Whitcroft653d4872007-06-23 17:16:34 -07002939# multi-statement macros should be enclosed in a do while loop, grab the
2940# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002941# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002942 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2943 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002944 my $ln = $linenr;
2945 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002946 my ($off, $dstat, $dcond, $rest);
2947 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002948 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002949 ctx_statement_block($linenr, $realcnt, 0);
2950 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002951 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002952 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002953
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002954 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002955 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002956 $dstat =~ s/\\\n.//g;
2957 $dstat =~ s/^\s*//s;
2958 $dstat =~ s/\s*$//s;
2959
2960 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002961 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2962 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08002963 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002964 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002965 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002966
Andy Whitcrofte45bab82012-03-23 15:02:18 -07002967 # Flatten any obvious string concatentation.
2968 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
2969 $dstat =~ s/$Ident\s*("X*")/$1/)
2970 {
2971 }
2972
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002973 my $exceptions = qr{
2974 $Declare|
2975 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07002976 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002977 DECLARE_PER_CPU|
2978 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002979 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002980 union|
2981 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002982 \.$Ident\s*=\s*|
2983 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002984 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07002985 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002986 if ($dstat ne '' &&
2987 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2988 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Andy Whitcroftfd1b57a2012-03-23 15:02:18 -07002989 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07002990 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002991 $dstat !~ /$exceptions/ &&
2992 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Andy Whitcroft72f115f2012-01-10 15:10:06 -08002993 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002994 $dstat !~ /^for\s*$Constant$/ && # for (...)
2995 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2996 $dstat !~ /^do\s*{/ && # do {...
2997 $dstat !~ /^\({/) # ({...
2998 {
2999 $ctx =~ s/\n*$//;
3000 my $herectx = $here . "\n";
3001 my $cnt = statement_rawlines($ctx);
3002
3003 for (my $n = 0; $n < $cnt; $n++) {
3004 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003005 }
3006
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003007 if ($dstat =~ /;/) {
3008 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3009 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3010 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003011 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003012 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003013 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003014 }
Joe Perches5023d342012-12-17 16:01:47 -08003015
Joe Perches481eb482012-12-17 16:01:56 -08003016# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003017
3018 } else {
3019 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003020 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3021 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003022 $line =~ /^\+.*\\$/) {
3023 WARN("LINE_CONTINUATIONS",
3024 "Avoid unnecessary line continuations\n" . $herecurr);
3025 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003026 }
3027
Joe Perchesb13edf72012-07-30 14:41:24 -07003028# do {} while (0) macro tests:
3029# single-statement macros do not need to be enclosed in do while (0) loop,
3030# macro should not end with a semicolon
3031 if ($^V && $^V ge 5.10.0 &&
3032 $realfile !~ m@/vmlinux.lds.h$@ &&
3033 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3034 my $ln = $linenr;
3035 my $cnt = $realcnt;
3036 my ($off, $dstat, $dcond, $rest);
3037 my $ctx = '';
3038 ($dstat, $dcond, $ln, $cnt, $off) =
3039 ctx_statement_block($linenr, $realcnt, 0);
3040 $ctx = $dstat;
3041
3042 $dstat =~ s/\\\n.//g;
3043
3044 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3045 my $stmts = $2;
3046 my $semis = $3;
3047
3048 $ctx =~ s/\n*$//;
3049 my $cnt = statement_rawlines($ctx);
3050 my $herectx = $here . "\n";
3051
3052 for (my $n = 0; $n < $cnt; $n++) {
3053 $herectx .= raw_line($linenr, $n) . "\n";
3054 }
3055
Joe Perchesac8e97f2012-08-21 16:15:53 -07003056 if (($stmts =~ tr/;/;/) == 1 &&
3057 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003058 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3059 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3060 }
3061 if (defined $semis && $semis ne "") {
3062 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3063 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3064 }
3065 }
3066 }
3067
Mike Frysinger080ba922009-01-06 14:41:25 -08003068# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3069# all assignments may have only one of the following with an assignment:
3070# .
3071# ALIGN(...)
3072# VMLINUX_SYMBOL(...)
3073 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003074 WARN("MISSING_VMLINUX_SYMBOL",
3075 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003076 }
3077
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003078# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003079 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3080 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003081 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003082 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003083 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3084 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003085 my @allowed = ();
3086 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003087 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003088 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003089 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003090 for my $chunk (@chunks) {
3091 my ($cond, $block) = @{$chunk};
3092
Andy Whitcroft773647a2008-03-28 14:15:58 -07003093 # If the condition carries leading newlines, then count those as offsets.
3094 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3095 my $offset = statement_rawlines($whitespace) - 1;
3096
Joe Perchesaad4f612012-03-23 15:02:19 -07003097 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003098 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3099
3100 # We have looked at and allowed this specific line.
3101 $suppress_ifbraces{$ln + $offset} = 1;
3102
3103 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003104 $ln += statement_rawlines($block) - 1;
3105
Andy Whitcroft773647a2008-03-28 14:15:58 -07003106 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003107
3108 $seen++ if ($block =~ /^\s*{/);
3109
Joe Perchesaad4f612012-03-23 15:02:19 -07003110 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003111 if (statement_lines($cond) > 1) {
3112 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003113 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003114 }
3115 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003116 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003117 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003118 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003119 if (statement_block_size($block) > 1) {
3120 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003121 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003122 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003123 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003124 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003125 if ($seen) {
3126 my $sum_allowed = 0;
3127 foreach (@allowed) {
3128 $sum_allowed += $_;
3129 }
3130 if ($sum_allowed == 0) {
3131 WARN("BRACES",
3132 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3133 } elsif ($sum_allowed != $allow &&
3134 $seen != $allow) {
3135 CHK("BRACES",
3136 "braces {} should be used on all arms of this statement\n" . $herectx);
3137 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003138 }
3139 }
3140 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003141 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003142 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003143 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003144
Andy Whitcroftcf655042008-03-04 14:28:20 -08003145 # Check the pre-context.
3146 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3147 #print "APW: ALLOWED: pre<$1>\n";
3148 $allowed = 1;
3149 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003150
3151 my ($level, $endln, @chunks) =
3152 ctx_statement_full($linenr, $realcnt, $-[0]);
3153
Andy Whitcroftcf655042008-03-04 14:28:20 -08003154 # Check the condition.
3155 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003156 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003157 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003158 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003159 }
3160 if (statement_lines($cond) > 1) {
3161 #print "APW: ALLOWED: cond<$cond>\n";
3162 $allowed = 1;
3163 }
3164 if ($block =~/\b(?:if|for|while)\b/) {
3165 #print "APW: ALLOWED: block<$block>\n";
3166 $allowed = 1;
3167 }
3168 if (statement_block_size($block) > 1) {
3169 #print "APW: ALLOWED: lines block<$block>\n";
3170 $allowed = 1;
3171 }
3172 # Check the post-context.
3173 if (defined $chunks[1]) {
3174 my ($cond, $block) = @{$chunks[1]};
3175 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003176 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003177 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003178 if ($block =~ /^\s*\{/) {
3179 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3180 $allowed = 1;
3181 }
3182 }
3183 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003184 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003185 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003186
Andy Whitcroftf0556632008-10-15 22:02:23 -07003187 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003188 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003189 }
3190
Joe Perches000d1cc12011-07-25 17:13:25 -07003191 WARN("BRACES",
3192 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003193 }
3194 }
3195
Joe Perches0979ae62012-12-17 16:01:59 -08003196# check for unnecessary blank lines around braces
3197 if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) {
3198 CHK("BRACES",
3199 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3200 }
3201 if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3202 CHK("BRACES",
3203 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3204 }
3205
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003206# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003207 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3208 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003209 WARN("VOLATILE",
3210 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003211 }
3212
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003213# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003214 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003215 CHK("REDUNDANT_CODE",
3216 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003217 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003218 }
3219
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003220# check for needless "if (<foo>) fn(<foo>)" uses
3221 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3222 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3223 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3224 WARN('NEEDLESS_IF',
3225 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003226 }
3227 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003228
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003229# prefer usleep_range over udelay
3230 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3231 # ignore udelay's < 10, however
3232 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003233 CHK("USLEEP_RANGE",
3234 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003235 }
3236 }
3237
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003238# warn about unexpectedly long msleep's
3239 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3240 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003241 WARN("MSLEEP",
3242 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003243 }
3244 }
3245
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003246# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003247# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003248# print "#ifdef in C files should be avoided\n";
3249# print "$herecurr";
3250# $clean = 0;
3251# }
3252
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003253# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003254 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003255 ERROR("SPACING",
3256 "exactly one space required after that #$1\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003257 }
3258
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003259# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003260 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3261 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003262 my $which = $1;
3263 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003264 CHK("UNCOMMENTED_DEFINITION",
3265 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003266 }
3267 }
3268# check for memory barriers without a comment.
3269 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3270 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003271 CHK("MEMORY_BARRIER",
3272 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003273 }
3274 }
3275# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003276 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003277 CHK("ARCH_DEFINES",
3278 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003279 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003280
Tobias Klauserd4977c72010-05-24 14:33:30 -07003281# Check that the storage class is at the beginning of a declaration
3282 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003283 WARN("STORAGE_CLASS",
3284 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003285 }
3286
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003287# check the location of the inline attribute, that it is between
3288# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003289 if ($line =~ /\b$Type\s+$Inline\b/ ||
3290 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003291 ERROR("INLINE_LOCATION",
3292 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003293 }
3294
Andy Whitcroft8905a672007-11-28 16:21:06 -08003295# Check for __inline__ and __inline, prefer inline
3296 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003297 WARN("INLINE",
3298 "plain inline is preferred over $1\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003299 }
3300
Joe Perches3d130fd2011-01-12 17:00:00 -08003301# Check for __attribute__ packed, prefer __packed
3302 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003303 WARN("PREFER_PACKED",
3304 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003305 }
3306
Joe Perches39b7e282011-07-25 17:13:24 -07003307# Check for __attribute__ aligned, prefer __aligned
3308 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003309 WARN("PREFER_ALIGNED",
3310 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003311 }
3312
Joe Perches5f14d3b2012-01-10 15:09:52 -08003313# Check for __attribute__ format(printf, prefer __printf
3314 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3315 WARN("PREFER_PRINTF",
3316 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3317 }
3318
Joe Perches6061d942012-03-23 15:02:16 -07003319# Check for __attribute__ format(scanf, prefer __scanf
3320 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3321 WARN("PREFER_SCANF",
3322 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3323 }
3324
Joe Perches8f53a9b2010-03-05 13:43:48 -08003325# check for sizeof(&)
3326 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003327 WARN("SIZEOF_ADDRESS",
3328 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003329 }
3330
Joe Perches66c80b62012-07-30 14:41:22 -07003331# check for sizeof without parenthesis
3332 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3333 WARN("SIZEOF_PARENTHESIS",
3334 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3335 }
3336
Joe Perches428e2fd2011-05-24 17:13:39 -07003337# check for line continuations in quoted strings with odd counts of "
3338 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003339 WARN("LINE_CONTINUATIONS",
3340 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003341 }
3342
Joe Perches88982fe2012-12-17 16:02:00 -08003343# check for struct spinlock declarations
3344 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3345 WARN("USE_SPINLOCK_T",
3346 "struct spinlock should be spinlock_t\n" . $herecurr);
3347 }
3348
Andy Whitcroft554e1652012-01-10 15:09:57 -08003349# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003350 if ($^V && $^V ge 5.10.0 &&
3351 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003352 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003353
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003354 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003355 my $ms_val = $7;
3356 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003357
Andy Whitcroft554e1652012-01-10 15:09:57 -08003358 if ($ms_size =~ /^(0x|)0$/i) {
3359 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003360 "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 -08003361 } elsif ($ms_size =~ /^(0x|)1$/i) {
3362 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003363 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3364 }
3365 }
3366
3367# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003368 if ($^V && $^V ge 5.10.0 &&
3369 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003370 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003371 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003372 my $call = $1;
3373 my $cast1 = deparenthesize($2);
3374 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003375 my $cast2 = deparenthesize($7);
3376 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003377 my $cast;
3378
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003379 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003380 $cast = "$cast1 or $cast2";
3381 } elsif ($cast1 ne "") {
3382 $cast = $cast1;
3383 } else {
3384 $cast = $cast2;
3385 }
3386 WARN("MINMAX",
3387 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003388 }
3389 }
3390
Joe Perches4a273192012-07-30 14:41:20 -07003391# check usleep_range arguments
3392 if ($^V && $^V ge 5.10.0 &&
3393 defined $stat &&
3394 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3395 my $min = $1;
3396 my $max = $7;
3397 if ($min eq $max) {
3398 WARN("USLEEP_RANGE",
3399 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3400 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3401 $min > $max) {
3402 WARN("USLEEP_RANGE",
3403 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3404 }
3405 }
3406
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003407# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003408 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003409 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003410 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003411 my $function_name = $1;
3412 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003413
3414 my $s = $stat;
3415 if (defined $cond) {
3416 substr($s, 0, length($cond), '');
3417 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003418 if ($s =~ /^\s*;/ &&
3419 $function_name ne 'uninitialized_var')
3420 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003421 WARN("AVOID_EXTERNS",
3422 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003423 }
3424
3425 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003426 WARN("FUNCTION_ARGUMENTS",
3427 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003428 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003429
3430 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3431 $stat =~ /^.\s*extern\s+/)
3432 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003433 WARN("AVOID_EXTERNS",
3434 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003435 }
3436
3437# checks for new __setup's
3438 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3439 my $name = $1;
3440
3441 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003442 CHK("UNDOCUMENTED_SETUP",
3443 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003444 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003445 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003446
3447# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003448 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003449 WARN("UNNECESSARY_CASTS",
3450 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003451 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003452
Joe Perchescaf2a542011-01-12 16:59:56 -08003453# check for multiple semicolons
3454 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08003455 WARN("ONE_SEMICOLON",
3456 "Statements terminations use 1 semicolon\n" . $herecurr);
3457 }
3458
3459# check for switch/default statements without a break;
3460 if ($^V && $^V ge 5.10.0 &&
3461 defined $stat &&
3462 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3463 my $ctx = '';
3464 my $herectx = $here . "\n";
3465 my $cnt = statement_rawlines($stat);
3466 for (my $n = 0; $n < $cnt; $n++) {
3467 $herectx .= raw_line($linenr, $n) . "\n";
3468 }
3469 WARN("DEFAULT_NO_BREAK",
3470 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08003471 }
3472
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003473# check for gcc specific __FUNCTION__
3474 if ($line =~ /__FUNCTION__/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003475 WARN("USE_FUNC",
3476 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003477 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003478
Joe Perches2c924882012-03-23 15:02:20 -07003479# check for use of yield()
3480 if ($line =~ /\byield\s*\(\s*\)/) {
3481 WARN("YIELD",
3482 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3483 }
3484
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003485# check for semaphores initialized locked
3486 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003487 WARN("CONSIDER_COMPLETION",
3488 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003489 }
Joe Perches6712d852012-03-23 15:02:20 -07003490
Joe Perches67d0a072011-10-31 17:13:10 -07003491# recommend kstrto* over simple_strto* and strict_strto*
3492 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003493 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003494 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003495 }
Joe Perches6712d852012-03-23 15:02:20 -07003496
Michael Ellermanf3db6632008-07-23 21:28:57 -07003497# check for __initcall(), use device_initcall() explicitly please
3498 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003499 WARN("USE_DEVICE_INITCALL",
3500 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07003501 }
Joe Perches6712d852012-03-23 15:02:20 -07003502
Emese Revfy79404842010-03-05 13:43:53 -08003503# check for various ops structs, ensure they are const.
3504 my $struct_ops = qr{acpi_dock_ops|
3505 address_space_operations|
3506 backlight_ops|
3507 block_device_operations|
3508 dentry_operations|
3509 dev_pm_ops|
3510 dma_map_ops|
3511 extent_io_ops|
3512 file_lock_operations|
3513 file_operations|
3514 hv_ops|
3515 ide_dma_ops|
3516 intel_dvo_dev_ops|
3517 item_operations|
3518 iwl_ops|
3519 kgdb_arch|
3520 kgdb_io|
3521 kset_uevent_ops|
3522 lock_manager_operations|
3523 microcode_ops|
3524 mtrr_ops|
3525 neigh_ops|
3526 nlmsvc_binding|
3527 pci_raw_ops|
3528 pipe_buf_operations|
3529 platform_hibernation_ops|
3530 platform_suspend_ops|
3531 proto_ops|
3532 rpc_pipe_ops|
3533 seq_operations|
3534 snd_ac97_build_ops|
3535 soc_pcmcia_socket_ops|
3536 stacktrace_ops|
3537 sysfs_ops|
3538 tty_operations|
3539 usb_mon_operations|
3540 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003541 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08003542 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003543 WARN("CONST_STRUCT",
3544 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08003545 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08003546 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003547
3548# use of NR_CPUS is usually wrong
3549# ignore definitions of NR_CPUS and usage to define arrays as likely right
3550 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003551 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3552 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003553 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3554 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3555 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003556 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003557 WARN("NR_CPUS",
3558 "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 -07003559 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003560
3561# check for %L{u,d,i} in strings
3562 my $string;
3563 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3564 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07003565 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003566 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003567 WARN("PRINTF_L",
3568 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003569 last;
3570 }
3571 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003572
3573# whine mightly about in_atomic
3574 if ($line =~ /\bin_atomic\s*\(/) {
3575 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003576 ERROR("IN_ATOMIC",
3577 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08003578 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003579 WARN("IN_ATOMIC",
3580 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08003581 }
3582 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01003583
3584# check for lockdep_set_novalidate_class
3585 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3586 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3587 if ($realfile !~ m@^kernel/lockdep@ &&
3588 $realfile !~ m@^include/linux/lockdep@ &&
3589 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003590 ERROR("LOCKDEP",
3591 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003592 }
3593 }
Dave Jones88f88312011-01-12 16:59:59 -08003594
3595 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3596 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003597 WARN("EXPORTED_WORLD_WRITABLE",
3598 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08003599 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003600 }
3601
3602 # If we have no input at all, then there is nothing to report on
3603 # so just keep quiet.
3604 if ($#rawlines == -1) {
3605 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003606 }
3607
Andy Whitcroft8905a672007-11-28 16:21:06 -08003608 # In mailback mode only produce a report in the negative, for
3609 # things that appear to be patches.
3610 if ($mailback && ($clean == 1 || !$is_patch)) {
3611 exit(0);
3612 }
3613
3614 # This is not a patch, and we are are in 'no-patch' mode so
3615 # just keep quiet.
3616 if (!$chk_patch && !$is_patch) {
3617 exit(0);
3618 }
3619
3620 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003621 ERROR("NOT_UNIFIED_DIFF",
3622 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003623 }
3624 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003625 ERROR("MISSING_SIGN_OFF",
3626 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003627 }
3628
Andy Whitcroft8905a672007-11-28 16:21:06 -08003629 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003630 if ($summary && !($clean == 1 && $quiet == 1)) {
3631 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003632 print "total: $cnt_error errors, $cnt_warn warnings, " .
3633 (($check)? "$cnt_chk checks, " : "") .
3634 "$cnt_lines lines checked\n";
3635 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003636 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003637
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003638 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003639
3640 if ($^V lt 5.10.0) {
3641 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3642 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3643 }
3644
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003645 # If there were whitespace errors which cleanpatch can fix
3646 # then suggest that.
3647 if ($rpt_cleaners) {
3648 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3649 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07003650 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003651 }
3652 }
3653
Artem Bityutskiy11232682012-03-23 15:02:17 -07003654 if ($quiet == 0 && keys %ignore_type) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003655 print "NOTE: Ignored message types:";
3656 foreach my $ignore (sort keys %ignore_type) {
3657 print " $ignore";
3658 }
Artem Bityutskiy11232682012-03-23 15:02:17 -07003659 print "\n\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003660 }
3661
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003662 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003663 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003664 }
3665 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003666 print << "EOM";
3667$vname has style problems, please review.
3668
3669If any of these errors are false positives, please report
3670them to the maintainer, see CHECKPATCH in MAINTAINERS.
3671EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003672 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003673
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003674 return $clean;
3675}