blob: c00e5108c0d2571570372a8f9735743976a85a39 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $summary = 1;
28my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080029my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070030my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070031my $fix = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080033my %debug;
Joe Perches000d1cc12011-07-25 17:13:25 -070034my %ignore_type = ();
Joe Perches34456862013-07-03 15:05:34 -070035my %camelcase = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070036my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070037my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070038my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080039my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070040my $ignore_perl_version = 0;
41my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070042
43sub help {
44 my ($exitcode) = @_;
45
46 print << "EOM";
47Usage: $P [OPTION]... [FILE]...
48Version: $V
49
50Options:
51 -q, --quiet quiet
52 --no-tree run without a kernel tree
53 --no-signoff do not check for 'Signed-off-by' line
54 --patch treat FILE as patchfile (default)
55 --emacs emacs compile window format
56 --terse one line per report
57 -f, --file treat FILE as regular source file
58 --subjective, --strict enable more subjective tests
Joe Perches000d1cc12011-07-25 17:13:25 -070059 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080060 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070061 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070062 --root=PATH PATH to the kernel tree root
63 --no-summary suppress the per-file summary
64 --mailback only produce a report in case of warnings/errors
65 --summary-file include the filename in summary
66 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
67 'values', 'possible', 'type', and 'attr' (default
68 is all off)
69 --test-only=WORD report only warnings/errors containing WORD
70 literally
Joe Perches3705ce52013-07-03 15:05:31 -070071 --fix EXPERIMENTAL - may create horrible results
72 If correctable single-line errors exist, create
73 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
74 with potential errors corrected to the preferred
75 checkpatch style
Dave Hansend62a2012013-09-11 14:23:56 -070076 --ignore-perl-version override checking of perl version. expect
77 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070078 -h, --help, --version display this help and exit
79
80When FILE is - read standard input.
81EOM
82
83 exit($exitcode);
84}
85
Joe Perches000d1cc12011-07-25 17:13:25 -070086my $conf = which_conf($configuration_file);
87if (-f $conf) {
88 my @conf_args;
89 open(my $conffile, '<', "$conf")
90 or warn "$P: Can't find a readable $configuration_file file $!\n";
91
92 while (<$conffile>) {
93 my $line = $_;
94
95 $line =~ s/\s*\n?$//g;
96 $line =~ s/^\s*//g;
97 $line =~ s/\s+/ /g;
98
99 next if ($line =~ m/^\s*#/);
100 next if ($line =~ m/^\s*$/);
101
102 my @words = split(" ", $line);
103 foreach my $word (@words) {
104 last if ($word =~ m/^#/);
105 push (@conf_args, $word);
106 }
107 }
108 close($conffile);
109 unshift(@ARGV, @conf_args) if @conf_args;
110}
111
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700112GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700113 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700114 'tree!' => \$tree,
115 'signoff!' => \$chk_signoff,
116 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700117 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800118 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700119 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 'subjective!' => \$check,
121 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700122 'ignore=s' => \@ignore,
123 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800124 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700125 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800126 'summary!' => \$summary,
127 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800128 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700129 'fix!' => \$fix,
Dave Hansend62a2012013-09-11 14:23:56 -0700130 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800131 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700132 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700133 'h|help' => \$help,
134 'version' => \$help
135) or help(1);
136
137help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700138
139my $exit = 0;
140
Dave Hansend62a2012013-09-11 14:23:56 -0700141if ($^V && $^V lt $minimum_perl_version) {
142 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
143 if (!$ignore_perl_version) {
144 exit(1);
145 }
146}
147
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700148if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700149 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700150 exit(1);
151}
152
Joe Perches000d1cc12011-07-25 17:13:25 -0700153@ignore = split(/,/, join(',',@ignore));
154foreach my $word (@ignore) {
155 $word =~ s/\s*\n?$//g;
156 $word =~ s/^\s*//g;
157 $word =~ s/\s+/ /g;
158 $word =~ tr/[a-z]/[A-Z]/;
159
160 next if ($word =~ m/^\s*#/);
161 next if ($word =~ m/^\s*$/);
162
163 $ignore_type{$word}++;
164}
165
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800166my $dbg_values = 0;
167my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700168my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700169my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800170for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800171 ## no critic
172 eval "\${dbg_$key} = '$debug{$key}';";
173 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800174}
175
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700176my $rpt_cleaners = 0;
177
Andy Whitcroft8905a672007-11-28 16:21:06 -0800178if ($terse) {
179 $emacs = 1;
180 $quiet++;
181}
182
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700183if ($tree) {
184 if (defined $root) {
185 if (!top_of_kernel_tree($root)) {
186 die "$P: $root: --root does not point at a valid tree\n";
187 }
188 } else {
189 if (top_of_kernel_tree('.')) {
190 $root = '.';
191 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
192 top_of_kernel_tree($1)) {
193 $root = $1;
194 }
195 }
196
197 if (!defined $root) {
198 print "Must be run from the top-level dir. of a kernel tree\n";
199 exit(2);
200 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700201}
202
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700203my $emitted_corrupt = 0;
204
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700205our $Ident = qr{
206 [A-Za-z_][A-Za-z\d_]*
207 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
208 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700209our $Storage = qr{extern|static|asmlinkage};
210our $Sparse = qr{
211 __user|
212 __kernel|
213 __force|
214 __iomem|
215 __must_check|
216 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800217 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700218 __ref|
219 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700220 }x;
Wolfram Sang52131292c2010-03-05 13:43:51 -0800221
222# Notes to $Attribute:
223# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700224our $Attribute = qr{
225 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700226 __percpu|
227 __nocast|
228 __safe|
229 __bitwise__|
230 __packed__|
231 __packed2__|
232 __naked|
233 __maybe_unused|
234 __always_unused|
235 __noreturn|
236 __used|
237 __cold|
238 __noclone|
239 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700240 __read_mostly|
241 __kprobes|
Wolfram Sang52131292c2010-03-05 13:43:51 -0800242 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700243 ____cacheline_aligned|
244 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800245 ____cacheline_internodealigned_in_smp|
246 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700247 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700248our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700249our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700250our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
251our $Lval = qr{$Ident(?:$Member)*};
252
Joe Perches95e2c602013-07-03 15:05:20 -0700253our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
254our $Binary = qr{(?i)0b[01]+$Int_type?};
255our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
256our $Int = qr{[0-9]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800257our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
258our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
259our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800260our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches95e2c602013-07-03 15:05:20 -0700261our $Constant = qr{$Float|$Binary|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800262our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800263our $Compare = qr{<=|>=|==|!=|<|>};
Joe Perches23f780c2013-07-03 15:05:31 -0700264our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700265our $Operators = qr{
266 <=|>=|==|!=|
267 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700268 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700269 }x;
270
Andy Whitcroft8905a672007-11-28 16:21:06 -0800271our $NonptrType;
272our $Type;
273our $Declare;
274
Joe Perches15662b32011-10-31 17:13:12 -0700275our $NON_ASCII_UTF8 = qr{
276 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700277 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
278 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
279 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
280 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
281 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
282 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
283}x;
284
Joe Perches15662b32011-10-31 17:13:12 -0700285our $UTF8 = qr{
286 [\x09\x0A\x0D\x20-\x7E] # ASCII
287 | $NON_ASCII_UTF8
288}x;
289
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700290our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700291 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700292 atomic_t
293)};
294
Joe Perches691e6692010-03-05 13:43:51 -0800295our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700296 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700297 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700298 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700299 panic|
300 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800301)};
302
Joe Perches20112472011-07-25 17:13:23 -0700303our $signature_tags = qr{(?xi:
304 Signed-off-by:|
305 Acked-by:|
306 Tested-by:|
307 Reviewed-by:|
308 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700309 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700310 To:|
311 Cc:
312)};
313
Andy Whitcroft8905a672007-11-28 16:21:06 -0800314our @typeList = (
315 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700316 qr{(?:unsigned\s+)?char},
317 qr{(?:unsigned\s+)?short},
318 qr{(?:unsigned\s+)?int},
319 qr{(?:unsigned\s+)?long},
320 qr{(?:unsigned\s+)?long\s+int},
321 qr{(?:unsigned\s+)?long\s+long},
322 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800323 qr{unsigned},
324 qr{float},
325 qr{double},
326 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800327 qr{struct\s+$Ident},
328 qr{union\s+$Ident},
329 qr{enum\s+$Ident},
330 qr{${Ident}_t},
331 qr{${Ident}_handler},
332 qr{${Ident}_handler_fn},
333);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700334our @modifierList = (
335 qr{fastcall},
336);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800337
Wolfram Sang7840a942010-08-09 17:20:57 -0700338our $allowed_asm_includes = qr{(?x:
339 irq|
340 memory
341)};
342# memory.h: ARM has a custom one
343
Andy Whitcroft8905a672007-11-28 16:21:06 -0800344sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700345 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
346 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700347 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800348 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700349 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800350 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800351 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700352 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700353 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800354 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700355 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800356 }x;
357 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700358 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700359 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700360 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800361 }x;
362 $Declare = qr{(?:$Storage\s+)?$Type};
363}
364build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700365
Joe Perches7d2367a2011-07-25 17:13:22 -0700366our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700367
368# Using $balanced_parens, $LvalOrFunc, or $FuncArg
369# requires at least perl version v5.10.0
370# Any use must be runtime checked with $^V
371
372our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
373our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800374our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700375
376sub deparenthesize {
377 my ($string) = @_;
378 return "" if (!defined($string));
379 $string =~ s@^\s*\(\s*@@g;
380 $string =~ s@\s*\)\s*$@@g;
381 $string =~ s@\s+@ @g;
382 return $string;
383}
384
Joe Perches34456862013-07-03 15:05:34 -0700385sub seed_camelcase_file {
386 my ($file) = @_;
387
388 return if (!(-f $file));
389
390 local $/;
391
392 open(my $include_file, '<', "$file")
393 or warn "$P: Can't read '$file' $!\n";
394 my $text = <$include_file>;
395 close($include_file);
396
397 my @lines = split('\n', $text);
398
399 foreach my $line (@lines) {
400 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
401 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
402 $camelcase{$1} = 1;
403 }
404 elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*\(/) {
405 $camelcase{$1} = 1;
406 }
407 }
408}
409
410my $camelcase_seeded = 0;
411sub seed_camelcase_includes {
412 return if ($camelcase_seeded);
413
414 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700415 my $camelcase_cache = "";
416 my @include_files = ();
417
418 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700419
Joe Perches34456862013-07-03 15:05:34 -0700420 if (-d ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700421 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
422 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700423 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700424 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700425 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700426 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700427 @include_files = split('\n', $files);
428 foreach my $file (@include_files) {
429 my $date = POSIX::strftime("%Y%m%d%H%M",
430 localtime((stat $file)[9]));
431 $last_mod_date = $date if ($last_mod_date < $date);
432 }
433 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700434 }
Joe Perchesc707a812013-07-08 16:00:43 -0700435
436 if ($camelcase_cache ne "" && -f $camelcase_cache) {
437 open(my $camelcase_file, '<', "$camelcase_cache")
438 or warn "$P: Can't read '$camelcase_cache' $!\n";
439 while (<$camelcase_file>) {
440 chomp;
441 $camelcase{$_} = 1;
442 }
443 close($camelcase_file);
444
445 return;
446 }
447
448 if (-d ".git") {
449 $files = `git ls-files "include/*.h"`;
450 @include_files = split('\n', $files);
451 }
452
Joe Perches34456862013-07-03 15:05:34 -0700453 foreach my $file (@include_files) {
454 seed_camelcase_file($file);
455 }
Joe Perches351b2a12013-07-03 15:05:36 -0700456
Joe Perchesc707a812013-07-08 16:00:43 -0700457 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700458 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700459 open(my $camelcase_file, '>', "$camelcase_cache")
460 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700461 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
462 print $camelcase_file ("$_\n");
463 }
464 close($camelcase_file);
465 }
Joe Perches34456862013-07-03 15:05:34 -0700466}
467
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700468$chk_signoff = 0 if ($file);
469
Andy Whitcroft00df3442007-06-08 13:47:06 -0700470my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800471my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700472my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800473my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700474for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800475 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700476 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800477 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700478 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800479 } elsif ($filename eq '-') {
480 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700481 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800482 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700483 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700484 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800485 if ($filename eq '-') {
486 $vname = 'Your patch';
487 } else {
488 $vname = $filename;
489 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800490 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700491 chomp;
492 push(@rawlines, $_);
493 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800494 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800495 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700496 $exit = 1;
497 }
498 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800499 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700500 @fixed = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700501}
502
503exit($exit);
504
505sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700506 my ($root) = @_;
507
508 my @tree_check = (
509 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
510 "README", "Documentation", "arch", "include", "drivers",
511 "fs", "init", "ipc", "kernel", "lib", "scripts",
512 );
513
514 foreach my $check (@tree_check) {
515 if (! -e $root . '/' . $check) {
516 return 0;
517 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700518 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700519 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700520}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700521
Joe Perches20112472011-07-25 17:13:23 -0700522sub parse_email {
523 my ($formatted_email) = @_;
524
525 my $name = "";
526 my $address = "";
527 my $comment = "";
528
529 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
530 $name = $1;
531 $address = $2;
532 $comment = $3 if defined $3;
533 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
534 $address = $1;
535 $comment = $2 if defined $2;
536 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
537 $address = $1;
538 $comment = $2 if defined $2;
539 $formatted_email =~ s/$address.*$//;
540 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700541 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700542 $name =~ s/^\"|\"$//g;
543 # If there's a name left after stripping spaces and
544 # leading quotes, and the address doesn't have both
545 # leading and trailing angle brackets, the address
546 # is invalid. ie:
547 # "joe smith joe@smith.com" bad
548 # "joe smith <joe@smith.com" bad
549 if ($name ne "" && $address !~ /^<[^>]+>$/) {
550 $name = "";
551 $address = "";
552 $comment = "";
553 }
554 }
555
Joe Perches3705ce52013-07-03 15:05:31 -0700556 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700557 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700558 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700559 $address =~ s/^\<|\>$//g;
560
561 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
562 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
563 $name = "\"$name\"";
564 }
565
566 return ($name, $address, $comment);
567}
568
569sub format_email {
570 my ($name, $address) = @_;
571
572 my $formatted_email;
573
Joe Perches3705ce52013-07-03 15:05:31 -0700574 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700575 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700576 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700577
578 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
579 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
580 $name = "\"$name\"";
581 }
582
583 if ("$name" eq "") {
584 $formatted_email = "$address";
585 } else {
586 $formatted_email = "$name <$address>";
587 }
588
589 return $formatted_email;
590}
591
Joe Perches000d1cc12011-07-25 17:13:25 -0700592sub which_conf {
593 my ($conf) = @_;
594
595 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
596 if (-e "$path/$conf") {
597 return "$path/$conf";
598 }
599 }
600
601 return "";
602}
603
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700604sub expand_tabs {
605 my ($str) = @_;
606
607 my $res = '';
608 my $n = 0;
609 for my $c (split(//, $str)) {
610 if ($c eq "\t") {
611 $res .= ' ';
612 $n++;
613 for (; ($n % 8) != 0; $n++) {
614 $res .= ' ';
615 }
616 next;
617 }
618 $res .= $c;
619 $n++;
620 }
621
622 return $res;
623}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700624sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700625 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700626 return $res;
627}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700628
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700629sub line_stats {
630 my ($line) = @_;
631
632 # Drop the diff line leader and expand tabs
633 $line =~ s/^.//;
634 $line = expand_tabs($line);
635
636 # Pick the indent from the front of the line.
637 my ($white) = ($line =~ /^(\s*)/);
638
639 return (length($line), length($white));
640}
641
Andy Whitcroft773647a2008-03-28 14:15:58 -0700642my $sanitise_quote = '';
643
644sub sanitise_line_reset {
645 my ($in_comment) = @_;
646
647 if ($in_comment) {
648 $sanitise_quote = '*/';
649 } else {
650 $sanitise_quote = '';
651 }
652}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700653sub sanitise_line {
654 my ($line) = @_;
655
656 my $res = '';
657 my $l = '';
658
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800659 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700660 my $off = 0;
661 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700662
Andy Whitcroft773647a2008-03-28 14:15:58 -0700663 # Always copy over the diff marker.
664 $res = substr($line, 0, 1);
665
666 for ($off = 1; $off < length($line); $off++) {
667 $c = substr($line, $off, 1);
668
669 # Comments we are wacking completly including the begin
670 # and end, all to $;.
671 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
672 $sanitise_quote = '*/';
673
674 substr($res, $off, 2, "$;$;");
675 $off++;
676 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800677 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700678 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700679 $sanitise_quote = '';
680 substr($res, $off, 2, "$;$;");
681 $off++;
682 next;
683 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700684 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
685 $sanitise_quote = '//';
686
687 substr($res, $off, 2, $sanitise_quote);
688 $off++;
689 next;
690 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700691
692 # A \ in a string means ignore the next character.
693 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
694 $c eq "\\") {
695 substr($res, $off, 2, 'XX');
696 $off++;
697 next;
698 }
699 # Regular quotes.
700 if ($c eq "'" || $c eq '"') {
701 if ($sanitise_quote eq '') {
702 $sanitise_quote = $c;
703
704 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700705 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700706 } elsif ($sanitise_quote eq $c) {
707 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700708 }
709 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700710
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800711 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700712 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
713 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700714 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
715 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700716 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
717 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700718 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700719 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700720 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800721 }
722
Daniel Walker113f04a2009-09-21 17:04:35 -0700723 if ($sanitise_quote eq '//') {
724 $sanitise_quote = '';
725 }
726
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800727 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700728 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800729 my $clean = 'X' x length($1);
730 $res =~ s@\<.*\>@<$clean>@;
731
732 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700733 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800734 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700735 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800736 }
737
Andy Whitcroft00df3442007-06-08 13:47:06 -0700738 return $res;
739}
740
Joe Perchesa6962d72013-04-29 16:18:13 -0700741sub get_quoted_string {
742 my ($line, $rawline) = @_;
743
744 return "" if ($line !~ m/(\"[X]+\")/g);
745 return substr($rawline, $-[0], $+[0] - $-[0]);
746}
747
Andy Whitcroft8905a672007-11-28 16:21:06 -0800748sub ctx_statement_block {
749 my ($linenr, $remain, $off) = @_;
750 my $line = $linenr - 1;
751 my $blk = '';
752 my $soff = $off;
753 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700754 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800755
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800756 my $loff = 0;
757
Andy Whitcroft8905a672007-11-28 16:21:06 -0800758 my $type = '';
759 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800760 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800761 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800762 my $c;
763 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800764
765 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800766 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800767 @stack = (['', 0]) if ($#stack == -1);
768
Andy Whitcroft773647a2008-03-28 14:15:58 -0700769 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800770 # If we are about to drop off the end, pull in more
771 # context.
772 if ($off >= $len) {
773 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700774 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800775 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800776 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800777 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800778 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800779 $len = length($blk);
780 $line++;
781 last;
782 }
783 # Bail if there is no further context.
784 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800785 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800786 last;
787 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800788 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
789 $level++;
790 $type = '#';
791 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800792 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800793 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800794 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800795 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800796
Andy Whitcroft773647a2008-03-28 14:15:58 -0700797 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800798
799 # Handle nested #if/#else.
800 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
801 push(@stack, [ $type, $level ]);
802 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
803 ($type, $level) = @{$stack[$#stack - 1]};
804 } elsif ($remainder =~ /^#\s*endif\b/) {
805 ($type, $level) = @{pop(@stack)};
806 }
807
Andy Whitcroft8905a672007-11-28 16:21:06 -0800808 # Statement ends at the ';' or a close '}' at the
809 # outermost level.
810 if ($level == 0 && $c eq ';') {
811 last;
812 }
813
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800814 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700815 if ($level == 0 && $coff_set == 0 &&
816 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
817 $remainder =~ /^(else)(?:\s|{)/ &&
818 $remainder !~ /^else\s+if\b/) {
819 $coff = $off + length($1) - 1;
820 $coff_set = 1;
821 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
822 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800823 }
824
Andy Whitcroft8905a672007-11-28 16:21:06 -0800825 if (($type eq '' || $type eq '(') && $c eq '(') {
826 $level++;
827 $type = '(';
828 }
829 if ($type eq '(' && $c eq ')') {
830 $level--;
831 $type = ($level != 0)? '(' : '';
832
833 if ($level == 0 && $coff < $soff) {
834 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700835 $coff_set = 1;
836 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800837 }
838 }
839 if (($type eq '' || $type eq '{') && $c eq '{') {
840 $level++;
841 $type = '{';
842 }
843 if ($type eq '{' && $c eq '}') {
844 $level--;
845 $type = ($level != 0)? '{' : '';
846
847 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700848 if (substr($blk, $off + 1, 1) eq ';') {
849 $off++;
850 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800851 last;
852 }
853 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800854 # Preprocessor commands end at the newline unless escaped.
855 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
856 $level--;
857 $type = '';
858 $off++;
859 last;
860 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800861 $off++;
862 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700863 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800864 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700865 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800866 $line++;
867 $remain--;
868 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800869
870 my $statement = substr($blk, $soff, $off - $soff + 1);
871 my $condition = substr($blk, $soff, $coff - $soff + 1);
872
873 #warn "STATEMENT<$statement>\n";
874 #warn "CONDITION<$condition>\n";
875
Andy Whitcroft773647a2008-03-28 14:15:58 -0700876 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800877
878 return ($statement, $condition,
879 $line, $remain + 1, $off - $loff + 1, $level);
880}
881
Andy Whitcroftcf655042008-03-04 14:28:20 -0800882sub statement_lines {
883 my ($stmt) = @_;
884
885 # Strip the diff line prefixes and rip blank lines at start and end.
886 $stmt =~ s/(^|\n)./$1/g;
887 $stmt =~ s/^\s*//;
888 $stmt =~ s/\s*$//;
889
890 my @stmt_lines = ($stmt =~ /\n/g);
891
892 return $#stmt_lines + 2;
893}
894
895sub statement_rawlines {
896 my ($stmt) = @_;
897
898 my @stmt_lines = ($stmt =~ /\n/g);
899
900 return $#stmt_lines + 2;
901}
902
903sub statement_block_size {
904 my ($stmt) = @_;
905
906 $stmt =~ s/(^|\n)./$1/g;
907 $stmt =~ s/^\s*{//;
908 $stmt =~ s/}\s*$//;
909 $stmt =~ s/^\s*//;
910 $stmt =~ s/\s*$//;
911
912 my @stmt_lines = ($stmt =~ /\n/g);
913 my @stmt_statements = ($stmt =~ /;/g);
914
915 my $stmt_lines = $#stmt_lines + 2;
916 my $stmt_statements = $#stmt_statements + 1;
917
918 if ($stmt_lines > $stmt_statements) {
919 return $stmt_lines;
920 } else {
921 return $stmt_statements;
922 }
923}
924
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800925sub ctx_statement_full {
926 my ($linenr, $remain, $off) = @_;
927 my ($statement, $condition, $level);
928
929 my (@chunks);
930
Andy Whitcroftcf655042008-03-04 14:28:20 -0800931 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800932 ($statement, $condition, $linenr, $remain, $off, $level) =
933 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700934 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800935 push(@chunks, [ $condition, $statement ]);
936 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
937 return ($level, $linenr, @chunks);
938 }
939
940 # Pull in the following conditional/block pairs and see if they
941 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800942 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800943 ($statement, $condition, $linenr, $remain, $off, $level) =
944 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800945 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700946 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800947 #print "C: push\n";
948 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800949 }
950
951 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800952}
953
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700954sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700955 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700956 my $line;
957 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700958 my $blk = '';
959 my @o;
960 my @c;
961 my @res = ();
962
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700963 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800964 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700965 for ($line = $start; $remain > 0; $line++) {
966 next if ($rawlines[$line] =~ /^-/);
967 $remain--;
968
969 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800970
971 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700972 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800973 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700974 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800975 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700976 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800977 $level = pop(@stack);
978 }
979
Andy Whitcroft01464f32010-10-26 14:23:19 -0700980 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700981 ##print "C<$c>L<$level><$open$close>O<$off>\n";
982 if ($off > 0) {
983 $off--;
984 next;
985 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700986
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700987 if ($c eq $close && $level > 0) {
988 $level--;
989 last if ($level == 0);
990 } elsif ($c eq $open) {
991 $level++;
992 }
993 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700994
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700995 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700996 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700997 }
998
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700999 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001000 }
1001
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001002 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001003}
1004sub ctx_block_outer {
1005 my ($linenr, $remain) = @_;
1006
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001007 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1008 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001009}
1010sub ctx_block {
1011 my ($linenr, $remain) = @_;
1012
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001013 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1014 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001015}
1016sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001017 my ($linenr, $remain, $off) = @_;
1018
1019 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1020 return @r;
1021}
1022sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001023 my ($linenr, $remain) = @_;
1024
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001025 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001026}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001027sub ctx_statement_level {
1028 my ($linenr, $remain, $off) = @_;
1029
1030 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1031}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001032
1033sub ctx_locate_comment {
1034 my ($first_line, $end_line) = @_;
1035
1036 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001037 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001038 return $current_comment if (defined $current_comment);
1039
1040 # Look through the context and try and figure out if there is a
1041 # comment.
1042 my $in_comment = 0;
1043 $current_comment = '';
1044 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001045 my $line = $rawlines[$linenr - 1];
1046 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001047 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1048 $in_comment = 1;
1049 }
1050 if ($line =~ m@/\*@) {
1051 $in_comment = 1;
1052 }
1053 if (!$in_comment && $current_comment ne '') {
1054 $current_comment = '';
1055 }
1056 $current_comment .= $line . "\n" if ($in_comment);
1057 if ($line =~ m@\*/@) {
1058 $in_comment = 0;
1059 }
1060 }
1061
1062 chomp($current_comment);
1063 return($current_comment);
1064}
1065sub ctx_has_comment {
1066 my ($first_line, $end_line) = @_;
1067 my $cmt = ctx_locate_comment($first_line, $end_line);
1068
Andy Whitcroft00df3442007-06-08 13:47:06 -07001069 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001070 ##print "CMMT: $cmt\n";
1071
1072 return ($cmt ne '');
1073}
1074
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001075sub raw_line {
1076 my ($linenr, $cnt) = @_;
1077
1078 my $offset = $linenr - 1;
1079 $cnt++;
1080
1081 my $line;
1082 while ($cnt) {
1083 $line = $rawlines[$offset++];
1084 next if (defined($line) && $line =~ /^-/);
1085 $cnt--;
1086 }
1087
1088 return $line;
1089}
1090
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001091sub cat_vet {
1092 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001093 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001094
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001095 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001096 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1097 $res .= $1;
1098 if ($2 ne '') {
1099 $coded = sprintf("^%c", unpack('C', $2) + 64);
1100 $res .= $coded;
1101 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001102 }
1103 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001104
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001105 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001106}
1107
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001108my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001109my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001110my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001111my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001112
1113sub annotate_reset {
1114 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001115 $av_pending = '_';
1116 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001117 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001118}
1119
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001120sub annotate_values {
1121 my ($stream, $type) = @_;
1122
1123 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001124 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001125 my $cur = $stream;
1126
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001127 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001128
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001129 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001130 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001131 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001132 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001133 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001134 print "WS($1)\n" if ($dbg_values > 1);
1135 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001136 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001137 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001138 }
1139
Florian Micklerc023e4732011-01-12 16:59:58 -08001140 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001141 print "CAST($1)\n" if ($dbg_values > 1);
1142 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001143 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001144
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001145 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001146 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001147 $type = 'T';
1148
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001149 } elsif ($cur =~ /^($Modifier)\s*/) {
1150 print "MODIFIER($1)\n" if ($dbg_values > 1);
1151 $type = 'T';
1152
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001153 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001154 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001155 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001156 push(@av_paren_type, $type);
1157 if ($2 ne '') {
1158 $av_pending = 'N';
1159 }
1160 $type = 'E';
1161
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001162 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001163 print "UNDEF($1)\n" if ($dbg_values > 1);
1164 $av_preprocessor = 1;
1165 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001166
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001167 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001168 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001169 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001170
1171 push(@av_paren_type, $type);
1172 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001173 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001174
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001175 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001176 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1177 $av_preprocessor = 1;
1178
1179 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1180
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001181 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001182
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001183 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001184 print "PRE_END($1)\n" if ($dbg_values > 1);
1185
1186 $av_preprocessor = 1;
1187
1188 # Assume all arms of the conditional end as this
1189 # one does, and continue as if the #endif was not here.
1190 pop(@av_paren_type);
1191 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001192 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193
1194 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001195 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001196
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001197 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1198 print "ATTR($1)\n" if ($dbg_values > 1);
1199 $av_pending = $type;
1200 $type = 'N';
1201
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001202 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001204 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001205 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001206 }
1207 $type = 'N';
1208
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001209 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001210 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001211 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001212 $type = 'N';
1213
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001214 } elsif ($cur =~/^(case)/o) {
1215 print "CASE($1)\n" if ($dbg_values > 1);
1216 $av_pend_colon = 'C';
1217 $type = 'N';
1218
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001219 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001220 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001221 $type = 'N';
1222
1223 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001224 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001225 push(@av_paren_type, $av_pending);
1226 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001227 $type = 'N';
1228
1229 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001230 my $new_type = pop(@av_paren_type);
1231 if ($new_type ne '_') {
1232 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001233 print "PAREN('$1') -> $type\n"
1234 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001235 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001236 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001237 }
1238
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001239 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001240 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001241 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001242 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001243
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001244 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1245 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001246 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001247 } elsif ($type eq 'E') {
1248 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001249 }
1250 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1251 $type = 'V';
1252
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001253 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001254 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001255 $type = 'V';
1256
1257 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001258 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001259 $type = 'N';
1260
Andy Whitcroftcf655042008-03-04 14:28:20 -08001261 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001262 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001263 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001264 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001265
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001266 } elsif ($cur =~/^(,)/) {
1267 print "COMMA($1)\n" if ($dbg_values > 1);
1268 $type = 'C';
1269
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001270 } elsif ($cur =~ /^(\?)/o) {
1271 print "QUESTION($1)\n" if ($dbg_values > 1);
1272 $type = 'N';
1273
1274 } elsif ($cur =~ /^(:)/o) {
1275 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1276
1277 substr($var, length($res), 1, $av_pend_colon);
1278 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1279 $type = 'E';
1280 } else {
1281 $type = 'N';
1282 }
1283 $av_pend_colon = 'O';
1284
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001285 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001286 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001287 $type = 'N';
1288
Andy Whitcroft0d413862008-10-15 22:02:16 -07001289 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001290 my $variant;
1291
1292 print "OPV($1)\n" if ($dbg_values > 1);
1293 if ($type eq 'V') {
1294 $variant = 'B';
1295 } else {
1296 $variant = 'U';
1297 }
1298
1299 substr($var, length($res), 1, $variant);
1300 $type = 'N';
1301
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001302 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001303 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001304 if ($1 ne '++' && $1 ne '--') {
1305 $type = 'N';
1306 }
1307
1308 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001309 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001310 }
1311 if (defined $1) {
1312 $cur = substr($cur, length($1));
1313 $res .= $type x length($1);
1314 }
1315 }
1316
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001317 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001318}
1319
Andy Whitcroft8905a672007-11-28 16:21:06 -08001320sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001321 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001322 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001323 ^(?:
1324 $Modifier|
1325 $Storage|
1326 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001327 DEFINE_\S+
1328 )$|
1329 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001330 goto|
1331 return|
1332 case|
1333 else|
1334 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001335 do|
1336 \#|
1337 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001338 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001339 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001340 )}x;
1341 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1342 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001343 # Check for modifiers.
1344 $possible =~ s/\s*$Storage\s*//g;
1345 $possible =~ s/\s*$Sparse\s*//g;
1346 if ($possible =~ /^\s*$/) {
1347
1348 } elsif ($possible =~ /\s/) {
1349 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001350 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001351 if ($modifier !~ $notPermitted) {
1352 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1353 push(@modifierList, $modifier);
1354 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001355 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001356
1357 } else {
1358 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1359 push(@typeList, $possible);
1360 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001361 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001362 } else {
1363 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001364 }
1365}
1366
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001367my $prefix = '';
1368
Joe Perches000d1cc12011-07-25 17:13:25 -07001369sub show_type {
1370 return !defined $ignore_type{$_[0]};
1371}
1372
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001373sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001374 if (!show_type($_[1]) ||
1375 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001376 return 0;
1377 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001378 my $line;
1379 if ($show_types) {
1380 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1381 } else {
1382 $line = "$prefix$_[0]: $_[2]\n";
1383 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001384 $line = (split('\n', $line))[0] . "\n" if ($terse);
1385
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001386 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001387
1388 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001389}
1390sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001391 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001392}
Joe Perches000d1cc12011-07-25 17:13:25 -07001393
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001394sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001395 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001396 our $clean = 0;
1397 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001398 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001399 }
Joe Perches3705ce52013-07-03 15:05:31 -07001400 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001401}
1402sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001403 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001404 our $clean = 0;
1405 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001406 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001407 }
Joe Perches3705ce52013-07-03 15:05:31 -07001408 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001409}
1410sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001411 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001412 our $clean = 0;
1413 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001414 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001415 }
Joe Perches3705ce52013-07-03 15:05:31 -07001416 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001417}
1418
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001419sub check_absolute_file {
1420 my ($absolute, $herecurr) = @_;
1421 my $file = $absolute;
1422
1423 ##print "absolute<$absolute>\n";
1424
1425 # See if any suffix of this path is a path within the tree.
1426 while ($file =~ s@^[^/]*/@@) {
1427 if (-f "$root/$file") {
1428 ##print "file<$file>\n";
1429 last;
1430 }
1431 }
1432 if (! -f _) {
1433 return 0;
1434 }
1435
1436 # It is, so see if the prefix is acceptable.
1437 my $prefix = $absolute;
1438 substr($prefix, -length($file)) = '';
1439
1440 ##print "prefix<$prefix>\n";
1441 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001442 WARN("USE_RELATIVE_PATH",
1443 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001444 }
1445}
1446
Joe Perches3705ce52013-07-03 15:05:31 -07001447sub trim {
1448 my ($string) = @_;
1449
1450 $string =~ s/(^\s+|\s+$)//g;
1451
1452 return $string;
1453}
1454
1455sub tabify {
1456 my ($leading) = @_;
1457
1458 my $source_indent = 8;
1459 my $max_spaces_before_tab = $source_indent - 1;
1460 my $spaces_to_tab = " " x $source_indent;
1461
1462 #convert leading spaces to tabs
1463 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1464 #Remove spaces before a tab
1465 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1466
1467 return "$leading";
1468}
1469
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001470sub pos_last_openparen {
1471 my ($line) = @_;
1472
1473 my $pos = 0;
1474
1475 my $opens = $line =~ tr/\(/\(/;
1476 my $closes = $line =~ tr/\)/\)/;
1477
1478 my $last_openparen = 0;
1479
1480 if (($opens == 0) || ($closes >= $opens)) {
1481 return -1;
1482 }
1483
1484 my $len = length($line);
1485
1486 for ($pos = 0; $pos < $len; $pos++) {
1487 my $string = substr($line, $pos);
1488 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1489 $pos += length($1) - 1;
1490 } elsif (substr($line, $pos, 1) eq '(') {
1491 $last_openparen = $pos;
1492 } elsif (index($string, '(') == -1) {
1493 last;
1494 }
1495 }
1496
1497 return $last_openparen + 1;
1498}
1499
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001500sub process {
1501 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001502
1503 my $linenr=0;
1504 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001505 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001506 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001507 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001508
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001509 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001510 my $indent;
1511 my $previndent=0;
1512 my $stashindent=0;
1513
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001514 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001515 my $signoff = 0;
1516 my $is_patch = 0;
1517
Joe Perches15662b32011-10-31 17:13:12 -07001518 my $in_header_lines = 1;
1519 my $in_commit_log = 0; #Scanning lines before patch
1520
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001521 my $non_utf8_charset = 0;
1522
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001523 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001524 our $cnt_lines = 0;
1525 our $cnt_error = 0;
1526 our $cnt_warn = 0;
1527 our $cnt_chk = 0;
1528
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001529 # Trace the real file/line as we go.
1530 my $realfile = '';
1531 my $realline = 0;
1532 my $realcnt = 0;
1533 my $here = '';
1534 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001535 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001536 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001537 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001538
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001539 my $prev_values = 'E';
1540
1541 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001542 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001543 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001544 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001545 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001546
Joe Perches323c1262012-12-17 16:02:07 -08001547
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001548 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001549 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001550 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001551 my @setup_docs = ();
1552 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001553
1554 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001555 my $line;
1556 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001557 $linenr++;
1558 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001559
Joe Perches3705ce52013-07-03 15:05:31 -07001560 push(@fixed, $rawline) if ($fix);
1561
Andy Whitcroft773647a2008-03-28 14:15:58 -07001562 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001563 $setup_docs = 0;
1564 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1565 $setup_docs = 1;
1566 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001567 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001568 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001569 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1570 $realline=$1-1;
1571 if (defined $2) {
1572 $realcnt=$3+1;
1573 } else {
1574 $realcnt=1+1;
1575 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001576 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001577
1578 # Guestimate if this is a continuing comment. Run
1579 # the context looking for a comment "edge". If this
1580 # edge is a close comment then we must be in a comment
1581 # at context start.
1582 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001583 my $cnt = $realcnt;
1584 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1585 next if (defined $rawlines[$ln - 1] &&
1586 $rawlines[$ln - 1] =~ /^-/);
1587 $cnt--;
1588 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001589 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001590 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1591 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1592 ($edge) = $1;
1593 last;
1594 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001595 }
1596 if (defined $edge && $edge eq '*/') {
1597 $in_comment = 1;
1598 }
1599
1600 # Guestimate if this is a continuing comment. If this
1601 # is the start of a diff block and this line starts
1602 # ' *' then it is very likely a comment.
1603 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001604 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001605 {
1606 $in_comment = 1;
1607 }
1608
1609 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1610 sanitise_line_reset($in_comment);
1611
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001612 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001613 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001614 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001615 $line = sanitise_line($rawline);
1616 }
1617 push(@lines, $line);
1618
1619 if ($realcnt > 1) {
1620 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1621 } else {
1622 $realcnt = 0;
1623 }
1624
1625 #print "==>$rawline\n";
1626 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001627
1628 if ($setup_docs && $line =~ /^\+/) {
1629 push(@setup_docs, $line);
1630 }
1631 }
1632
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001633 $prefix = '';
1634
Andy Whitcroft773647a2008-03-28 14:15:58 -07001635 $realcnt = 0;
1636 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001637 foreach my $line (@lines) {
1638 $linenr++;
1639
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001640 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001641
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001642#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001643 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001644 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001645 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001646 $realline=$1-1;
1647 if (defined $2) {
1648 $realcnt=$3+1;
1649 } else {
1650 $realcnt=1+1;
1651 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001652 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001653 $prev_values = 'E';
1654
Andy Whitcroft773647a2008-03-28 14:15:58 -07001655 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001656 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001657 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001658 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001659 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001660
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001661# track the line number as we move through the hunk, note that
1662# new versions of GNU diff omit the leading space on completely
1663# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001664 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001665 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001666 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001667
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001668 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001670
1671 # Track the previous line.
1672 ($prevline, $stashline) = ($stashline, $line);
1673 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001674 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1675
Andy Whitcroft773647a2008-03-28 14:15:58 -07001676 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001677
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001678 } elsif ($realcnt == 1) {
1679 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001680 }
1681
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001682 my $hunk_line = ($realcnt != 0);
1683
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001684#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001685 $prefix = "$filename:$realline: " if ($emacs && $file);
1686 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1687
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001688 $here = "#$linenr: " if (!$file);
1689 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001690
1691 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001692 if ($line =~ /^diff --git.*?(\S+)$/) {
1693 $realfile = $1;
1694 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001695 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001696 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001697 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001698 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001699 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001700
1701 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001702 if (!$file && $tree && $p1_prefix ne '' &&
1703 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001704 WARN("PATCH_PREFIX",
1705 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001706 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001707
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001708 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001709 ERROR("MODIFIED_INCLUDE_ASM",
1710 "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 -07001711 }
1712 next;
1713 }
1714
Randy Dunlap389834b2007-06-08 13:47:03 -07001715 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001716
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001717 my $hereline = "$here\n$rawline\n";
1718 my $herecurr = "$here\n$rawline\n";
1719 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001720
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001721 $cnt_lines++ if ($realcnt != 0);
1722
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001723# Check for incorrect file permissions
1724 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1725 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001726 if ($realfile !~ m@scripts/@ &&
1727 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001728 ERROR("EXECUTE_PERMISSIONS",
1729 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001730 }
1731 }
1732
Joe Perches20112472011-07-25 17:13:23 -07001733# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001734 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001735 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001736 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001737 }
1738
1739# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001740 if (!$in_header_lines &&
Joe Perchesce0338d2012-07-30 14:41:18 -07001741 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001742 my $space_before = $1;
1743 my $sign_off = $2;
1744 my $space_after = $3;
1745 my $email = $4;
1746 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1747
Joe Perchesce0338d2012-07-30 14:41:18 -07001748 if ($sign_off !~ /$signature_tags/) {
1749 WARN("BAD_SIGN_OFF",
1750 "Non-standard signature: $sign_off\n" . $herecurr);
1751 }
Joe Perches20112472011-07-25 17:13:23 -07001752 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001753 if (WARN("BAD_SIGN_OFF",
1754 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1755 $fix) {
1756 $fixed[$linenr - 1] =
1757 "$ucfirst_sign_off $email";
1758 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001759 }
Joe Perches20112472011-07-25 17:13:23 -07001760 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001761 if (WARN("BAD_SIGN_OFF",
1762 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1763 $fix) {
1764 $fixed[$linenr - 1] =
1765 "$ucfirst_sign_off $email";
1766 }
1767
Joe Perches20112472011-07-25 17:13:23 -07001768 }
1769 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001770 if (WARN("BAD_SIGN_OFF",
1771 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1772 $fix) {
1773 $fixed[$linenr - 1] =
1774 "$ucfirst_sign_off $email";
1775 }
Joe Perches20112472011-07-25 17:13:23 -07001776 }
1777
1778 my ($email_name, $email_address, $comment) = parse_email($email);
1779 my $suggested_email = format_email(($email_name, $email_address));
1780 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001781 ERROR("BAD_SIGN_OFF",
1782 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001783 } else {
1784 my $dequoted = $suggested_email;
1785 $dequoted =~ s/^"//;
1786 $dequoted =~ s/" </ </;
1787 # Don't force email to have quotes
1788 # Allow just an angle bracketed address
1789 if ("$dequoted$comment" ne $email &&
1790 "<$email_address>$comment" ne $email &&
1791 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001792 WARN("BAD_SIGN_OFF",
1793 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001794 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001795 }
1796 }
1797
Andy Whitcroft00df3442007-06-08 13:47:06 -07001798# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001799 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001800 ERROR("CORRUPTED_PATCH",
1801 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001802 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001803 }
1804
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001805# Check for absolute kernel paths.
1806 if ($tree) {
1807 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1808 my $file = $1;
1809
1810 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1811 check_absolute_file($1, $herecurr)) {
1812 #
1813 } else {
1814 check_absolute_file($file, $herecurr);
1815 }
1816 }
1817 }
1818
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001819# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1820 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001821 $rawline !~ m/^$UTF8*$/) {
1822 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1823
1824 my $blank = copy_spacing($rawline);
1825 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1826 my $hereptr = "$hereline$ptr\n";
1827
Joe Perches34d99212011-07-25 17:13:26 -07001828 CHK("INVALID_UTF8",
1829 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001830 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001831
Joe Perches15662b32011-10-31 17:13:12 -07001832# Check if it's the start of a commit log
1833# (not a header line and we haven't seen the patch filename)
1834 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001835 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001836 $in_header_lines = 0;
1837 $in_commit_log = 1;
1838 }
1839
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001840# Check if there is UTF-8 in a commit log when a mail header has explicitly
1841# declined it, i.e defined some charset where it is missing.
1842 if ($in_header_lines &&
1843 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1844 $1 !~ /utf-8/i) {
1845 $non_utf8_charset = 1;
1846 }
1847
1848 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001849 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001850 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001851 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1852 }
1853
Andy Whitcroft306708542008-10-15 22:02:28 -07001854# ignore non-hunk lines and lines being removed
1855 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001856
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001857#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001858 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001859 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001860 if (ERROR("DOS_LINE_ENDINGS",
1861 "DOS line endings\n" . $herevet) &&
1862 $fix) {
1863 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1864 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001865 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1866 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07001867 if (ERROR("TRAILING_WHITESPACE",
1868 "trailing whitespace\n" . $herevet) &&
1869 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07001870 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001871 }
1872
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001873 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001874 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001875
Andi Kleen33549572010-05-24 14:33:29 -07001876# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001877# Only applies when adding the entry originally, after that we do not have
1878# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001879 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001880 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001881 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001882 my $cnt = $realcnt;
1883 my $ln = $linenr + 1;
1884 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001885 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001886 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001887 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001888 $f = $lines[$ln - 1];
1889 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1890 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001891
1892 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001893
1894 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1895 $is_start = 1;
1896 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1897 $length = -1;
1898 }
1899
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001900 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001901 $f =~ s/#.*//;
1902 $f =~ s/^\s+//;
1903 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001904 if ($f =~ /^\s*config\s/) {
1905 $is_end = 1;
1906 last;
1907 }
Andi Kleen33549572010-05-24 14:33:29 -07001908 $length++;
1909 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001910 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001911 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1912 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001913 }
1914
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001915# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1916 if ($realfile =~ /Kconfig/ &&
1917 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1918 WARN("CONFIG_EXPERIMENTAL",
1919 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1920 }
1921
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001922 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1923 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1924 my $flag = $1;
1925 my $replacement = {
1926 'EXTRA_AFLAGS' => 'asflags-y',
1927 'EXTRA_CFLAGS' => 'ccflags-y',
1928 'EXTRA_CPPFLAGS' => 'cppflags-y',
1929 'EXTRA_LDFLAGS' => 'ldflags-y',
1930 };
1931
1932 WARN("DEPRECATED_VARIABLE",
1933 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1934 }
1935
Andy Whitcroft5368df22008-10-15 22:02:27 -07001936# check we are in a valid source file if not then ignore this hunk
1937 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1938
Joe Perches6cd7f382012-12-17 16:01:54 -08001939#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001940 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001941 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001942 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001943 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08001944 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001945 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001946 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08001947 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001948 }
1949
Josh Triplettca56dc02012-03-23 15:02:21 -07001950# Check for user-visible strings broken across lines, which breaks the ability
1951# to grep for the string. Limited to strings used as parameters (those
1952# following an open parenthesis), which almost completely eliminates false
1953# positives, as well as warning only once per parameter rather than once per
1954# line of the string. Make an exception when the previous string ends in a
1955# newline (multiple lines in one string constant) or \n\t (common in inline
1956# assembly to indent the instruction on the following line).
1957 if ($line =~ /^\+\s*"/ &&
1958 $prevline =~ /"\s*$/ &&
1959 $prevline =~ /\(/ &&
1960 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1961 WARN("SPLIT_STRING",
1962 "quoted string split across lines\n" . $hereprev);
1963 }
1964
Joe Perches5e79d962010-03-05 13:43:55 -08001965# check for spaces before a quoted newline
1966 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07001967 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1968 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
1969 $fix) {
1970 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
1971 }
1972
Joe Perches5e79d962010-03-05 13:43:55 -08001973 }
1974
Andy Whitcroft8905a672007-11-28 16:21:06 -08001975# check for adding lines without a newline.
1976 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001977 WARN("MISSING_EOF_NEWLINE",
1978 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001979 }
1980
Mike Frysinger42e41c52009-09-21 17:04:40 -07001981# Blackfin: use hi/lo macros
1982 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1983 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1984 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001985 ERROR("LO_MACRO",
1986 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001987 }
1988 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1989 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001990 ERROR("HI_MACRO",
1991 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001992 }
1993 }
1994
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001995# check we are in a valid source file C or perl if not then ignore this hunk
1996 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001997
1998# at the beginning of a line any tabs must come first and anything
1999# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002000 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2001 $rawline =~ /^\+\s* \s*/) {
2002 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002003 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002004 if (ERROR("CODE_INDENT",
2005 "code indent should use tabs where possible\n" . $herevet) &&
2006 $fix) {
2007 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2008 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002009 }
2010
Alberto Panizzo08e44362010-03-05 13:43:54 -08002011# check for space before tabs.
2012 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2013 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002014 if (WARN("SPACE_BEFORE_TAB",
2015 "please, no space before tabs\n" . $herevet) &&
2016 $fix) {
2017 $fixed[$linenr - 1] =~
2018 s/(^\+.*) +\t/$1\t/;
2019 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002020 }
2021
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002022# check for && or || at the start of a line
2023 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2024 CHK("LOGICAL_CONTINUATIONS",
2025 "Logical continuations should be on the previous line\n" . $hereprev);
2026 }
2027
2028# check multi-line statement indentation matches previous line
2029 if ($^V && $^V ge 5.10.0 &&
2030 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2031 $prevline =~ /^\+(\t*)(.*)$/;
2032 my $oldindent = $1;
2033 my $rest = $2;
2034
2035 my $pos = pos_last_openparen($rest);
2036 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002037 $line =~ /^(\+| )([ \t]*)/;
2038 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002039
2040 my $goodtabindent = $oldindent .
2041 "\t" x ($pos / 8) .
2042 " " x ($pos % 8);
2043 my $goodspaceindent = $oldindent . " " x $pos;
2044
2045 if ($newindent ne $goodtabindent &&
2046 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002047
2048 if (CHK("PARENTHESIS_ALIGNMENT",
2049 "Alignment should match open parenthesis\n" . $hereprev) &&
2050 $fix && $line =~ /^\+/) {
2051 $fixed[$linenr - 1] =~
2052 s/^\+[ \t]*/\+$goodtabindent/;
2053 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002054 }
2055 }
2056 }
2057
Joe Perches23f780c2013-07-03 15:05:31 -07002058 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002059 if (CHK("SPACING",
2060 "No space is necessary after a cast\n" . $hereprev) &&
2061 $fix) {
2062 $fixed[$linenr - 1] =~
2063 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2064 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002065 }
2066
Joe Perches05880602012-10-04 17:13:35 -07002067 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002068 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2069 $rawline =~ /^\+[ \t]*\*/) {
Joe Perches05880602012-10-04 17:13:35 -07002070 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2071 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2072 }
2073
2074 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002075 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2076 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2077 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2078 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2079 "networking block comments start with * on subsequent lines\n" . $hereprev);
2080 }
2081
2082 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002083 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2084 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2085 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2086 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002087 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2088 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2089 }
2090
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002091# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002092# Exceptions:
2093# 1) within comments
2094# 2) indented preprocessor commands
2095# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002096 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002097 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002098 if (WARN("LEADING_SPACE",
2099 "please, no spaces at the start of a line\n" . $herevet) &&
2100 $fix) {
2101 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2102 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002103 }
2104
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002105# check we are in a valid C source file if not then ignore this hunk
2106 next if ($realfile !~ /\.(h|c)$/);
2107
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002108# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2109 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2110 WARN("CONFIG_EXPERIMENTAL",
2111 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2112 }
2113
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002114# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002115 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002116 WARN("CVS_KEYWORD",
2117 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002118 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002119
Mike Frysinger42e41c52009-09-21 17:04:40 -07002120# Blackfin: don't use __builtin_bfin_[cs]sync
2121 if ($line =~ /__builtin_bfin_csync/) {
2122 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002123 ERROR("CSYNC",
2124 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002125 }
2126 if ($line =~ /__builtin_bfin_ssync/) {
2127 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002128 ERROR("SSYNC",
2129 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002130 }
2131
Joe Perches56e77d72013-02-21 16:44:14 -08002132# check for old HOTPLUG __dev<foo> section markings
2133 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2134 WARN("HOTPLUG_SECTION",
2135 "Using $1 is unnecessary\n" . $herecurr);
2136 }
2137
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002138# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002139 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2140 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002141#print "LINE<$line>\n";
2142 if ($linenr >= $suppress_statement &&
2143 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002144 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002145 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002146 $stat =~ s/\n./\n /g;
2147 $cond =~ s/\n./\n /g;
2148
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002149#print "linenr<$linenr> <$stat>\n";
2150 # If this statement has no statement boundaries within
2151 # it there is no point in retrying a statement scan
2152 # until we hit end of it.
2153 my $frag = $stat; $frag =~ s/;+\s*$//;
2154 if ($frag !~ /(?:{|;)/) {
2155#print "skip<$line_nr_next>\n";
2156 $suppress_statement = $line_nr_next;
2157 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002158
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002159 # Find the real next line.
2160 $realline_next = $line_nr_next;
2161 if (defined $realline_next &&
2162 (!defined $lines[$realline_next - 1] ||
2163 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2164 $realline_next++;
2165 }
2166
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002167 my $s = $stat;
2168 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002169
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002170 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002171 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002172
2173 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002174 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002175
Andy Whitcroft463f2862009-09-21 17:04:34 -07002176 } elsif ($s =~ /^.\s*else\b/s) {
2177
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002178 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002179 } 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 -07002180 my $type = $1;
2181 $type =~ s/\s+/ /g;
2182 possible($type, "A:" . $s);
2183
Andy Whitcroft8905a672007-11-28 16:21:06 -08002184 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002185 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002186 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002187 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002188
2189 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002190 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002191 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002192 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002193
2194 # Check for any sort of function declaration.
2195 # int foo(something bar, other baz);
2196 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002197 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 -08002198 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002199
Andy Whitcroftcf655042008-03-04 14:28:20 -08002200 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002201 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002202 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002203
Andy Whitcroft8905a672007-11-28 16:21:06 -08002204 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002205 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002206
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002207 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002208 }
2209 }
2210 }
2211
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002212 }
2213
Andy Whitcroft653d4872007-06-23 17:16:34 -07002214#
2215# Checks which may be anchored in the context.
2216#
2217
2218# Check for switch () and associated case and default
2219# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002220 if ($line=~/\bswitch\s*\(.*\)/) {
2221 my $err = '';
2222 my $sep = '';
2223 my @ctx = ctx_block_outer($linenr, $realcnt);
2224 shift(@ctx);
2225 for my $ctx (@ctx) {
2226 my ($clen, $cindent) = line_stats($ctx);
2227 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2228 $indent != $cindent) {
2229 $err .= "$sep$ctx\n";
2230 $sep = '';
2231 } else {
2232 $sep = "[...]\n";
2233 }
2234 }
2235 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002236 ERROR("SWITCH_CASE_INDENT_LEVEL",
2237 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002238 }
2239 }
2240
2241# if/while/etc brace do not go on next line, unless defining a do while loop,
2242# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002243 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002244 my $pre_ctx = "$1$2";
2245
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002246 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002247
2248 if ($line =~ /^\+\t{6,}/) {
2249 WARN("DEEP_INDENTATION",
2250 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2251 }
2252
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002253 my $ctx_cnt = $realcnt - $#ctx - 1;
2254 my $ctx = join("\n", @ctx);
2255
Andy Whitcroft548596d2008-07-23 21:29:01 -07002256 my $ctx_ln = $linenr;
2257 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002258
Andy Whitcroft548596d2008-07-23 21:29:01 -07002259 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2260 defined $lines[$ctx_ln - 1] &&
2261 $lines[$ctx_ln - 1] =~ /^-/)) {
2262 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2263 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002264 $ctx_ln++;
2265 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002266
Andy Whitcroft53210162008-07-23 21:29:03 -07002267 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2268 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002269
2270 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002271 ERROR("OPEN_BRACE",
2272 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002273 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002274 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002275 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2276 $ctx =~ /\)\s*\;\s*$/ &&
2277 defined $lines[$ctx_ln - 1])
2278 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002279 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2280 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002281 WARN("TRAILING_SEMICOLON",
2282 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002283 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002284 }
2285 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002286 }
2287
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002288# Check relative indent for conditionals and blocks.
2289 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002290 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2291 ctx_statement_block($linenr, $realcnt, 0)
2292 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002293 my ($s, $c) = ($stat, $cond);
2294
2295 substr($s, 0, length($c), '');
2296
2297 # Make sure we remove the line prefixes as we have
2298 # none on the first line, and are going to readd them
2299 # where necessary.
2300 $s =~ s/\n./\n/gs;
2301
2302 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002303 my @newlines = ($c =~ /\n/gs);
2304 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002305
2306 # We want to check the first line inside the block
2307 # starting at the end of the conditional, so remove:
2308 # 1) any blank line termination
2309 # 2) any opening brace { on end of the line
2310 # 3) any do (...) {
2311 my $continuation = 0;
2312 my $check = 0;
2313 $s =~ s/^.*\bdo\b//;
2314 $s =~ s/^\s*{//;
2315 if ($s =~ s/^\s*\\//) {
2316 $continuation = 1;
2317 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002318 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002319 $check = 1;
2320 $cond_lines++;
2321 }
2322
2323 # Also ignore a loop construct at the end of a
2324 # preprocessor statement.
2325 if (($prevline =~ /^.\s*#\s*define\s/ ||
2326 $prevline =~ /\\\s*$/) && $continuation == 0) {
2327 $check = 0;
2328 }
2329
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002330 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002331 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002332 while ($cond_ptr != $cond_lines) {
2333 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002334
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002335 # If we see an #else/#elif then the code
2336 # is not linear.
2337 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2338 $check = 0;
2339 }
2340
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002341 # Ignore:
2342 # 1) blank lines, they should be at 0,
2343 # 2) preprocessor lines, and
2344 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002345 if ($continuation ||
2346 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002347 $s =~ /^\s*#\s*?/ ||
2348 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002349 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002350 if ($s =~ s/^.*?\n//) {
2351 $cond_lines++;
2352 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002353 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002354 }
2355
2356 my (undef, $sindent) = line_stats("+" . $s);
2357 my $stat_real = raw_line($linenr, $cond_lines);
2358
2359 # Check if either of these lines are modified, else
2360 # this is not this patch's fault.
2361 if (!defined($stat_real) ||
2362 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2363 $check = 0;
2364 }
2365 if (defined($stat_real) && $cond_lines > 1) {
2366 $stat_real = "[...]\n$stat_real";
2367 }
2368
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002369 #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 -07002370
2371 if ($check && (($sindent % 8) != 0 ||
2372 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002373 WARN("SUSPECT_CODE_INDENT",
2374 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002375 }
2376 }
2377
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002378 # Track the 'values' across context and added lines.
2379 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002380 my ($curr_values, $curr_vars) =
2381 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002382 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002383 if ($dbg_values) {
2384 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002385 print "$linenr > .$outline\n";
2386 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002387 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002388 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002389 $prev_values = substr($curr_values, -1);
2390
Andy Whitcroft00df3442007-06-08 13:47:06 -07002391#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002392 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002393
Andy Whitcroft653d4872007-06-23 17:16:34 -07002394# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002395 if ($dbg_type) {
2396 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002397 ERROR("TEST_TYPE",
2398 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002399 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002400 ERROR("TEST_NOT_TYPE",
2401 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002402 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002403 next;
2404 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002405# TEST: allow direct testing of the attribute matcher.
2406 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002407 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002408 ERROR("TEST_ATTR",
2409 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002410 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002411 ERROR("TEST_NOT_ATTR",
2412 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002413 }
2414 next;
2415 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002416
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002417# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002418 if ($line =~ /^.\s*{/ &&
2419 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002420 ERROR("OPEN_BRACE",
2421 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002422 }
2423
Andy Whitcroft653d4872007-06-23 17:16:34 -07002424#
2425# Checks which are anchored on the added line.
2426#
2427
2428# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002429 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002430 my $path = $1;
2431 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002432 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002433 "malformed #include filename\n" . $herecurr);
2434 }
2435 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2436 ERROR("UAPI_INCLUDE",
2437 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002438 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002439 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002440
2441# no C99 // comments
2442 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002443 if (ERROR("C99_COMMENTS",
2444 "do not use C99 // comments\n" . $herecurr) &&
2445 $fix) {
2446 my $line = $fixed[$linenr - 1];
2447 if ($line =~ /\/\/(.*)$/) {
2448 my $comment = trim($1);
2449 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2450 }
2451 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002452 }
2453 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002454 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002455 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002456
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002457# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2458# the whole statement.
2459#print "APW <$lines[$realline_next - 1]>\n";
2460 if (defined $realline_next &&
2461 exists $lines[$realline_next - 1] &&
2462 !defined $suppress_export{$realline_next} &&
2463 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2464 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002465 # Handle definitions which produce identifiers with
2466 # a prefix:
2467 # XXX(foo);
2468 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002469 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002470 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002471 $name =~ /^${Ident}_$2/) {
2472#print "FOO C name<$name>\n";
2473 $suppress_export{$realline_next} = 1;
2474
2475 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002476 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002477 ^.DEFINE_$Ident\(\Q$name\E\)|
2478 ^.DECLARE_$Ident\(\Q$name\E\)|
2479 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002480 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2481 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002482 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002483#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2484 $suppress_export{$realline_next} = 2;
2485 } else {
2486 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002487 }
2488 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002489 if (!defined $suppress_export{$linenr} &&
2490 $prevline =~ /^.\s*$/ &&
2491 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2492 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2493#print "FOO B <$lines[$linenr - 1]>\n";
2494 $suppress_export{$linenr} = 2;
2495 }
2496 if (defined $suppress_export{$linenr} &&
2497 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002498 WARN("EXPORT_SYMBOL",
2499 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002500 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002501
Joe Eloff5150bda2010-08-09 17:21:00 -07002502# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002503 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2504 if (ERROR("GLOBAL_INITIALISERS",
2505 "do not initialise globals to 0 or NULL\n" .
2506 $herecurr) &&
2507 $fix) {
2508 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2509 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002510 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002511# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002512 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2513 if (ERROR("INITIALISED_STATIC",
2514 "do not initialise statics to 0 or NULL\n" .
2515 $herecurr) &&
2516 $fix) {
2517 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2518 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002519 }
2520
Joe Perchescb710ec2010-10-26 14:23:20 -07002521# check for static const char * arrays.
2522 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002523 WARN("STATIC_CONST_CHAR_ARRAY",
2524 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002525 $herecurr);
2526 }
2527
2528# check for static char foo[] = "bar" declarations.
2529 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002530 WARN("STATIC_CONST_CHAR_ARRAY",
2531 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002532 $herecurr);
2533 }
2534
Joe Perches93ed0e22010-10-26 14:23:21 -07002535# check for declarations of struct pci_device_id
2536 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002537 WARN("DEFINE_PCI_DEVICE_TABLE",
2538 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002539 }
2540
Andy Whitcroft653d4872007-06-23 17:16:34 -07002541# check for new typedefs, only function parameters and sparse annotations
2542# make sense.
2543 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002544 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002545 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002546 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002547 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002548 WARN("NEW_TYPEDEFS",
2549 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002550 }
2551
2552# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002553 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002554 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2555 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002556 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002557
Andy Whitcroft65863862009-01-06 14:41:21 -08002558 # Should start with a space.
2559 $to =~ s/^(\S)/ $1/;
2560 # Should not end with a space.
2561 $to =~ s/\s+$//;
2562 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002563 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002564 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002565
Joe Perches3705ce52013-07-03 15:05:31 -07002566## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002567 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002568 if (ERROR("POINTER_LOCATION",
2569 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2570 $fix) {
2571 my $sub_from = $ident;
2572 my $sub_to = $ident;
2573 $sub_to =~ s/\Q$from\E/$to/;
2574 $fixed[$linenr - 1] =~
2575 s@\Q$sub_from\E@$sub_to@;
2576 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002577 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002578 }
2579 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2580 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002581 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002582
Andy Whitcroft65863862009-01-06 14:41:21 -08002583 # Should start with a space.
2584 $to =~ s/^(\S)/ $1/;
2585 # Should not end with a space.
2586 $to =~ s/\s+$//;
2587 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002588 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002589 }
2590 # Modifiers should have spaces.
2591 $to =~ s/(\b$Modifier$)/$1 /;
2592
Joe Perches3705ce52013-07-03 15:05:31 -07002593## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002594 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002595 if (ERROR("POINTER_LOCATION",
2596 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2597 $fix) {
2598
2599 my $sub_from = $match;
2600 my $sub_to = $match;
2601 $sub_to =~ s/\Q$from\E/$to/;
2602 $fixed[$linenr - 1] =~
2603 s@\Q$sub_from\E@$sub_to@;
2604 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002605 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002606 }
2607
2608# # no BUG() or BUG_ON()
2609# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2610# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2611# print "$herecurr";
2612# $clean = 0;
2613# }
2614
Andy Whitcroft8905a672007-11-28 16:21:06 -08002615 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002616 WARN("LINUX_VERSION_CODE",
2617 "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 -08002618 }
2619
Joe Perches17441222011-06-15 15:08:17 -07002620# check for uses of printk_ratelimit
2621 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002622 WARN("PRINTK_RATELIMITED",
2623"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002624 }
2625
Andy Whitcroft00df3442007-06-08 13:47:06 -07002626# printk should use KERN_* levels. Note that follow on printk's on the
2627# same line do not need a level, so we use the current block context
2628# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002629# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002630# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002631 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002632 my $ok = 0;
2633 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2634 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002635 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002636 # with "\n" ignore it, else it is to blame
2637 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2638 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2639 $ok = 1;
2640 }
2641 last;
2642 }
2643 }
2644 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002645 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2646 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002647 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002648 }
2649
Joe Perches243f3802012-05-31 16:26:09 -07002650 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2651 my $orig = $1;
2652 my $level = lc($orig);
2653 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002654 my $level2 = $level;
2655 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002656 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002657 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002658 }
2659
2660 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002661 if (WARN("PREFER_PR_LEVEL",
2662 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2663 $fix) {
2664 $fixed[$linenr - 1] =~
2665 s/\bpr_warning\b/pr_warn/;
2666 }
Joe Perches243f3802012-05-31 16:26:09 -07002667 }
2668
Joe Perchesdc139312013-02-21 16:44:13 -08002669 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2670 my $orig = $1;
2671 my $level = lc($orig);
2672 $level = "warn" if ($level eq "warning");
2673 $level = "dbg" if ($level eq "debug");
2674 WARN("PREFER_DEV_LEVEL",
2675 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2676 }
2677
Andy Whitcroft653d4872007-06-23 17:16:34 -07002678# function brace can't be on same line, except for #defines of do while,
2679# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002680 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2681 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002682 ERROR("OPEN_BRACE",
2683 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002684 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002685
Andy Whitcroft8905a672007-11-28 16:21:06 -08002686# open braces for enum, union and struct go on the same line.
2687 if ($line =~ /^.\s*{/ &&
2688 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002689 ERROR("OPEN_BRACE",
2690 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002691 }
2692
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002693# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002694 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2695 if (WARN("SPACING",
2696 "missing space after $1 definition\n" . $herecurr) &&
2697 $fix) {
2698 $fixed[$linenr - 1] =~
2699 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2700 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002701 }
2702
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002703# check for spacing round square brackets; allowed:
2704# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002705# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2706# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002707 while ($line =~ /(.*?\s)\[/g) {
2708 my ($where, $prefix) = ($-[1], $1);
2709 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002710 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002711 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002712 if (ERROR("BRACKET_SPACE",
2713 "space prohibited before open square bracket '['\n" . $herecurr) &&
2714 $fix) {
2715 $fixed[$linenr - 1] =~
2716 s/^(\+.*?)\s+\[/$1\[/;
2717 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002718 }
2719 }
2720
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002721# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002722 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002723 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002724 my $ctx_before = substr($line, 0, $-[1]);
2725 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002726
2727 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002728 if ($name =~ /^(?:
2729 if|for|while|switch|return|case|
2730 volatile|__volatile__|
2731 __attribute__|format|__extension__|
2732 asm|__asm__)$/x)
2733 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002734 # cpp #define statements have non-optional spaces, ie
2735 # if there is a space between the name and the open
2736 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002737 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002738
2739 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002740 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002741
2742 # If this whole things ends with a type its most
2743 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002744 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002745
2746 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07002747 if (WARN("SPACING",
2748 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2749 $fix) {
2750 $fixed[$linenr - 1] =~
2751 s/\b$name\s+\(/$name\(/;
2752 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002753 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002754 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002755
Andy Whitcroft653d4872007-06-23 17:16:34 -07002756# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002757 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002758 my $fixed_line = "";
2759 my $line_fixed = 0;
2760
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002761 my $ops = qr{
2762 <<=|>>=|<=|>=|==|!=|
2763 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2764 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002765 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2766 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002767 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002768 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07002769
2770## print("element count: <" . $#elements . ">\n");
2771## foreach my $el (@elements) {
2772## print("el: <$el>\n");
2773## }
2774
2775 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07002776 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002777
Joe Perches3705ce52013-07-03 15:05:31 -07002778 foreach my $el (@elements) {
2779 push(@fix_elements, substr($rawline, $off, length($el)));
2780 $off += length($el);
2781 }
2782
2783 $off = 0;
2784
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002785 my $blank = copy_spacing($opline);
2786
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002787 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07002788
2789 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
2790
2791## print("n: <$n> good: <$good>\n");
2792
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002793 $off += length($elements[$n]);
2794
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002795 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002796 my $ca = substr($opline, 0, $off);
2797 my $cc = '';
2798 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2799 $cc = substr($opline, $off + length($elements[$n + 1]));
2800 }
2801 my $cb = "$ca$;$cc";
2802
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002803 my $a = '';
2804 $a = 'V' if ($elements[$n] ne '');
2805 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002806 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002807 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2808 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002809 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002810
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002811 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002812
2813 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002814 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002815 $c = 'V' if ($elements[$n + 2] ne '');
2816 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002817 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002818 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2819 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002820 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002821 } else {
2822 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002823 }
2824
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002825 my $ctx = "${a}x${c}";
2826
2827 my $at = "(ctx:$ctx)";
2828
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002829 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002830 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002831
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002832 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002833 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002834
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002835 # Get the full operator variant.
2836 my $opv = $op . substr($curr_vars, $off, 1);
2837
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002838 # Ignore operators passed as parameters.
2839 if ($op_type ne 'V' &&
2840 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2841
Andy Whitcroftcf655042008-03-04 14:28:20 -08002842# # Ignore comments
2843# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002844
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002845 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002846 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002847 if ($ctx !~ /.x[WEBC]/ &&
2848 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002849 if (ERROR("SPACING",
2850 "space required after that '$op' $at\n" . $hereptr)) {
2851 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2852 $line_fixed = 1;
2853 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002854 }
2855
2856 # // is a comment
2857 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002858
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002859 # No spaces for:
2860 # ->
2861 # : when part of a bitfield
2862 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002863 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002864 if (ERROR("SPACING",
2865 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
2866 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2867 $line_fixed = 1;
2868 if (defined $fix_elements[$n + 2]) {
2869 $fix_elements[$n + 2] =~ s/^\s+//;
2870 }
2871 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002872 }
2873
2874 # , must have a space on the right.
2875 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002876 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002877 if (ERROR("SPACING",
2878 "space required after that '$op' $at\n" . $hereptr)) {
2879 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
2880 $line_fixed = 1;
2881 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002882 }
2883
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002884 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002885 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002886 #warn "'*' is part of type\n";
2887
2888 # unary operators should have a space before and
2889 # none after. May be left adjacent to another
2890 # unary operator, or a cast
2891 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002892 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002893 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002894 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002895 if (ERROR("SPACING",
2896 "space required before that '$op' $at\n" . $hereptr)) {
2897 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
2898 $line_fixed = 1;
2899 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002900 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002901 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002902 # A unary '*' may be const
2903
2904 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002905 if (ERROR("SPACING",
2906 "space prohibited after that '$op' $at\n" . $hereptr)) {
2907 $fixed_line =~ s/\s+$//;
2908 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2909 $line_fixed = 1;
2910 if (defined $fix_elements[$n + 2]) {
2911 $fix_elements[$n + 2] =~ s/^\s+//;
2912 }
2913 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002914 }
2915
2916 # unary ++ and unary -- are allowed no space on one side.
2917 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002918 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002919 if (ERROR("SPACING",
2920 "space required one side of that '$op' $at\n" . $hereptr)) {
2921 $fixed_line =~ s/\s+$//;
2922 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
2923 $line_fixed = 1;
2924 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002925 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002926 if ($ctx =~ /Wx[BE]/ ||
2927 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002928 if (ERROR("SPACING",
2929 "space prohibited before that '$op' $at\n" . $hereptr)) {
2930 $fixed_line =~ s/\s+$//;
2931 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2932 $line_fixed = 1;
2933 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002934 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002935 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002936 if (ERROR("SPACING",
2937 "space prohibited after that '$op' $at\n" . $hereptr)) {
2938 $fixed_line =~ s/\s+$//;
2939 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2940 $line_fixed = 1;
2941 if (defined $fix_elements[$n + 2]) {
2942 $fix_elements[$n + 2] =~ s/^\s+//;
2943 }
2944 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002945 }
2946
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002947 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002948 } elsif ($op eq '<<' or $op eq '>>' or
2949 $op eq '&' or $op eq '^' or $op eq '|' or
2950 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002951 $op eq '*' or $op eq '/' or
2952 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002953 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002954 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002955 if (ERROR("SPACING",
2956 "need consistent spacing around '$op' $at\n" . $hereptr)) {
2957 $fixed_line =~ s/\s+$//;
2958 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2959 $line_fixed = 1;
2960 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002961 }
2962
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002963 # A colon needs no spaces before when it is
2964 # terminating a case value or a label.
2965 } elsif ($opv eq ':C' || $opv eq ':L') {
2966 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07002967 if (ERROR("SPACING",
2968 "space prohibited before that '$op' $at\n" . $hereptr)) {
2969 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2970 $line_fixed = 1;
2971 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002972 }
2973
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002974 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002975 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002976 my $ok = 0;
2977
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002978 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002979 if (($op eq '<' &&
2980 $cc =~ /^\S+\@\S+>/) ||
2981 ($op eq '>' &&
2982 $ca =~ /<\S+\@\S+$/))
2983 {
2984 $ok = 1;
2985 }
2986
2987 # Ignore ?:
2988 if (($opv eq ':O' && $ca =~ /\?$/) ||
2989 ($op eq '?' && $cc =~ /^:/)) {
2990 $ok = 1;
2991 }
2992
2993 if ($ok == 0) {
Joe Perches3705ce52013-07-03 15:05:31 -07002994 if (ERROR("SPACING",
2995 "spaces required around that '$op' $at\n" . $hereptr)) {
2996 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2997 $good = $fix_elements[$n] . " " . trim($fix_elements[$n + 1]) . " ";
2998 $line_fixed = 1;
2999 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003000 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003001 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003002 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003003
3004## print("n: <$n> GOOD: <$good>\n");
3005
3006 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003007 }
Joe Perches3705ce52013-07-03 15:05:31 -07003008
3009 if (($#elements % 2) == 0) {
3010 $fixed_line = $fixed_line . $fix_elements[$#elements];
3011 }
3012
3013 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3014 $fixed[$linenr - 1] = $fixed_line;
3015 }
3016
3017
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003018 }
3019
Joe Perches786b6322013-07-03 15:05:32 -07003020# check for whitespace before a non-naked semicolon
3021 if ($line =~ /^\+.*\S\s+;/) {
3022 if (WARN("SPACING",
3023 "space prohibited before semicolon\n" . $herecurr) &&
3024 $fix) {
3025 1 while $fixed[$linenr - 1] =~
3026 s/^(\+.*\S)\s+;/$1;/;
3027 }
3028 }
3029
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003030# check for multiple assignments
3031 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003032 CHK("MULTIPLE_ASSIGNMENTS",
3033 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003034 }
3035
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003036## # check for multiple declarations, allowing for a function declaration
3037## # continuation.
3038## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3039## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3040##
3041## # Remove any bracketed sections to ensure we do not
3042## # falsly report the parameters of functions.
3043## my $ln = $line;
3044## while ($ln =~ s/\([^\(\)]*\)//g) {
3045## }
3046## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003047## WARN("MULTIPLE_DECLARATION",
3048## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003049## }
3050## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003051
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003052#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003053 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3054 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003055 if (ERROR("SPACING",
3056 "space required before the open brace '{'\n" . $herecurr) &&
3057 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003058 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003059 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003060 }
3061
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003062## # check for blank lines before declarations
3063## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3064## $prevrawline =~ /^.\s*$/) {
3065## WARN("SPACING",
3066## "No blank lines before declarations\n" . $hereprev);
3067## }
3068##
3069
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003070# closing brace should have a space following it when it has anything
3071# on the line
3072 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003073 if (ERROR("SPACING",
3074 "space required after that close brace '}'\n" . $herecurr) &&
3075 $fix) {
3076 $fixed[$linenr - 1] =~
3077 s/}((?!(?:,|;|\)))\S)/} $1/;
3078 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003079 }
3080
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003081# check spacing on square brackets
3082 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003083 if (ERROR("SPACING",
3084 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3085 $fix) {
3086 $fixed[$linenr - 1] =~
3087 s/\[\s+/\[/;
3088 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003089 }
3090 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003091 if (ERROR("SPACING",
3092 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3093 $fix) {
3094 $fixed[$linenr - 1] =~
3095 s/\s+\]/\]/;
3096 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003097 }
3098
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003099# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003100 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3101 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003102 if (ERROR("SPACING",
3103 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3104 $fix) {
3105 $fixed[$linenr - 1] =~
3106 s/\(\s+/\(/;
3107 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003108 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003109 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003110 $line !~ /for\s*\(.*;\s+\)/ &&
3111 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003112 if (ERROR("SPACING",
3113 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3114 $fix) {
3115 $fixed[$linenr - 1] =~
3116 s/\s+\)/\)/;
3117 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003118 }
3119
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003120#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003121 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003122 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003123 if (WARN("INDENTED_LABEL",
3124 "labels should not be indented\n" . $herecurr) &&
3125 $fix) {
3126 $fixed[$linenr - 1] =~
3127 s/^(.)\s+/$1/;
3128 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003129 }
3130
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003131# Return is not a function.
3132 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
3133 my $spacing = $1;
3134 my $value = $2;
3135
Andy Whitcroft86f9d052009-01-06 14:41:24 -08003136 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003137 $value =~ s/\(/ \(/g;
3138 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08003139 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08003140 $value !~ /(?:$Ident|-?$Constant)\s*
3141 $Compare\s*
3142 (?:$Ident|-?$Constant)/x &&
3143 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003144 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003145#print "value<$value>\n";
3146 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003147 ERROR("RETURN_PARENTHESES",
3148 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003149
3150 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003151 ERROR("SPACING",
3152 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003153 }
3154 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003155# Return of what appears to be an errno should normally be -'ve
3156 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3157 my $name = $1;
3158 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003159 WARN("USE_NEGATIVE_ERRNO",
3160 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003161 }
3162 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003163
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003164# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003165 if ($line =~ /\b(if|while|for|switch)\(/) {
3166 if (ERROR("SPACING",
3167 "space required before the open parenthesis '('\n" . $herecurr) &&
3168 $fix) {
3169 $fixed[$linenr - 1] =~
3170 s/\b(if|while|for|switch)\(/$1 \(/;
3171 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003172 }
3173
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003174# Check for illegal assignment in if conditional -- and check for trailing
3175# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003176 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003177 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3178 ctx_statement_block($linenr, $realcnt, 0)
3179 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003180 my ($stat_next) = ctx_statement_block($line_nr_next,
3181 $remain_next, $off_next);
3182 $stat_next =~ s/\n./\n /g;
3183 ##print "stat<$stat> stat_next<$stat_next>\n";
3184
3185 if ($stat_next =~ /^\s*while\b/) {
3186 # If the statement carries leading newlines,
3187 # then count those as offsets.
3188 my ($whitespace) =
3189 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3190 my $offset =
3191 statement_rawlines($whitespace) - 1;
3192
3193 $suppress_whiletrailers{$line_nr_next +
3194 $offset} = 1;
3195 }
3196 }
3197 if (!defined $suppress_whiletrailers{$linenr} &&
3198 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003199 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003200
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003201 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003202 ERROR("ASSIGN_IN_IF",
3203 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003204 }
3205
3206 # Find out what is on the end of the line after the
3207 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003208 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003209 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003210 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003211 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3212 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003213 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003214 # Find out how long the conditional actually is.
3215 my @newlines = ($c =~ /\n/gs);
3216 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003217 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003218
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003219 $stat_real = raw_line($linenr, $cond_lines)
3220 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003221 if (defined($stat_real) && $cond_lines > 1) {
3222 $stat_real = "[...]\n$stat_real";
3223 }
3224
Joe Perches000d1cc12011-07-25 17:13:25 -07003225 ERROR("TRAILING_STATEMENTS",
3226 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003227 }
3228 }
3229
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003230# Check for bitwise tests written as boolean
3231 if ($line =~ /
3232 (?:
3233 (?:\[|\(|\&\&|\|\|)
3234 \s*0[xX][0-9]+\s*
3235 (?:\&\&|\|\|)
3236 |
3237 (?:\&\&|\|\|)
3238 \s*0[xX][0-9]+\s*
3239 (?:\&\&|\|\||\)|\])
3240 )/x)
3241 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003242 WARN("HEXADECIMAL_BOOLEAN_TEST",
3243 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003244 }
3245
Andy Whitcroft8905a672007-11-28 16:21:06 -08003246# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003247 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3248 my $s = $1;
3249 $s =~ s/$;//g; # Remove any comments
3250 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003251 ERROR("TRAILING_STATEMENTS",
3252 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003253 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003254 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003255# if should not continue a brace
3256 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003257 ERROR("TRAILING_STATEMENTS",
3258 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003259 $herecurr);
3260 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003261# case and default should not have general statements after them
3262 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3263 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003264 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003265 \s*return\s+
3266 )/xg)
3267 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003268 ERROR("TRAILING_STATEMENTS",
3269 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003270 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003271
3272 # Check for }<nl>else {, these must be at the same
3273 # indent level to be relevant to each other.
3274 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3275 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003276 ERROR("ELSE_AFTER_BRACE",
3277 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003278 }
3279
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003280 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3281 $previndent == $indent) {
3282 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3283
3284 # Find out what is on the end of the line after the
3285 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003286 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003287 $s =~ s/\n.*//g;
3288
3289 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003290 ERROR("WHILE_AFTER_BRACE",
3291 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003292 }
3293 }
3294
Joe Perches95e2c602013-07-03 15:05:20 -07003295#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003296 while ($line =~ m{($Constant|$Lval)}g) {
3297 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003298
3299#gcc binary extension
3300 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003301 if (WARN("GCC_BINARY_CONSTANT",
3302 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3303 $fix) {
3304 my $hexval = sprintf("0x%x", oct($var));
3305 $fixed[$linenr - 1] =~
3306 s/\b$var\b/$hexval/;
3307 }
Joe Perches95e2c602013-07-03 15:05:20 -07003308 }
3309
3310#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003311 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003312 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003313#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003314 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003315#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003316 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003317 while ($var =~ m{($Ident)}g) {
3318 my $word = $1;
3319 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3320 seed_camelcase_includes() if ($check);
3321 if (!defined $camelcase{$word}) {
3322 $camelcase{$word} = 1;
3323 CHK("CAMELCASE",
3324 "Avoid CamelCase: <$word>\n" . $herecurr);
3325 }
Joe Perches34456862013-07-03 15:05:34 -07003326 }
Joe Perches323c1262012-12-17 16:02:07 -08003327 }
3328 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003329
3330#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003331 if ($line =~ /\#\s*define.*\\\s+$/) {
3332 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3333 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3334 $fix) {
3335 $fixed[$linenr - 1] =~ s/\s+$//;
3336 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003337 }
3338
Andy Whitcroft653d4872007-06-23 17:16:34 -07003339#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003340 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003341 my $file = "$1.h";
3342 my $checkfile = "include/linux/$file";
3343 if (-f "$root/$checkfile" &&
3344 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003345 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003346 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003347 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003348 CHK("ARCH_INCLUDE_LINUX",
3349 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003350 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003351 WARN("INCLUDE_LINUX",
3352 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003353 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003354 }
3355 }
3356
Andy Whitcroft653d4872007-06-23 17:16:34 -07003357# multi-statement macros should be enclosed in a do while loop, grab the
3358# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003359# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003360 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3361 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003362 my $ln = $linenr;
3363 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003364 my ($off, $dstat, $dcond, $rest);
3365 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003366 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003367 ctx_statement_block($linenr, $realcnt, 0);
3368 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003369 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003370 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003371
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003372 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003373 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003374 $dstat =~ s/\\\n.//g;
3375 $dstat =~ s/^\s*//s;
3376 $dstat =~ s/\s*$//s;
3377
3378 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003379 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3380 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003381 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003382 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003383 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003384
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003385 # Flatten any obvious string concatentation.
3386 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3387 $dstat =~ s/$Ident\s*("X*")/$1/)
3388 {
3389 }
3390
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003391 my $exceptions = qr{
3392 $Declare|
3393 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003394 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003395 DECLARE_PER_CPU|
3396 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003397 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003398 union|
3399 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003400 \.$Ident\s*=\s*|
3401 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003402 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003403 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003404 if ($dstat ne '' &&
3405 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3406 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003407 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003408 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003409 $dstat !~ /$exceptions/ &&
3410 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003411 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003412 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003413 $dstat !~ /^for\s*$Constant$/ && # for (...)
3414 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3415 $dstat !~ /^do\s*{/ && # do {...
3416 $dstat !~ /^\({/) # ({...
3417 {
3418 $ctx =~ s/\n*$//;
3419 my $herectx = $here . "\n";
3420 my $cnt = statement_rawlines($ctx);
3421
3422 for (my $n = 0; $n < $cnt; $n++) {
3423 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003424 }
3425
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003426 if ($dstat =~ /;/) {
3427 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3428 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3429 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003430 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003431 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003432 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003433 }
Joe Perches5023d342012-12-17 16:01:47 -08003434
Joe Perches481eb482012-12-17 16:01:56 -08003435# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003436
3437 } else {
3438 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003439 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3440 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003441 $line =~ /^\+.*\\$/) {
3442 WARN("LINE_CONTINUATIONS",
3443 "Avoid unnecessary line continuations\n" . $herecurr);
3444 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003445 }
3446
Joe Perchesb13edf72012-07-30 14:41:24 -07003447# do {} while (0) macro tests:
3448# single-statement macros do not need to be enclosed in do while (0) loop,
3449# macro should not end with a semicolon
3450 if ($^V && $^V ge 5.10.0 &&
3451 $realfile !~ m@/vmlinux.lds.h$@ &&
3452 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3453 my $ln = $linenr;
3454 my $cnt = $realcnt;
3455 my ($off, $dstat, $dcond, $rest);
3456 my $ctx = '';
3457 ($dstat, $dcond, $ln, $cnt, $off) =
3458 ctx_statement_block($linenr, $realcnt, 0);
3459 $ctx = $dstat;
3460
3461 $dstat =~ s/\\\n.//g;
3462
3463 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3464 my $stmts = $2;
3465 my $semis = $3;
3466
3467 $ctx =~ s/\n*$//;
3468 my $cnt = statement_rawlines($ctx);
3469 my $herectx = $here . "\n";
3470
3471 for (my $n = 0; $n < $cnt; $n++) {
3472 $herectx .= raw_line($linenr, $n) . "\n";
3473 }
3474
Joe Perchesac8e97f2012-08-21 16:15:53 -07003475 if (($stmts =~ tr/;/;/) == 1 &&
3476 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003477 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3478 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3479 }
3480 if (defined $semis && $semis ne "") {
3481 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3482 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3483 }
3484 }
3485 }
3486
Mike Frysinger080ba922009-01-06 14:41:25 -08003487# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3488# all assignments may have only one of the following with an assignment:
3489# .
3490# ALIGN(...)
3491# VMLINUX_SYMBOL(...)
3492 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003493 WARN("MISSING_VMLINUX_SYMBOL",
3494 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003495 }
3496
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003497# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003498 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3499 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003500 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003501 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003502 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3503 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003504 my @allowed = ();
3505 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003506 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003507 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003508 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003509 for my $chunk (@chunks) {
3510 my ($cond, $block) = @{$chunk};
3511
Andy Whitcroft773647a2008-03-28 14:15:58 -07003512 # If the condition carries leading newlines, then count those as offsets.
3513 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3514 my $offset = statement_rawlines($whitespace) - 1;
3515
Joe Perchesaad4f612012-03-23 15:02:19 -07003516 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003517 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3518
3519 # We have looked at and allowed this specific line.
3520 $suppress_ifbraces{$ln + $offset} = 1;
3521
3522 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003523 $ln += statement_rawlines($block) - 1;
3524
Andy Whitcroft773647a2008-03-28 14:15:58 -07003525 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003526
3527 $seen++ if ($block =~ /^\s*{/);
3528
Joe Perchesaad4f612012-03-23 15:02:19 -07003529 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003530 if (statement_lines($cond) > 1) {
3531 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003532 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003533 }
3534 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003535 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003536 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003537 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003538 if (statement_block_size($block) > 1) {
3539 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003540 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003541 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003542 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003543 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003544 if ($seen) {
3545 my $sum_allowed = 0;
3546 foreach (@allowed) {
3547 $sum_allowed += $_;
3548 }
3549 if ($sum_allowed == 0) {
3550 WARN("BRACES",
3551 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3552 } elsif ($sum_allowed != $allow &&
3553 $seen != $allow) {
3554 CHK("BRACES",
3555 "braces {} should be used on all arms of this statement\n" . $herectx);
3556 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003557 }
3558 }
3559 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003560 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003561 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003562 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003563
Andy Whitcroftcf655042008-03-04 14:28:20 -08003564 # Check the pre-context.
3565 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3566 #print "APW: ALLOWED: pre<$1>\n";
3567 $allowed = 1;
3568 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003569
3570 my ($level, $endln, @chunks) =
3571 ctx_statement_full($linenr, $realcnt, $-[0]);
3572
Andy Whitcroftcf655042008-03-04 14:28:20 -08003573 # Check the condition.
3574 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003575 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003576 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003577 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003578 }
3579 if (statement_lines($cond) > 1) {
3580 #print "APW: ALLOWED: cond<$cond>\n";
3581 $allowed = 1;
3582 }
3583 if ($block =~/\b(?:if|for|while)\b/) {
3584 #print "APW: ALLOWED: block<$block>\n";
3585 $allowed = 1;
3586 }
3587 if (statement_block_size($block) > 1) {
3588 #print "APW: ALLOWED: lines block<$block>\n";
3589 $allowed = 1;
3590 }
3591 # Check the post-context.
3592 if (defined $chunks[1]) {
3593 my ($cond, $block) = @{$chunks[1]};
3594 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003595 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003596 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003597 if ($block =~ /^\s*\{/) {
3598 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3599 $allowed = 1;
3600 }
3601 }
3602 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003603 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003604 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003605
Andy Whitcroftf0556632008-10-15 22:02:23 -07003606 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003607 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003608 }
3609
Joe Perches000d1cc12011-07-25 17:13:25 -07003610 WARN("BRACES",
3611 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003612 }
3613 }
3614
Joe Perches0979ae62012-12-17 16:01:59 -08003615# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003616 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003617 CHK("BRACES",
3618 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3619 }
Joe Perches77b9a532013-07-03 15:05:29 -07003620 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003621 CHK("BRACES",
3622 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3623 }
3624
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003625# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003626 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3627 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003628 WARN("VOLATILE",
3629 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003630 }
3631
Andy Whitcroft00df3442007-06-08 13:47:06 -07003632# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003633 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003634 CHK("REDUNDANT_CODE",
3635 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003636 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003637 }
3638
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003639# check for needless "if (<foo>) fn(<foo>)" uses
3640 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3641 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3642 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3643 WARN('NEEDLESS_IF',
3644 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003645 }
3646 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003647
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003648# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003649 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003650 # ignore udelay's < 10, however
Bruce Allan37581c22013-02-21 16:44:19 -08003651 if (! ($1 < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003652 CHK("USLEEP_RANGE",
3653 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003654 }
3655 }
3656
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003657# warn about unexpectedly long msleep's
3658 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3659 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003660 WARN("MSLEEP",
3661 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003662 }
3663 }
3664
Joe Perches36ec1932013-07-03 15:05:25 -07003665# check for comparisons of jiffies
3666 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3667 WARN("JIFFIES_COMPARISON",
3668 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3669 }
3670
Joe Perches9d7a34a2013-07-03 15:05:26 -07003671# check for comparisons of get_jiffies_64()
3672 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3673 WARN("JIFFIES_COMPARISON",
3674 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3675 }
3676
Andy Whitcroft00df3442007-06-08 13:47:06 -07003677# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003678# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003679# print "#ifdef in C files should be avoided\n";
3680# print "$herecurr";
3681# $clean = 0;
3682# }
3683
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003684# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003685 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003686 if (ERROR("SPACING",
3687 "exactly one space required after that #$1\n" . $herecurr) &&
3688 $fix) {
3689 $fixed[$linenr - 1] =~
3690 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3691 }
3692
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003693 }
3694
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003695# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003696 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3697 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003698 my $which = $1;
3699 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003700 CHK("UNCOMMENTED_DEFINITION",
3701 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003702 }
3703 }
3704# check for memory barriers without a comment.
3705 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3706 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003707 CHK("MEMORY_BARRIER",
3708 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003709 }
3710 }
3711# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003712 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003713 CHK("ARCH_DEFINES",
3714 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003715 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003716
Tobias Klauserd4977c72010-05-24 14:33:30 -07003717# Check that the storage class is at the beginning of a declaration
3718 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003719 WARN("STORAGE_CLASS",
3720 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003721 }
3722
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003723# check the location of the inline attribute, that it is between
3724# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003725 if ($line =~ /\b$Type\s+$Inline\b/ ||
3726 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003727 ERROR("INLINE_LOCATION",
3728 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003729 }
3730
Andy Whitcroft8905a672007-11-28 16:21:06 -08003731# Check for __inline__ and __inline, prefer inline
3732 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003733 if (WARN("INLINE",
3734 "plain inline is preferred over $1\n" . $herecurr) &&
3735 $fix) {
3736 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
3737
3738 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003739 }
3740
Joe Perches3d130fd2011-01-12 17:00:00 -08003741# Check for __attribute__ packed, prefer __packed
3742 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003743 WARN("PREFER_PACKED",
3744 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003745 }
3746
Joe Perches39b7e282011-07-25 17:13:24 -07003747# Check for __attribute__ aligned, prefer __aligned
3748 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003749 WARN("PREFER_ALIGNED",
3750 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003751 }
3752
Joe Perches5f14d3b2012-01-10 15:09:52 -08003753# Check for __attribute__ format(printf, prefer __printf
3754 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003755 if (WARN("PREFER_PRINTF",
3756 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
3757 $fix) {
3758 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
3759
3760 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08003761 }
3762
Joe Perches6061d942012-03-23 15:02:16 -07003763# Check for __attribute__ format(scanf, prefer __scanf
3764 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003765 if (WARN("PREFER_SCANF",
3766 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
3767 $fix) {
3768 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
3769 }
Joe Perches6061d942012-03-23 15:02:16 -07003770 }
3771
Joe Perches8f53a9b2010-03-05 13:43:48 -08003772# check for sizeof(&)
3773 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003774 WARN("SIZEOF_ADDRESS",
3775 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003776 }
3777
Joe Perches66c80b62012-07-30 14:41:22 -07003778# check for sizeof without parenthesis
3779 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003780 if (WARN("SIZEOF_PARENTHESIS",
3781 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
3782 $fix) {
3783 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
3784 }
Joe Perches66c80b62012-07-30 14:41:22 -07003785 }
3786
Joe Perches428e2fd2011-05-24 17:13:39 -07003787# check for line continuations in quoted strings with odd counts of "
3788 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003789 WARN("LINE_CONTINUATIONS",
3790 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003791 }
3792
Joe Perches88982fe2012-12-17 16:02:00 -08003793# check for struct spinlock declarations
3794 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3795 WARN("USE_SPINLOCK_T",
3796 "struct spinlock should be spinlock_t\n" . $herecurr);
3797 }
3798
Joe Perchesa6962d72013-04-29 16:18:13 -07003799# check for seq_printf uses that could be seq_puts
3800 if ($line =~ /\bseq_printf\s*\(/) {
3801 my $fmt = get_quoted_string($line, $rawline);
3802 if ($fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003803 if (WARN("PREFER_SEQ_PUTS",
3804 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
3805 $fix) {
3806 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
3807 }
Joe Perchesa6962d72013-04-29 16:18:13 -07003808 }
3809 }
3810
Andy Whitcroft554e1652012-01-10 15:09:57 -08003811# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003812 if ($^V && $^V ge 5.10.0 &&
3813 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003814 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003815
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003816 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003817 my $ms_val = $7;
3818 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003819
Andy Whitcroft554e1652012-01-10 15:09:57 -08003820 if ($ms_size =~ /^(0x|)0$/i) {
3821 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003822 "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 -08003823 } elsif ($ms_size =~ /^(0x|)1$/i) {
3824 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003825 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3826 }
3827 }
3828
3829# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003830 if ($^V && $^V ge 5.10.0 &&
3831 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003832 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003833 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003834 my $call = $1;
3835 my $cast1 = deparenthesize($2);
3836 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003837 my $cast2 = deparenthesize($7);
3838 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003839 my $cast;
3840
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003841 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003842 $cast = "$cast1 or $cast2";
3843 } elsif ($cast1 ne "") {
3844 $cast = $cast1;
3845 } else {
3846 $cast = $cast2;
3847 }
3848 WARN("MINMAX",
3849 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003850 }
3851 }
3852
Joe Perches4a273192012-07-30 14:41:20 -07003853# check usleep_range arguments
3854 if ($^V && $^V ge 5.10.0 &&
3855 defined $stat &&
3856 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3857 my $min = $1;
3858 my $max = $7;
3859 if ($min eq $max) {
3860 WARN("USLEEP_RANGE",
3861 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3862 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3863 $min > $max) {
3864 WARN("USLEEP_RANGE",
3865 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3866 }
3867 }
3868
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003869# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003870 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003871 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003872 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003873 my $function_name = $1;
3874 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003875
3876 my $s = $stat;
3877 if (defined $cond) {
3878 substr($s, 0, length($cond), '');
3879 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003880 if ($s =~ /^\s*;/ &&
3881 $function_name ne 'uninitialized_var')
3882 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003883 WARN("AVOID_EXTERNS",
3884 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003885 }
3886
3887 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003888 WARN("FUNCTION_ARGUMENTS",
3889 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003890 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003891
3892 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3893 $stat =~ /^.\s*extern\s+/)
3894 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003895 WARN("AVOID_EXTERNS",
3896 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003897 }
3898
3899# checks for new __setup's
3900 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3901 my $name = $1;
3902
3903 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003904 CHK("UNDOCUMENTED_SETUP",
3905 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003906 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003907 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003908
3909# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003910 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003911 WARN("UNNECESSARY_CASTS",
3912 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003913 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003914
Joe Perchesa640d252013-07-03 15:05:21 -07003915# alloc style
3916# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
3917 if ($^V && $^V ge 5.10.0 &&
3918 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
3919 CHK("ALLOC_SIZEOF_STRUCT",
3920 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
3921 }
3922
Joe Perches972fdea2013-04-29 16:18:12 -07003923# check for krealloc arg reuse
3924 if ($^V && $^V ge 5.10.0 &&
3925 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3926 WARN("KREALLOC_ARG_REUSE",
3927 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3928 }
3929
Joe Perches5ce59ae2013-02-21 16:44:18 -08003930# check for alloc argument mismatch
3931 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3932 WARN("ALLOC_ARRAY_ARGS",
3933 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3934 }
3935
Joe Perchescaf2a542011-01-12 16:59:56 -08003936# check for multiple semicolons
3937 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003938 if (WARN("ONE_SEMICOLON",
3939 "Statements terminations use 1 semicolon\n" . $herecurr) &&
3940 $fix) {
3941 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
3942 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08003943 }
3944
3945# check for switch/default statements without a break;
3946 if ($^V && $^V ge 5.10.0 &&
3947 defined $stat &&
3948 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3949 my $ctx = '';
3950 my $herectx = $here . "\n";
3951 my $cnt = statement_rawlines($stat);
3952 for (my $n = 0; $n < $cnt; $n++) {
3953 $herectx .= raw_line($linenr, $n) . "\n";
3954 }
3955 WARN("DEFAULT_NO_BREAK",
3956 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08003957 }
3958
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003959# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07003960 if ($line =~ /\b__FUNCTION__\b/) {
3961 if (WARN("USE_FUNC",
3962 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
3963 $fix) {
3964 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
3965 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003966 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003967
Joe Perches2c924882012-03-23 15:02:20 -07003968# check for use of yield()
3969 if ($line =~ /\byield\s*\(\s*\)/) {
3970 WARN("YIELD",
3971 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3972 }
3973
Joe Perches179f8f42013-07-03 15:05:30 -07003974# check for comparisons against true and false
3975 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
3976 my $lead = $1;
3977 my $arg = $2;
3978 my $test = $3;
3979 my $otype = $4;
3980 my $trail = $5;
3981 my $op = "!";
3982
3983 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
3984
3985 my $type = lc($otype);
3986 if ($type =~ /^(?:true|false)$/) {
3987 if (("$test" eq "==" && "$type" eq "true") ||
3988 ("$test" eq "!=" && "$type" eq "false")) {
3989 $op = "";
3990 }
3991
3992 CHK("BOOL_COMPARISON",
3993 "Using comparison to $otype is error prone\n" . $herecurr);
3994
3995## maybe suggesting a correct construct would better
3996## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
3997
3998 }
3999 }
4000
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004001# check for semaphores initialized locked
4002 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004003 WARN("CONSIDER_COMPLETION",
4004 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004005 }
Joe Perches6712d852012-03-23 15:02:20 -07004006
Joe Perches67d0a072011-10-31 17:13:10 -07004007# recommend kstrto* over simple_strto* and strict_strto*
4008 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004009 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004010 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004011 }
Joe Perches6712d852012-03-23 15:02:20 -07004012
Michael Ellermanf3db6632008-07-23 21:28:57 -07004013# check for __initcall(), use device_initcall() explicitly please
4014 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004015 WARN("USE_DEVICE_INITCALL",
4016 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004017 }
Joe Perches6712d852012-03-23 15:02:20 -07004018
Emese Revfy79404842010-03-05 13:43:53 -08004019# check for various ops structs, ensure they are const.
4020 my $struct_ops = qr{acpi_dock_ops|
4021 address_space_operations|
4022 backlight_ops|
4023 block_device_operations|
4024 dentry_operations|
4025 dev_pm_ops|
4026 dma_map_ops|
4027 extent_io_ops|
4028 file_lock_operations|
4029 file_operations|
4030 hv_ops|
4031 ide_dma_ops|
4032 intel_dvo_dev_ops|
4033 item_operations|
4034 iwl_ops|
4035 kgdb_arch|
4036 kgdb_io|
4037 kset_uevent_ops|
4038 lock_manager_operations|
4039 microcode_ops|
4040 mtrr_ops|
4041 neigh_ops|
4042 nlmsvc_binding|
4043 pci_raw_ops|
4044 pipe_buf_operations|
4045 platform_hibernation_ops|
4046 platform_suspend_ops|
4047 proto_ops|
4048 rpc_pipe_ops|
4049 seq_operations|
4050 snd_ac97_build_ops|
4051 soc_pcmcia_socket_ops|
4052 stacktrace_ops|
4053 sysfs_ops|
4054 tty_operations|
4055 usb_mon_operations|
4056 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004057 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004058 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004059 WARN("CONST_STRUCT",
4060 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004061 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004062 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004063
4064# use of NR_CPUS is usually wrong
4065# ignore definitions of NR_CPUS and usage to define arrays as likely right
4066 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004067 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4068 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004069 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4070 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4071 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004072 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004073 WARN("NR_CPUS",
4074 "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 -07004075 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004076
4077# check for %L{u,d,i} in strings
4078 my $string;
4079 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4080 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004081 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004082 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004083 WARN("PRINTF_L",
4084 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004085 last;
4086 }
4087 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004088
4089# whine mightly about in_atomic
4090 if ($line =~ /\bin_atomic\s*\(/) {
4091 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004092 ERROR("IN_ATOMIC",
4093 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004094 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004095 WARN("IN_ATOMIC",
4096 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004097 }
4098 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004099
4100# check for lockdep_set_novalidate_class
4101 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4102 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4103 if ($realfile !~ m@^kernel/lockdep@ &&
4104 $realfile !~ m@^include/linux/lockdep@ &&
4105 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004106 ERROR("LOCKDEP",
4107 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004108 }
4109 }
Dave Jones88f88312011-01-12 16:59:59 -08004110
4111 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4112 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004113 WARN("EXPORTED_WORLD_WRITABLE",
4114 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004115 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004116 }
4117
4118 # If we have no input at all, then there is nothing to report on
4119 # so just keep quiet.
4120 if ($#rawlines == -1) {
4121 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004122 }
4123
Andy Whitcroft8905a672007-11-28 16:21:06 -08004124 # In mailback mode only produce a report in the negative, for
4125 # things that appear to be patches.
4126 if ($mailback && ($clean == 1 || !$is_patch)) {
4127 exit(0);
4128 }
4129
4130 # This is not a patch, and we are are in 'no-patch' mode so
4131 # just keep quiet.
4132 if (!$chk_patch && !$is_patch) {
4133 exit(0);
4134 }
4135
4136 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004137 ERROR("NOT_UNIFIED_DIFF",
4138 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004139 }
4140 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004141 ERROR("MISSING_SIGN_OFF",
4142 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004143 }
4144
Andy Whitcroft8905a672007-11-28 16:21:06 -08004145 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004146 if ($summary && !($clean == 1 && $quiet == 1)) {
4147 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004148 print "total: $cnt_error errors, $cnt_warn warnings, " .
4149 (($check)? "$cnt_chk checks, " : "") .
4150 "$cnt_lines lines checked\n";
4151 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004152 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004153
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004154 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004155
4156 if ($^V lt 5.10.0) {
4157 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4158 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4159 }
4160
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004161 # If there were whitespace errors which cleanpatch can fix
4162 # then suggest that.
4163 if ($rpt_cleaners) {
4164 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4165 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004166 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004167 }
4168 }
4169
Artem Bityutskiy11232682012-03-23 15:02:17 -07004170 if ($quiet == 0 && keys %ignore_type) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004171 print "NOTE: Ignored message types:";
4172 foreach my $ignore (sort keys %ignore_type) {
4173 print " $ignore";
4174 }
Artem Bityutskiy11232682012-03-23 15:02:17 -07004175 print "\n\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07004176 }
4177
Joe Perches3705ce52013-07-03 15:05:31 -07004178 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4179 my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
4180 my $linecount = 0;
4181 my $f;
4182
4183 open($f, '>', $newfile)
4184 or die "$P: Can't open $newfile for write\n";
4185 foreach my $fixed_line (@fixed) {
4186 $linecount++;
4187 if ($file) {
4188 if ($linecount > 3) {
4189 $fixed_line =~ s/^\+//;
4190 print $f $fixed_line. "\n";
4191 }
4192 } else {
4193 print $f $fixed_line . "\n";
4194 }
4195 }
4196 close($f);
4197
4198 if (!$quiet) {
4199 print << "EOM";
4200Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4201
4202Do _NOT_ trust the results written to this file.
4203Do _NOT_ submit these changes without inspecting them for correctness.
4204
4205This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4206No warranties, expressed or implied...
4207
4208EOM
4209 }
4210 }
4211
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004212 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004213 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004214 }
4215 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004216 print << "EOM";
4217$vname has style problems, please review.
4218
4219If any of these errors are false positives, please report
4220them to the maintainer, see CHECKPATCH in MAINTAINERS.
4221EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004222 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004223
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004224 return $clean;
4225}