blob: fc72d64cd2d4aa6d66d83061b1a29d6c3b36a4ba [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b5b2007-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;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070027my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080028my $summary = 1;
29my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080030my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070031my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070032my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080033my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070034my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080035my %debug;
Joe Perches34456862013-07-03 15:05:34 -070036my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070037my %use_type = ();
38my @use = ();
39my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070040my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070041my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070042my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080043my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070044my $ignore_perl_version = 0;
45my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070046
47sub help {
48 my ($exitcode) = @_;
49
50 print << "EOM";
51Usage: $P [OPTION]... [FILE]...
52Version: $V
53
54Options:
55 -q, --quiet quiet
56 --no-tree run without a kernel tree
57 --no-signoff do not check for 'Signed-off-by' line
58 --patch treat FILE as patchfile (default)
59 --emacs emacs compile window format
60 --terse one line per report
61 -f, --file treat FILE as regular source file
62 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070063 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070064 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080065 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070066 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070067 --root=PATH PATH to the kernel tree root
68 --no-summary suppress the per-file summary
69 --mailback only produce a report in case of warnings/errors
70 --summary-file include the filename in summary
71 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
72 'values', 'possible', 'type', and 'attr' (default
73 is all off)
74 --test-only=WORD report only warnings/errors containing WORD
75 literally
Joe Perches3705ce52013-07-03 15:05:31 -070076 --fix EXPERIMENTAL - may create horrible results
77 If correctable single-line errors exist, create
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
80 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080081 --fix-inplace EXPERIMENTAL - may create horrible results
82 Is the same as --fix, but overwrites the input
83 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070084 --ignore-perl-version override checking of perl version. expect
85 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070086 -h, --help, --version display this help and exit
87
88When FILE is - read standard input.
89EOM
90
91 exit($exitcode);
92}
93
Joe Perches000d1cc12011-07-25 17:13:25 -070094my $conf = which_conf($configuration_file);
95if (-f $conf) {
96 my @conf_args;
97 open(my $conffile, '<', "$conf")
98 or warn "$P: Can't find a readable $configuration_file file $!\n";
99
100 while (<$conffile>) {
101 my $line = $_;
102
103 $line =~ s/\s*\n?$//g;
104 $line =~ s/^\s*//g;
105 $line =~ s/\s+/ /g;
106
107 next if ($line =~ m/^\s*#/);
108 next if ($line =~ m/^\s*$/);
109
110 my @words = split(" ", $line);
111 foreach my $word (@words) {
112 last if ($word =~ m/^#/);
113 push (@conf_args, $word);
114 }
115 }
116 close($conffile);
117 unshift(@ARGV, @conf_args) if @conf_args;
118}
119
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700120GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700121 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700122 'tree!' => \$tree,
123 'signoff!' => \$chk_signoff,
124 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700125 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800126 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700127 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700128 'subjective!' => \$check,
129 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700130 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700131 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700132 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800133 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700134 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800135 'summary!' => \$summary,
136 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800137 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700138 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800139 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700140 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800141 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700142 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700143 'h|help' => \$help,
144 'version' => \$help
145) or help(1);
146
147help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700148
Joe Perches9624b8d2014-01-23 15:54:44 -0800149$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700150$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800151
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700152my $exit = 0;
153
Dave Hansend62a2012013-09-11 14:23:56 -0700154if ($^V && $^V lt $minimum_perl_version) {
155 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
156 if (!$ignore_perl_version) {
157 exit(1);
158 }
159}
160
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700161if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700162 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700163 exit(1);
164}
165
Joe Perches91bfe482013-09-11 14:23:59 -0700166sub hash_save_array_words {
167 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700168
Joe Perches91bfe482013-09-11 14:23:59 -0700169 my @array = split(/,/, join(',', @$arrayRef));
170 foreach my $word (@array) {
171 $word =~ s/\s*\n?$//g;
172 $word =~ s/^\s*//g;
173 $word =~ s/\s+/ /g;
174 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700175
Joe Perches91bfe482013-09-11 14:23:59 -0700176 next if ($word =~ m/^\s*#/);
177 next if ($word =~ m/^\s*$/);
178
179 $hashRef->{$word}++;
180 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700181}
182
Joe Perches91bfe482013-09-11 14:23:59 -0700183sub hash_show_words {
184 my ($hashRef, $prefix) = @_;
185
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700188 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700189 print " $word";
190 }
191 print "\n\n";
192 }
193}
194
195hash_save_array_words(\%ignore_type, \@ignore);
196hash_save_array_words(\%use_type, \@use);
197
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800198my $dbg_values = 0;
199my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700200my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700201my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800202for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800203 ## no critic
204 eval "\${dbg_$key} = '$debug{$key}';";
205 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800206}
207
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700208my $rpt_cleaners = 0;
209
Andy Whitcroft8905a672007-11-28 16:21:06 -0800210if ($terse) {
211 $emacs = 1;
212 $quiet++;
213}
214
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700215if ($tree) {
216 if (defined $root) {
217 if (!top_of_kernel_tree($root)) {
218 die "$P: $root: --root does not point at a valid tree\n";
219 }
220 } else {
221 if (top_of_kernel_tree('.')) {
222 $root = '.';
223 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
224 top_of_kernel_tree($1)) {
225 $root = $1;
226 }
227 }
228
229 if (!defined $root) {
230 print "Must be run from the top-level dir. of a kernel tree\n";
231 exit(2);
232 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700233}
234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235my $emitted_corrupt = 0;
236
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700237our $Ident = qr{
238 [A-Za-z_][A-Za-z\d_]*
239 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
240 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700241our $Storage = qr{extern|static|asmlinkage};
242our $Sparse = qr{
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800249 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700250 __ref|
251 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700252 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800253our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
254our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
255our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
256our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
257our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700258
Wolfram Sang52131292010-03-05 13:43:51 -0800259# Notes to $Attribute:
260# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261our $Attribute = qr{
262 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700277 __read_mostly|
278 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700279 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800282 ____cacheline_internodealigned_in_smp|
283 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700285our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700286our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700287our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
288our $Lval = qr{$Ident(?:$Member)*};
289
Joe Perches95e2c602013-07-03 15:05:20 -0700290our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
291our $Binary = qr{(?i)0b[01]+$Int_type?};
292our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
293our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700294our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800295our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
296our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
297our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800298our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700299our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800300our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700301our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700302our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303our $Operators = qr{
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700306 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700307 }x;
308
Joe Perches91cb5192014-04-03 14:49:32 -0700309our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
310
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700312our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800313our $Type;
314our $Declare;
315
Joe Perches15662b32011-10-31 17:13:12 -0700316our $NON_ASCII_UTF8 = qr{
317 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700318 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
319 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
320 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
321 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
322 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
323 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
324}x;
325
Joe Perches15662b32011-10-31 17:13:12 -0700326our $UTF8 = qr{
327 [\x09\x0A\x0D\x20-\x7E] # ASCII
328 | $NON_ASCII_UTF8
329}x;
330
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700331our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700332 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700333 atomic_t
334)};
335
Joe Perches691e6692010-03-05 13:43:51 -0800336our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700337 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700338 (?:[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 -0700339 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700340 panic|
Joe Perches06668722013-11-12 15:10:07 -0800341 MODULE_[A-Z_]+|
342 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800343)};
344
Joe Perches20112472011-07-25 17:13:23 -0700345our $signature_tags = qr{(?xi:
346 Signed-off-by:|
347 Acked-by:|
348 Tested-by:|
349 Reviewed-by:|
350 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700351 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700352 To:|
353 Cc:
354)};
355
Andy Whitcroft8905a672007-11-28 16:21:06 -0800356our @typeList = (
357 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700358 qr{(?:unsigned\s+)?char},
359 qr{(?:unsigned\s+)?short},
360 qr{(?:unsigned\s+)?int},
361 qr{(?:unsigned\s+)?long},
362 qr{(?:unsigned\s+)?long\s+int},
363 qr{(?:unsigned\s+)?long\s+long},
364 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800365 qr{unsigned},
366 qr{float},
367 qr{double},
368 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800369 qr{struct\s+$Ident},
370 qr{union\s+$Ident},
371 qr{enum\s+$Ident},
372 qr{${Ident}_t},
373 qr{${Ident}_handler},
374 qr{${Ident}_handler_fn},
375);
Joe Perches8716de32013-09-11 14:24:05 -0700376our @typeListWithAttr = (
377 @typeList,
378 qr{struct\s+$InitAttribute\s+$Ident},
379 qr{union\s+$InitAttribute\s+$Ident},
380);
381
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700382our @modifierList = (
383 qr{fastcall},
384);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385
Joe Perches24358802014-04-03 14:49:13 -0700386our @mode_permission_funcs = (
387 ["module_param", 3],
388 ["module_param_(?:array|named|string)", 4],
389 ["module_param_array_named", 5],
390 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
391 ["proc_create(?:_data|)", 2],
392 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
393);
394
Joe Perches515a2352014-04-03 14:49:24 -0700395#Create a search pattern for all these functions to speed up a loop below
396our $mode_perms_search = "";
397foreach my $entry (@mode_permission_funcs) {
398 $mode_perms_search .= '|' if ($mode_perms_search ne "");
399 $mode_perms_search .= $entry->[0];
400}
401
Joe Perches3f7bac02014-06-04 16:12:04 -0700402our $declaration_macros = qr{(?x:
403 (?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(|
404 (?:$Storage\s+)?LIST_HEAD\s*\(
405)};
406
Wolfram Sang7840a942010-08-09 17:20:57 -0700407our $allowed_asm_includes = qr{(?x:
408 irq|
409 memory
410)};
411# memory.h: ARM has a custom one
412
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700414 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
415 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700416 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700417 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800418 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700419 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800420 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800421 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700423 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800424 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700425 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700427 $NonptrTypeWithAttr = qr{
428 (?:$Modifier\s+|const\s+)*
429 (?:
430 (?:typeof|__typeof__)\s*\([^\)]*\)|
431 (?:$typeTypedefs\b)|
432 (?:${allWithAttr}\b)
433 )
434 (?:\s+$Modifier|\s+const)*
435 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800436 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700437 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700438 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700439 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700441 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800442}
443build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700444
Joe Perches7d2367a2011-07-25 17:13:22 -0700445our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700446
447# Using $balanced_parens, $LvalOrFunc, or $FuncArg
448# requires at least perl version v5.10.0
449# Any use must be runtime checked with $^V
450
451our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700452our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800453our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700454
455sub deparenthesize {
456 my ($string) = @_;
457 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700458
459 while ($string =~ /^\s*\(.*\)\s*$/) {
460 $string =~ s@^\s*\(\s*@@;
461 $string =~ s@\s*\)\s*$@@;
462 }
463
Joe Perches7d2367a2011-07-25 17:13:22 -0700464 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700465
Joe Perches7d2367a2011-07-25 17:13:22 -0700466 return $string;
467}
468
Joe Perches34456862013-07-03 15:05:34 -0700469sub seed_camelcase_file {
470 my ($file) = @_;
471
472 return if (!(-f $file));
473
474 local $/;
475
476 open(my $include_file, '<', "$file")
477 or warn "$P: Can't read '$file' $!\n";
478 my $text = <$include_file>;
479 close($include_file);
480
481 my @lines = split('\n', $text);
482
483 foreach my $line (@lines) {
484 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
485 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
486 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800487 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
488 $camelcase{$1} = 1;
489 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700490 $camelcase{$1} = 1;
491 }
492 }
493}
494
495my $camelcase_seeded = 0;
496sub seed_camelcase_includes {
497 return if ($camelcase_seeded);
498
499 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700500 my $camelcase_cache = "";
501 my @include_files = ();
502
503 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700504
Richard Genoud3645e322014-02-10 14:25:32 -0800505 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700506 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
507 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700508 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700509 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700510 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700511 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700512 @include_files = split('\n', $files);
513 foreach my $file (@include_files) {
514 my $date = POSIX::strftime("%Y%m%d%H%M",
515 localtime((stat $file)[9]));
516 $last_mod_date = $date if ($last_mod_date < $date);
517 }
518 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700519 }
Joe Perchesc707a812013-07-08 16:00:43 -0700520
521 if ($camelcase_cache ne "" && -f $camelcase_cache) {
522 open(my $camelcase_file, '<', "$camelcase_cache")
523 or warn "$P: Can't read '$camelcase_cache' $!\n";
524 while (<$camelcase_file>) {
525 chomp;
526 $camelcase{$_} = 1;
527 }
528 close($camelcase_file);
529
530 return;
531 }
532
Richard Genoud3645e322014-02-10 14:25:32 -0800533 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700534 $files = `git ls-files "include/*.h"`;
535 @include_files = split('\n', $files);
536 }
537
Joe Perches34456862013-07-03 15:05:34 -0700538 foreach my $file (@include_files) {
539 seed_camelcase_file($file);
540 }
Joe Perches351b2a12013-07-03 15:05:36 -0700541
Joe Perchesc707a812013-07-08 16:00:43 -0700542 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700543 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700544 open(my $camelcase_file, '>', "$camelcase_cache")
545 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700546 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
547 print $camelcase_file ("$_\n");
548 }
549 close($camelcase_file);
550 }
Joe Perches34456862013-07-03 15:05:34 -0700551}
552
Joe Perchesd311cd42014-08-06 16:10:57 -0700553sub git_commit_info {
554 my ($commit, $id, $desc) = @_;
555
556 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
557
558 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
559 $output =~ s/^\s*//gm;
560 my @lines = split("\n", $output);
561
562 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
563# Maybe one day convert this block of bash into something that returns
564# all matching commit ids, but it's very slow...
565#
566# echo "checking commits $1..."
567# git rev-list --remotes | grep -i "^$1" |
568# while read line ; do
569# git log --format='%H %s' -1 $line |
570# echo "commit $(cut -c 1-12,41-)"
571# done
572 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
573 } else {
574 $id = substr($lines[0], 0, 12);
575 $desc = substr($lines[0], 41);
576 }
577
578 return ($id, $desc);
579}
580
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700581$chk_signoff = 0 if ($file);
582
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700583my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800584my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700585my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800586my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700587for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800588 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700589 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800590 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700591 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800592 } elsif ($filename eq '-') {
593 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700594 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800595 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700596 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700597 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800598 if ($filename eq '-') {
599 $vname = 'Your patch';
600 } else {
601 $vname = $filename;
602 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800603 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700604 chomp;
605 push(@rawlines, $_);
606 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800607 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800608 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700609 $exit = 1;
610 }
611 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800612 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700613 @fixed = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700614}
615
616exit($exit);
617
618sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700619 my ($root) = @_;
620
621 my @tree_check = (
622 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
623 "README", "Documentation", "arch", "include", "drivers",
624 "fs", "init", "ipc", "kernel", "lib", "scripts",
625 );
626
627 foreach my $check (@tree_check) {
628 if (! -e $root . '/' . $check) {
629 return 0;
630 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700631 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700632 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700633}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700634
Joe Perches20112472011-07-25 17:13:23 -0700635sub parse_email {
636 my ($formatted_email) = @_;
637
638 my $name = "";
639 my $address = "";
640 my $comment = "";
641
642 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
643 $name = $1;
644 $address = $2;
645 $comment = $3 if defined $3;
646 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
647 $address = $1;
648 $comment = $2 if defined $2;
649 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
650 $address = $1;
651 $comment = $2 if defined $2;
652 $formatted_email =~ s/$address.*$//;
653 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700654 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700655 $name =~ s/^\"|\"$//g;
656 # If there's a name left after stripping spaces and
657 # leading quotes, and the address doesn't have both
658 # leading and trailing angle brackets, the address
659 # is invalid. ie:
660 # "joe smith joe@smith.com" bad
661 # "joe smith <joe@smith.com" bad
662 if ($name ne "" && $address !~ /^<[^>]+>$/) {
663 $name = "";
664 $address = "";
665 $comment = "";
666 }
667 }
668
Joe Perches3705ce52013-07-03 15:05:31 -0700669 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700670 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700671 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700672 $address =~ s/^\<|\>$//g;
673
674 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
675 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
676 $name = "\"$name\"";
677 }
678
679 return ($name, $address, $comment);
680}
681
682sub format_email {
683 my ($name, $address) = @_;
684
685 my $formatted_email;
686
Joe Perches3705ce52013-07-03 15:05:31 -0700687 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700688 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700689 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700690
691 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
692 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
693 $name = "\"$name\"";
694 }
695
696 if ("$name" eq "") {
697 $formatted_email = "$address";
698 } else {
699 $formatted_email = "$name <$address>";
700 }
701
702 return $formatted_email;
703}
704
Joe Perchesd311cd42014-08-06 16:10:57 -0700705sub which {
706 my ($bin) = @_;
707
708 foreach my $path (split(/:/, $ENV{PATH})) {
709 if (-e "$path/$bin") {
710 return "$path/$bin";
711 }
712 }
713
714 return "";
715}
716
Joe Perches000d1cc12011-07-25 17:13:25 -0700717sub which_conf {
718 my ($conf) = @_;
719
720 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
721 if (-e "$path/$conf") {
722 return "$path/$conf";
723 }
724 }
725
726 return "";
727}
728
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700729sub expand_tabs {
730 my ($str) = @_;
731
732 my $res = '';
733 my $n = 0;
734 for my $c (split(//, $str)) {
735 if ($c eq "\t") {
736 $res .= ' ';
737 $n++;
738 for (; ($n % 8) != 0; $n++) {
739 $res .= ' ';
740 }
741 next;
742 }
743 $res .= $c;
744 $n++;
745 }
746
747 return $res;
748}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700749sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700750 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700751 return $res;
752}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700753
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700754sub line_stats {
755 my ($line) = @_;
756
757 # Drop the diff line leader and expand tabs
758 $line =~ s/^.//;
759 $line = expand_tabs($line);
760
761 # Pick the indent from the front of the line.
762 my ($white) = ($line =~ /^(\s*)/);
763
764 return (length($line), length($white));
765}
766
Andy Whitcroft773647a2008-03-28 14:15:58 -0700767my $sanitise_quote = '';
768
769sub sanitise_line_reset {
770 my ($in_comment) = @_;
771
772 if ($in_comment) {
773 $sanitise_quote = '*/';
774 } else {
775 $sanitise_quote = '';
776 }
777}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700778sub sanitise_line {
779 my ($line) = @_;
780
781 my $res = '';
782 my $l = '';
783
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800784 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700785 my $off = 0;
786 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700787
Andy Whitcroft773647a2008-03-28 14:15:58 -0700788 # Always copy over the diff marker.
789 $res = substr($line, 0, 1);
790
791 for ($off = 1; $off < length($line); $off++) {
792 $c = substr($line, $off, 1);
793
794 # Comments we are wacking completly including the begin
795 # and end, all to $;.
796 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
797 $sanitise_quote = '*/';
798
799 substr($res, $off, 2, "$;$;");
800 $off++;
801 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800802 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700803 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700804 $sanitise_quote = '';
805 substr($res, $off, 2, "$;$;");
806 $off++;
807 next;
808 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700809 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
810 $sanitise_quote = '//';
811
812 substr($res, $off, 2, $sanitise_quote);
813 $off++;
814 next;
815 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700816
817 # A \ in a string means ignore the next character.
818 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
819 $c eq "\\") {
820 substr($res, $off, 2, 'XX');
821 $off++;
822 next;
823 }
824 # Regular quotes.
825 if ($c eq "'" || $c eq '"') {
826 if ($sanitise_quote eq '') {
827 $sanitise_quote = $c;
828
829 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700830 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700831 } elsif ($sanitise_quote eq $c) {
832 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700833 }
834 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700835
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800836 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700837 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
838 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700839 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
840 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700841 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
842 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700843 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700844 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700845 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800846 }
847
Daniel Walker113f04a2009-09-21 17:04:35 -0700848 if ($sanitise_quote eq '//') {
849 $sanitise_quote = '';
850 }
851
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800852 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700853 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800854 my $clean = 'X' x length($1);
855 $res =~ s@\<.*\>@<$clean>@;
856
857 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700858 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700860 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800861 }
862
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700863 return $res;
864}
865
Joe Perchesa6962d72013-04-29 16:18:13 -0700866sub get_quoted_string {
867 my ($line, $rawline) = @_;
868
869 return "" if ($line !~ m/(\"[X]+\")/g);
870 return substr($rawline, $-[0], $+[0] - $-[0]);
871}
872
Andy Whitcroft8905a672007-11-28 16:21:06 -0800873sub ctx_statement_block {
874 my ($linenr, $remain, $off) = @_;
875 my $line = $linenr - 1;
876 my $blk = '';
877 my $soff = $off;
878 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700879 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800880
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800881 my $loff = 0;
882
Andy Whitcroft8905a672007-11-28 16:21:06 -0800883 my $type = '';
884 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800885 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800886 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800887 my $c;
888 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800889
890 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800891 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800892 @stack = (['', 0]) if ($#stack == -1);
893
Andy Whitcroft773647a2008-03-28 14:15:58 -0700894 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800895 # If we are about to drop off the end, pull in more
896 # context.
897 if ($off >= $len) {
898 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700899 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800900 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800901 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800902 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800903 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800904 $len = length($blk);
905 $line++;
906 last;
907 }
908 # Bail if there is no further context.
909 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800910 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800911 last;
912 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800913 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
914 $level++;
915 $type = '#';
916 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800917 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800918 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800919 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800920 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800921
Andy Whitcroft773647a2008-03-28 14:15:58 -0700922 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800923
924 # Handle nested #if/#else.
925 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
926 push(@stack, [ $type, $level ]);
927 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
928 ($type, $level) = @{$stack[$#stack - 1]};
929 } elsif ($remainder =~ /^#\s*endif\b/) {
930 ($type, $level) = @{pop(@stack)};
931 }
932
Andy Whitcroft8905a672007-11-28 16:21:06 -0800933 # Statement ends at the ';' or a close '}' at the
934 # outermost level.
935 if ($level == 0 && $c eq ';') {
936 last;
937 }
938
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800939 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700940 if ($level == 0 && $coff_set == 0 &&
941 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
942 $remainder =~ /^(else)(?:\s|{)/ &&
943 $remainder !~ /^else\s+if\b/) {
944 $coff = $off + length($1) - 1;
945 $coff_set = 1;
946 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
947 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800948 }
949
Andy Whitcroft8905a672007-11-28 16:21:06 -0800950 if (($type eq '' || $type eq '(') && $c eq '(') {
951 $level++;
952 $type = '(';
953 }
954 if ($type eq '(' && $c eq ')') {
955 $level--;
956 $type = ($level != 0)? '(' : '';
957
958 if ($level == 0 && $coff < $soff) {
959 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700960 $coff_set = 1;
961 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800962 }
963 }
964 if (($type eq '' || $type eq '{') && $c eq '{') {
965 $level++;
966 $type = '{';
967 }
968 if ($type eq '{' && $c eq '}') {
969 $level--;
970 $type = ($level != 0)? '{' : '';
971
972 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700973 if (substr($blk, $off + 1, 1) eq ';') {
974 $off++;
975 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800976 last;
977 }
978 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800979 # Preprocessor commands end at the newline unless escaped.
980 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
981 $level--;
982 $type = '';
983 $off++;
984 last;
985 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800986 $off++;
987 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700988 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800989 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700990 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800991 $line++;
992 $remain--;
993 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800994
995 my $statement = substr($blk, $soff, $off - $soff + 1);
996 my $condition = substr($blk, $soff, $coff - $soff + 1);
997
998 #warn "STATEMENT<$statement>\n";
999 #warn "CONDITION<$condition>\n";
1000
Andy Whitcroft773647a2008-03-28 14:15:58 -07001001 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001002
1003 return ($statement, $condition,
1004 $line, $remain + 1, $off - $loff + 1, $level);
1005}
1006
Andy Whitcroftcf655042008-03-04 14:28:20 -08001007sub statement_lines {
1008 my ($stmt) = @_;
1009
1010 # Strip the diff line prefixes and rip blank lines at start and end.
1011 $stmt =~ s/(^|\n)./$1/g;
1012 $stmt =~ s/^\s*//;
1013 $stmt =~ s/\s*$//;
1014
1015 my @stmt_lines = ($stmt =~ /\n/g);
1016
1017 return $#stmt_lines + 2;
1018}
1019
1020sub statement_rawlines {
1021 my ($stmt) = @_;
1022
1023 my @stmt_lines = ($stmt =~ /\n/g);
1024
1025 return $#stmt_lines + 2;
1026}
1027
1028sub statement_block_size {
1029 my ($stmt) = @_;
1030
1031 $stmt =~ s/(^|\n)./$1/g;
1032 $stmt =~ s/^\s*{//;
1033 $stmt =~ s/}\s*$//;
1034 $stmt =~ s/^\s*//;
1035 $stmt =~ s/\s*$//;
1036
1037 my @stmt_lines = ($stmt =~ /\n/g);
1038 my @stmt_statements = ($stmt =~ /;/g);
1039
1040 my $stmt_lines = $#stmt_lines + 2;
1041 my $stmt_statements = $#stmt_statements + 1;
1042
1043 if ($stmt_lines > $stmt_statements) {
1044 return $stmt_lines;
1045 } else {
1046 return $stmt_statements;
1047 }
1048}
1049
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001050sub ctx_statement_full {
1051 my ($linenr, $remain, $off) = @_;
1052 my ($statement, $condition, $level);
1053
1054 my (@chunks);
1055
Andy Whitcroftcf655042008-03-04 14:28:20 -08001056 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001057 ($statement, $condition, $linenr, $remain, $off, $level) =
1058 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001059 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001060 push(@chunks, [ $condition, $statement ]);
1061 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1062 return ($level, $linenr, @chunks);
1063 }
1064
1065 # Pull in the following conditional/block pairs and see if they
1066 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001067 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001068 ($statement, $condition, $linenr, $remain, $off, $level) =
1069 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001070 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001071 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001072 #print "C: push\n";
1073 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001074 }
1075
1076 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001077}
1078
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001079sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001080 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001081 my $line;
1082 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001083 my $blk = '';
1084 my @o;
1085 my @c;
1086 my @res = ();
1087
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001088 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001089 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001090 for ($line = $start; $remain > 0; $line++) {
1091 next if ($rawlines[$line] =~ /^-/);
1092 $remain--;
1093
1094 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001095
1096 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001097 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001098 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001099 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001100 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001101 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001102 $level = pop(@stack);
1103 }
1104
Andy Whitcroft01464f32010-10-26 14:23:19 -07001105 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001106 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1107 if ($off > 0) {
1108 $off--;
1109 next;
1110 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001111
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001112 if ($c eq $close && $level > 0) {
1113 $level--;
1114 last if ($level == 0);
1115 } elsif ($c eq $open) {
1116 $level++;
1117 }
1118 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001119
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001120 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001121 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001122 }
1123
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001124 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001125 }
1126
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001127 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001128}
1129sub ctx_block_outer {
1130 my ($linenr, $remain) = @_;
1131
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001132 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1133 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001134}
1135sub ctx_block {
1136 my ($linenr, $remain) = @_;
1137
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001138 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1139 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001140}
1141sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001142 my ($linenr, $remain, $off) = @_;
1143
1144 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1145 return @r;
1146}
1147sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001148 my ($linenr, $remain) = @_;
1149
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001150 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001151}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001152sub ctx_statement_level {
1153 my ($linenr, $remain, $off) = @_;
1154
1155 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1156}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001157
1158sub ctx_locate_comment {
1159 my ($first_line, $end_line) = @_;
1160
1161 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001162 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001163 return $current_comment if (defined $current_comment);
1164
1165 # Look through the context and try and figure out if there is a
1166 # comment.
1167 my $in_comment = 0;
1168 $current_comment = '';
1169 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001170 my $line = $rawlines[$linenr - 1];
1171 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001172 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1173 $in_comment = 1;
1174 }
1175 if ($line =~ m@/\*@) {
1176 $in_comment = 1;
1177 }
1178 if (!$in_comment && $current_comment ne '') {
1179 $current_comment = '';
1180 }
1181 $current_comment .= $line . "\n" if ($in_comment);
1182 if ($line =~ m@\*/@) {
1183 $in_comment = 0;
1184 }
1185 }
1186
1187 chomp($current_comment);
1188 return($current_comment);
1189}
1190sub ctx_has_comment {
1191 my ($first_line, $end_line) = @_;
1192 my $cmt = ctx_locate_comment($first_line, $end_line);
1193
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001194 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001195 ##print "CMMT: $cmt\n";
1196
1197 return ($cmt ne '');
1198}
1199
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001200sub raw_line {
1201 my ($linenr, $cnt) = @_;
1202
1203 my $offset = $linenr - 1;
1204 $cnt++;
1205
1206 my $line;
1207 while ($cnt) {
1208 $line = $rawlines[$offset++];
1209 next if (defined($line) && $line =~ /^-/);
1210 $cnt--;
1211 }
1212
1213 return $line;
1214}
1215
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001216sub cat_vet {
1217 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001218 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001219
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001220 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001221 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1222 $res .= $1;
1223 if ($2 ne '') {
1224 $coded = sprintf("^%c", unpack('C', $2) + 64);
1225 $res .= $coded;
1226 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001227 }
1228 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001229
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001230 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001231}
1232
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001233my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001234my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001235my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001236my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001237
1238sub annotate_reset {
1239 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001240 $av_pending = '_';
1241 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001242 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001243}
1244
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001245sub annotate_values {
1246 my ($stream, $type) = @_;
1247
1248 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001249 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001250 my $cur = $stream;
1251
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001252 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001253
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001254 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001255 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001256 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001257 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001258 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001259 print "WS($1)\n" if ($dbg_values > 1);
1260 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001261 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001262 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001263 }
1264
Florian Micklerc023e4732011-01-12 16:59:58 -08001265 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001266 print "CAST($1)\n" if ($dbg_values > 1);
1267 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001268 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001269
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001270 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001271 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001272 $type = 'T';
1273
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001274 } elsif ($cur =~ /^($Modifier)\s*/) {
1275 print "MODIFIER($1)\n" if ($dbg_values > 1);
1276 $type = 'T';
1277
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001278 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001279 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001280 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001281 push(@av_paren_type, $type);
1282 if ($2 ne '') {
1283 $av_pending = 'N';
1284 }
1285 $type = 'E';
1286
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001287 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001288 print "UNDEF($1)\n" if ($dbg_values > 1);
1289 $av_preprocessor = 1;
1290 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001291
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001292 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001293 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001294 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001295
1296 push(@av_paren_type, $type);
1297 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001298 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001299
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001300 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001301 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1302 $av_preprocessor = 1;
1303
1304 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1305
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001306 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001307
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001308 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001309 print "PRE_END($1)\n" if ($dbg_values > 1);
1310
1311 $av_preprocessor = 1;
1312
1313 # Assume all arms of the conditional end as this
1314 # one does, and continue as if the #endif was not here.
1315 pop(@av_paren_type);
1316 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001317 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001318
1319 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001320 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001321
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001322 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1323 print "ATTR($1)\n" if ($dbg_values > 1);
1324 $av_pending = $type;
1325 $type = 'N';
1326
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001327 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001328 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001329 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001330 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001331 }
1332 $type = 'N';
1333
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001334 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001335 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001336 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001337 $type = 'N';
1338
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001339 } elsif ($cur =~/^(case)/o) {
1340 print "CASE($1)\n" if ($dbg_values > 1);
1341 $av_pend_colon = 'C';
1342 $type = 'N';
1343
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001344 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001345 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001346 $type = 'N';
1347
1348 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001349 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001350 push(@av_paren_type, $av_pending);
1351 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001352 $type = 'N';
1353
1354 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001355 my $new_type = pop(@av_paren_type);
1356 if ($new_type ne '_') {
1357 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001358 print "PAREN('$1') -> $type\n"
1359 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001360 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001361 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001362 }
1363
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001364 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001365 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001366 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001367 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001368
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001369 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1370 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001371 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001372 } elsif ($type eq 'E') {
1373 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001374 }
1375 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1376 $type = 'V';
1377
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001378 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001379 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001380 $type = 'V';
1381
1382 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001383 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001384 $type = 'N';
1385
Andy Whitcroftcf655042008-03-04 14:28:20 -08001386 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001387 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001388 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001389 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001390
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001391 } elsif ($cur =~/^(,)/) {
1392 print "COMMA($1)\n" if ($dbg_values > 1);
1393 $type = 'C';
1394
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001395 } elsif ($cur =~ /^(\?)/o) {
1396 print "QUESTION($1)\n" if ($dbg_values > 1);
1397 $type = 'N';
1398
1399 } elsif ($cur =~ /^(:)/o) {
1400 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1401
1402 substr($var, length($res), 1, $av_pend_colon);
1403 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1404 $type = 'E';
1405 } else {
1406 $type = 'N';
1407 }
1408 $av_pend_colon = 'O';
1409
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001410 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001411 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001412 $type = 'N';
1413
Andy Whitcroft0d413862008-10-15 22:02:16 -07001414 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001415 my $variant;
1416
1417 print "OPV($1)\n" if ($dbg_values > 1);
1418 if ($type eq 'V') {
1419 $variant = 'B';
1420 } else {
1421 $variant = 'U';
1422 }
1423
1424 substr($var, length($res), 1, $variant);
1425 $type = 'N';
1426
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001427 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001428 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001429 if ($1 ne '++' && $1 ne '--') {
1430 $type = 'N';
1431 }
1432
1433 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001434 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001435 }
1436 if (defined $1) {
1437 $cur = substr($cur, length($1));
1438 $res .= $type x length($1);
1439 }
1440 }
1441
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001442 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001443}
1444
Andy Whitcroft8905a672007-11-28 16:21:06 -08001445sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001446 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001447 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001448 ^(?:
1449 $Modifier|
1450 $Storage|
1451 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001452 DEFINE_\S+
1453 )$|
1454 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001455 goto|
1456 return|
1457 case|
1458 else|
1459 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001460 do|
1461 \#|
1462 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001463 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001464 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001465 )}x;
1466 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1467 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001468 # Check for modifiers.
1469 $possible =~ s/\s*$Storage\s*//g;
1470 $possible =~ s/\s*$Sparse\s*//g;
1471 if ($possible =~ /^\s*$/) {
1472
1473 } elsif ($possible =~ /\s/) {
1474 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001475 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001476 if ($modifier !~ $notPermitted) {
1477 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1478 push(@modifierList, $modifier);
1479 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001480 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001481
1482 } else {
1483 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1484 push(@typeList, $possible);
1485 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001486 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001487 } else {
1488 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001489 }
1490}
1491
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001492my $prefix = '';
1493
Joe Perches000d1cc12011-07-25 17:13:25 -07001494sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001495 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001496
Joe Perchescbec18a2014-04-03 14:49:19 -07001497 return defined $use_type{$type} if (scalar keys %use_type > 0);
1498
1499 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001500}
1501
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001502sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001503 my ($level, $type, $msg) = @_;
1504
1505 if (!show_type($type) ||
1506 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001507 return 0;
1508 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001509 my $line;
1510 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001511 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001512 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001513 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001514 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001515 $line = (split('\n', $line))[0] . "\n" if ($terse);
1516
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001517 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001518
1519 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001520}
Joe Perchescbec18a2014-04-03 14:49:19 -07001521
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001522sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001523 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001524}
Joe Perches000d1cc12011-07-25 17:13:25 -07001525
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001526sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001527 my ($type, $msg) = @_;
1528
1529 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001530 our $clean = 0;
1531 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001532 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001533 }
Joe Perches3705ce52013-07-03 15:05:31 -07001534 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001535}
1536sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001537 my ($type, $msg) = @_;
1538
1539 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001540 our $clean = 0;
1541 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001542 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001543 }
Joe Perches3705ce52013-07-03 15:05:31 -07001544 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001545}
1546sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001547 my ($type, $msg) = @_;
1548
1549 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001550 our $clean = 0;
1551 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001552 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001553 }
Joe Perches3705ce52013-07-03 15:05:31 -07001554 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001555}
1556
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001557sub check_absolute_file {
1558 my ($absolute, $herecurr) = @_;
1559 my $file = $absolute;
1560
1561 ##print "absolute<$absolute>\n";
1562
1563 # See if any suffix of this path is a path within the tree.
1564 while ($file =~ s@^[^/]*/@@) {
1565 if (-f "$root/$file") {
1566 ##print "file<$file>\n";
1567 last;
1568 }
1569 }
1570 if (! -f _) {
1571 return 0;
1572 }
1573
1574 # It is, so see if the prefix is acceptable.
1575 my $prefix = $absolute;
1576 substr($prefix, -length($file)) = '';
1577
1578 ##print "prefix<$prefix>\n";
1579 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001580 WARN("USE_RELATIVE_PATH",
1581 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001582 }
1583}
1584
Joe Perches3705ce52013-07-03 15:05:31 -07001585sub trim {
1586 my ($string) = @_;
1587
Joe Perchesb34c6482013-09-11 14:24:01 -07001588 $string =~ s/^\s+|\s+$//g;
1589
1590 return $string;
1591}
1592
1593sub ltrim {
1594 my ($string) = @_;
1595
1596 $string =~ s/^\s+//;
1597
1598 return $string;
1599}
1600
1601sub rtrim {
1602 my ($string) = @_;
1603
1604 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001605
1606 return $string;
1607}
1608
Joe Perches52ea8502013-11-12 15:10:09 -08001609sub string_find_replace {
1610 my ($string, $find, $replace) = @_;
1611
1612 $string =~ s/$find/$replace/g;
1613
1614 return $string;
1615}
1616
Joe Perches3705ce52013-07-03 15:05:31 -07001617sub tabify {
1618 my ($leading) = @_;
1619
1620 my $source_indent = 8;
1621 my $max_spaces_before_tab = $source_indent - 1;
1622 my $spaces_to_tab = " " x $source_indent;
1623
1624 #convert leading spaces to tabs
1625 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1626 #Remove spaces before a tab
1627 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1628
1629 return "$leading";
1630}
1631
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001632sub pos_last_openparen {
1633 my ($line) = @_;
1634
1635 my $pos = 0;
1636
1637 my $opens = $line =~ tr/\(/\(/;
1638 my $closes = $line =~ tr/\)/\)/;
1639
1640 my $last_openparen = 0;
1641
1642 if (($opens == 0) || ($closes >= $opens)) {
1643 return -1;
1644 }
1645
1646 my $len = length($line);
1647
1648 for ($pos = 0; $pos < $len; $pos++) {
1649 my $string = substr($line, $pos);
1650 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1651 $pos += length($1) - 1;
1652 } elsif (substr($line, $pos, 1) eq '(') {
1653 $last_openparen = $pos;
1654 } elsif (index($string, '(') == -1) {
1655 last;
1656 }
1657 }
1658
Joe Perches91cb5192014-04-03 14:49:32 -07001659 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001660}
1661
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001662sub process {
1663 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001664
1665 my $linenr=0;
1666 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001667 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001668 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001670
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001671 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001672 my $indent;
1673 my $previndent=0;
1674 my $stashindent=0;
1675
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001676 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001677 my $signoff = 0;
1678 my $is_patch = 0;
1679
Joe Perches29ee1b02014-08-06 16:10:35 -07001680 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001681 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001682 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001683 my $non_utf8_charset = 0;
1684
Joe Perches365dd4e2014-08-06 16:10:42 -07001685 my $last_blank_line = 0;
1686
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001687 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001688 our $cnt_lines = 0;
1689 our $cnt_error = 0;
1690 our $cnt_warn = 0;
1691 our $cnt_chk = 0;
1692
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001693 # Trace the real file/line as we go.
1694 my $realfile = '';
1695 my $realline = 0;
1696 my $realcnt = 0;
1697 my $here = '';
1698 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001699 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001700 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001701 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001702
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001703 my $prev_values = 'E';
1704
1705 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001706 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001707 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001708 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001709 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001710
Joe Perches7e51f192013-09-11 14:23:57 -07001711 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001712
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001713 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001714 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001715 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001716 my @setup_docs = ();
1717 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001718
Joe Perchesd8b07712013-11-12 15:10:06 -08001719 my $camelcase_file_seeded = 0;
1720
Andy Whitcroft773647a2008-03-28 14:15:58 -07001721 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001722 my $line;
1723 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001724 $linenr++;
1725 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001726
Joe Perches3705ce52013-07-03 15:05:31 -07001727 push(@fixed, $rawline) if ($fix);
1728
Andy Whitcroft773647a2008-03-28 14:15:58 -07001729 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001730 $setup_docs = 0;
1731 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1732 $setup_docs = 1;
1733 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001734 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001735 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001736 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1737 $realline=$1-1;
1738 if (defined $2) {
1739 $realcnt=$3+1;
1740 } else {
1741 $realcnt=1+1;
1742 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001743 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001744
1745 # Guestimate if this is a continuing comment. Run
1746 # the context looking for a comment "edge". If this
1747 # edge is a close comment then we must be in a comment
1748 # at context start.
1749 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001750 my $cnt = $realcnt;
1751 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1752 next if (defined $rawlines[$ln - 1] &&
1753 $rawlines[$ln - 1] =~ /^-/);
1754 $cnt--;
1755 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001756 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001757 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1758 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1759 ($edge) = $1;
1760 last;
1761 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001762 }
1763 if (defined $edge && $edge eq '*/') {
1764 $in_comment = 1;
1765 }
1766
1767 # Guestimate if this is a continuing comment. If this
1768 # is the start of a diff block and this line starts
1769 # ' *' then it is very likely a comment.
1770 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001771 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001772 {
1773 $in_comment = 1;
1774 }
1775
1776 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1777 sanitise_line_reset($in_comment);
1778
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001779 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001780 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001781 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001782 $line = sanitise_line($rawline);
1783 }
1784 push(@lines, $line);
1785
1786 if ($realcnt > 1) {
1787 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1788 } else {
1789 $realcnt = 0;
1790 }
1791
1792 #print "==>$rawline\n";
1793 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001794
1795 if ($setup_docs && $line =~ /^\+/) {
1796 push(@setup_docs, $line);
1797 }
1798 }
1799
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001800 $prefix = '';
1801
Andy Whitcroft773647a2008-03-28 14:15:58 -07001802 $realcnt = 0;
1803 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001804 foreach my $line (@lines) {
1805 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001806 my $sline = $line; #copy of $line
1807 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001808
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001809 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001810
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001811#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001812 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001813 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001814 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001815 $realline=$1-1;
1816 if (defined $2) {
1817 $realcnt=$3+1;
1818 } else {
1819 $realcnt=1+1;
1820 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001821 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001822 $prev_values = 'E';
1823
Andy Whitcroft773647a2008-03-28 14:15:58 -07001824 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001825 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001826 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001827 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001828 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001829
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001830# track the line number as we move through the hunk, note that
1831# new versions of GNU diff omit the leading space on completely
1832# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001833 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001834 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001835 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001836
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001837 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001838 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001839
1840 # Track the previous line.
1841 ($prevline, $stashline) = ($stashline, $line);
1842 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001843 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1844
Andy Whitcroft773647a2008-03-28 14:15:58 -07001845 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001846
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001847 } elsif ($realcnt == 1) {
1848 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001849 }
1850
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001851 my $hunk_line = ($realcnt != 0);
1852
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001853#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001854 $prefix = "$filename:$realline: " if ($emacs && $file);
1855 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1856
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001857 $here = "#$linenr: " if (!$file);
1858 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001859
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001860 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001861 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001862 if ($line =~ /^diff --git.*?(\S+)$/) {
1863 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001864 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001865 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001866 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001867 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001868 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001869 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001870 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001871
1872 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001873 if (!$file && $tree && $p1_prefix ne '' &&
1874 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001875 WARN("PATCH_PREFIX",
1876 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001877 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001878
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001879 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001880 ERROR("MODIFIED_INCLUDE_ASM",
1881 "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 -07001882 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001883 $found_file = 1;
1884 }
1885
1886 if ($found_file) {
1887 if ($realfile =~ m@^(drivers/net/|net/)@) {
1888 $check = 1;
1889 } else {
1890 $check = $check_orig;
1891 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001892 next;
1893 }
1894
Randy Dunlap389834b2007-06-08 13:47:03 -07001895 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001896
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001897 my $hereline = "$here\n$rawline\n";
1898 my $herecurr = "$here\n$rawline\n";
1899 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001900
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001901 $cnt_lines++ if ($realcnt != 0);
1902
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001903# Check for incorrect file permissions
1904 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1905 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001906 if ($realfile !~ m@scripts/@ &&
1907 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001908 ERROR("EXECUTE_PERMISSIONS",
1909 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001910 }
1911 }
1912
Joe Perches20112472011-07-25 17:13:23 -07001913# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001914 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001915 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001916 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001917 }
1918
1919# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001920 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001921 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001922 my $space_before = $1;
1923 my $sign_off = $2;
1924 my $space_after = $3;
1925 my $email = $4;
1926 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1927
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001928 if ($sign_off !~ /$signature_tags/) {
1929 WARN("BAD_SIGN_OFF",
1930 "Non-standard signature: $sign_off\n" . $herecurr);
1931 }
Joe Perches20112472011-07-25 17:13:23 -07001932 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001933 if (WARN("BAD_SIGN_OFF",
1934 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1935 $fix) {
1936 $fixed[$linenr - 1] =
1937 "$ucfirst_sign_off $email";
1938 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001939 }
Joe Perches20112472011-07-25 17:13:23 -07001940 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001941 if (WARN("BAD_SIGN_OFF",
1942 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1943 $fix) {
1944 $fixed[$linenr - 1] =
1945 "$ucfirst_sign_off $email";
1946 }
1947
Joe Perches20112472011-07-25 17:13:23 -07001948 }
1949 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001950 if (WARN("BAD_SIGN_OFF",
1951 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1952 $fix) {
1953 $fixed[$linenr - 1] =
1954 "$ucfirst_sign_off $email";
1955 }
Joe Perches20112472011-07-25 17:13:23 -07001956 }
1957
1958 my ($email_name, $email_address, $comment) = parse_email($email);
1959 my $suggested_email = format_email(($email_name, $email_address));
1960 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001961 ERROR("BAD_SIGN_OFF",
1962 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001963 } else {
1964 my $dequoted = $suggested_email;
1965 $dequoted =~ s/^"//;
1966 $dequoted =~ s/" </ </;
1967 # Don't force email to have quotes
1968 # Allow just an angle bracketed address
1969 if ("$dequoted$comment" ne $email &&
1970 "<$email_address>$comment" ne $email &&
1971 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001972 WARN("BAD_SIGN_OFF",
1973 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001974 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001975 }
Joe Perches7e51f192013-09-11 14:23:57 -07001976
1977# Check for duplicate signatures
1978 my $sig_nospace = $line;
1979 $sig_nospace =~ s/\s//g;
1980 $sig_nospace = lc($sig_nospace);
1981 if (defined $signatures{$sig_nospace}) {
1982 WARN("BAD_SIGN_OFF",
1983 "Duplicate signature\n" . $herecurr);
1984 } else {
1985 $signatures{$sig_nospace} = 1;
1986 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001987 }
1988
Joe Perches9b3189eb2014-06-04 16:12:10 -07001989# Check for old stable address
1990 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
1991 ERROR("STABLE_ADDRESS",
1992 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
1993 }
1994
Christopher Covington7ebd05e2014-04-03 14:49:31 -07001995# Check for unwanted Gerrit info
1996 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1997 ERROR("GERRIT_CHANGE_ID",
1998 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
1999 }
2000
Joe Perchesd311cd42014-08-06 16:10:57 -07002001# Check for improperly formed commit descriptions
2002 if ($in_commit_log &&
2003 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
2004 $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) {
2005 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2006 my $init_char = $1;
2007 my $orig_commit = lc($2);
2008 my $id = '01234567890ab';
2009 my $desc = 'commit description';
2010 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2011 ERROR("GIT_COMMIT_ID",
2012 "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2013 }
2014
Joe Perches13f19372014-08-06 16:10:59 -07002015# Check for added, moved or deleted files
2016 if (!$reported_maintainer_file && !$in_commit_log &&
2017 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2018 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2019 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2020 (defined($1) || defined($2))))) {
2021 $reported_maintainer_file = 1;
2022 WARN("FILE_PATH_CHANGES",
2023 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2024 }
2025
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002026# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002027 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002028 ERROR("CORRUPTED_PATCH",
2029 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002030 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002031 }
2032
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002033# Check for absolute kernel paths.
2034 if ($tree) {
2035 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2036 my $file = $1;
2037
2038 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2039 check_absolute_file($1, $herecurr)) {
2040 #
2041 } else {
2042 check_absolute_file($file, $herecurr);
2043 }
2044 }
2045 }
2046
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002047# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2048 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002049 $rawline !~ m/^$UTF8*$/) {
2050 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2051
2052 my $blank = copy_spacing($rawline);
2053 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2054 my $hereptr = "$hereline$ptr\n";
2055
Joe Perches34d99212011-07-25 17:13:26 -07002056 CHK("INVALID_UTF8",
2057 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002058 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002059
Joe Perches15662b32011-10-31 17:13:12 -07002060# Check if it's the start of a commit log
2061# (not a header line and we haven't seen the patch filename)
2062 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002063 !($rawline =~ /^\s+\S/ ||
2064 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002065 $in_header_lines = 0;
2066 $in_commit_log = 1;
2067 }
2068
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002069# Check if there is UTF-8 in a commit log when a mail header has explicitly
2070# declined it, i.e defined some charset where it is missing.
2071 if ($in_header_lines &&
2072 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2073 $1 !~ /utf-8/i) {
2074 $non_utf8_charset = 1;
2075 }
2076
2077 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002078 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002079 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002080 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2081 }
2082
Andy Whitcroft306708542008-10-15 22:02:28 -07002083# ignore non-hunk lines and lines being removed
2084 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002085
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002086#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002087 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002088 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002089 if (ERROR("DOS_LINE_ENDINGS",
2090 "DOS line endings\n" . $herevet) &&
2091 $fix) {
2092 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2093 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002094 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2095 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002096 if (ERROR("TRAILING_WHITESPACE",
2097 "trailing whitespace\n" . $herevet) &&
2098 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002099 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002100 }
2101
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002102 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002103 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002104
Josh Triplett4783f892013-11-12 15:10:12 -08002105# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002106 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002107 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2108 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002109 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2110 my $msg_type = \&ERROR;
2111 $msg_type = \&CHK if ($file);
2112 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002113 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
Josh Triplett4783f892013-11-12 15:10:12 -08002114 }
2115
Andi Kleen33549572010-05-24 14:33:29 -07002116# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002117# Only applies when adding the entry originally, after that we do not have
2118# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002119 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002120 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002121 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002122 my $cnt = $realcnt;
2123 my $ln = $linenr + 1;
2124 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002125 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002126 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002127 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002128 $f = $lines[$ln - 1];
2129 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2130 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002131
2132 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002133 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002134
Joe Perches8d73e0e2014-08-06 16:10:46 -07002135 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002136 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002137 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002138 $length = -1;
2139 }
2140
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002141 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002142 $f =~ s/#.*//;
2143 $f =~ s/^\s+//;
2144 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002145 if ($f =~ /^\s*config\s/) {
2146 $is_end = 1;
2147 last;
2148 }
Andi Kleen33549572010-05-24 14:33:29 -07002149 $length++;
2150 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002151 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002152 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2153 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002154 }
2155
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002156# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2157 if ($realfile =~ /Kconfig/ &&
2158 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2159 WARN("CONFIG_EXPERIMENTAL",
2160 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2161 }
2162
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002163 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2164 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2165 my $flag = $1;
2166 my $replacement = {
2167 'EXTRA_AFLAGS' => 'asflags-y',
2168 'EXTRA_CFLAGS' => 'ccflags-y',
2169 'EXTRA_CPPFLAGS' => 'cppflags-y',
2170 'EXTRA_LDFLAGS' => 'ldflags-y',
2171 };
2172
2173 WARN("DEPRECATED_VARIABLE",
2174 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2175 }
2176
Rob Herringbff5da42014-01-23 15:54:51 -08002177# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002178 if (defined $root &&
2179 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2180 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2181
Rob Herringbff5da42014-01-23 15:54:51 -08002182 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2183
Florian Vaussardcc933192014-04-03 14:49:27 -07002184 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2185 my $vp_file = $dt_path . "vendor-prefixes.txt";
2186
Rob Herringbff5da42014-01-23 15:54:51 -08002187 foreach my $compat (@compats) {
2188 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002189 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2190 my $compat3 = $compat;
2191 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2192 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002193 if ( $? >> 8 ) {
2194 WARN("UNDOCUMENTED_DT_STRING",
2195 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2196 }
2197
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002198 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2199 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002200 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002201 if ( $? >> 8 ) {
2202 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002203 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002204 }
2205 }
2206 }
2207
Andy Whitcroft5368df202008-10-15 22:02:27 -07002208# check we are in a valid source file if not then ignore this hunk
2209 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2210
Joe Perches6cd7f382012-12-17 16:01:54 -08002211#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002212 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002213 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002214 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002215 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002216 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002217 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002218 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002219 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002220 }
2221
Josh Triplettca56dc02012-03-23 15:02:21 -07002222# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002223# to grep for the string. Make exceptions when the previous string ends in a
2224# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2225# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002226 if ($line =~ /^\+\s*"/ &&
2227 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002228 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002229 WARN("SPLIT_STRING",
2230 "quoted string split across lines\n" . $hereprev);
2231 }
2232
Joe Perches5e79d962010-03-05 13:43:55 -08002233# check for spaces before a quoted newline
2234 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002235 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2236 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2237 $fix) {
2238 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2239 }
2240
Joe Perches5e79d962010-03-05 13:43:55 -08002241 }
2242
Andy Whitcroft8905a672007-11-28 16:21:06 -08002243# check for adding lines without a newline.
2244 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002245 WARN("MISSING_EOF_NEWLINE",
2246 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002247 }
2248
Mike Frysinger42e41c52009-09-21 17:04:40 -07002249# Blackfin: use hi/lo macros
2250 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2251 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2252 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002253 ERROR("LO_MACRO",
2254 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002255 }
2256 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2257 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002258 ERROR("HI_MACRO",
2259 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002260 }
2261 }
2262
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002263# check we are in a valid source file C or perl if not then ignore this hunk
2264 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002265
2266# at the beginning of a line any tabs must come first and anything
2267# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002268 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2269 $rawline =~ /^\+\s* \s*/) {
2270 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002271 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002272 if (ERROR("CODE_INDENT",
2273 "code indent should use tabs where possible\n" . $herevet) &&
2274 $fix) {
2275 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2276 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002277 }
2278
Alberto Panizzo08e44362010-03-05 13:43:54 -08002279# check for space before tabs.
2280 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2281 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002282 if (WARN("SPACE_BEFORE_TAB",
2283 "please, no space before tabs\n" . $herevet) &&
2284 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002285 while ($fixed[$linenr - 1] =~
2286 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2287 while ($fixed[$linenr - 1] =~
2288 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002289 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002290 }
2291
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002292# check for && or || at the start of a line
2293 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2294 CHK("LOGICAL_CONTINUATIONS",
2295 "Logical continuations should be on the previous line\n" . $hereprev);
2296 }
2297
2298# check multi-line statement indentation matches previous line
2299 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002300 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002301 $prevline =~ /^\+(\t*)(.*)$/;
2302 my $oldindent = $1;
2303 my $rest = $2;
2304
2305 my $pos = pos_last_openparen($rest);
2306 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002307 $line =~ /^(\+| )([ \t]*)/;
2308 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002309
2310 my $goodtabindent = $oldindent .
2311 "\t" x ($pos / 8) .
2312 " " x ($pos % 8);
2313 my $goodspaceindent = $oldindent . " " x $pos;
2314
2315 if ($newindent ne $goodtabindent &&
2316 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002317
2318 if (CHK("PARENTHESIS_ALIGNMENT",
2319 "Alignment should match open parenthesis\n" . $hereprev) &&
2320 $fix && $line =~ /^\+/) {
2321 $fixed[$linenr - 1] =~
2322 s/^\+[ \t]*/\+$goodtabindent/;
2323 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002324 }
2325 }
2326 }
2327
Joe Perchesf27c95d2014-08-06 16:10:52 -07002328 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002329 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002330 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002331 $fix) {
2332 $fixed[$linenr - 1] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002333 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002334 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002335 }
2336
Joe Perches05880602012-10-04 17:13:35 -07002337 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002338 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002339 $rawline =~ /^\+[ \t]*\*/ &&
2340 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002341 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2342 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2343 }
2344
2345 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002346 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2347 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002348 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002349 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2350 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2351 "networking block comments start with * on subsequent lines\n" . $hereprev);
2352 }
2353
2354 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002355 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2356 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2357 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2358 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002359 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2360 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2361 }
2362
Joe Perches7f619192014-08-06 16:10:39 -07002363# check for missing blank lines after struct/union declarations
2364# with exceptions for various attributes and macros
2365 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2366 $line =~ /^\+/ &&
2367 !($line =~ /^\+\s*$/ ||
2368 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2369 $line =~ /^\+\s*MODULE_/i ||
2370 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2371 $line =~ /^\+[a-z_]*init/ ||
2372 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2373 $line =~ /^\+\s*DECLARE/ ||
2374 $line =~ /^\+\s*__setup/)) {
2375 CHK("LINE_SPACING",
2376 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev);
2377 }
2378
Joe Perches365dd4e2014-08-06 16:10:42 -07002379# check for multiple consecutive blank lines
2380 if ($prevline =~ /^[\+ ]\s*$/ &&
2381 $line =~ /^\+\s*$/ &&
2382 $last_blank_line != ($linenr - 1)) {
2383 CHK("LINE_SPACING",
2384 "Please don't use multiple blank lines\n" . $hereprev);
2385 $last_blank_line = $linenr;
2386 }
2387
Joe Perches3b617e32014-04-03 14:49:28 -07002388# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002389 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2390 # actual declarations
2391 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002392 # function pointer declarations
2393 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002394 # foo bar; where foo is some local typedef or #define
2395 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2396 # known declaration macros
2397 $prevline =~ /^\+\s+$declaration_macros/) &&
2398 # for "else if" which can look like "$Ident $Ident"
2399 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2400 # other possible extensions of declaration lines
2401 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2402 # not starting a section or a macro "\" extended line
2403 $prevline =~ /(?:\{\s*|\\)$/) &&
2404 # looks like a declaration
2405 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002406 # function pointer declarations
2407 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002408 # foo bar; where foo is some local typedef or #define
2409 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2410 # known declaration macros
2411 $sline =~ /^\+\s+$declaration_macros/ ||
2412 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002413 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002414 # start or end of block or continuation of declaration
2415 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2416 # bitfield continuation
2417 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2418 # other possible extensions of declaration lines
2419 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2420 # indentation of previous and current line are the same
2421 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesfee0aa82014-08-06 16:10:44 -07002422 WARN("LINE_SPACING",
Joe Perches3f7bac02014-06-04 16:12:04 -07002423 "Missing a blank line after declarations\n" . $hereprev);
Joe Perches3b617e32014-04-03 14:49:28 -07002424 }
2425
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002426# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002427# Exceptions:
2428# 1) within comments
2429# 2) indented preprocessor commands
2430# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002431 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002432 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002433 if (WARN("LEADING_SPACE",
2434 "please, no spaces at the start of a line\n" . $herevet) &&
2435 $fix) {
2436 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2437 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002438 }
2439
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002440# check we are in a valid C source file if not then ignore this hunk
2441 next if ($realfile !~ /\.(h|c)$/);
2442
Joe Perches032a4c02014-08-06 16:10:29 -07002443# check indentation of any line with a bare else
2444# if the previous line is a break or return and is indented 1 tab more...
2445 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2446 my $tabs = length($1) + 1;
2447 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2448 WARN("UNNECESSARY_ELSE",
2449 "else is not generally useful after a break or return\n" . $hereprev);
2450 }
2451 }
2452
Joe Perchesc00df192014-08-06 16:11:01 -07002453# check indentation of a line with a break;
2454# if the previous line is a goto or return and is indented the same # of tabs
2455 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2456 my $tabs = $1;
2457 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2458 WARN("UNNECESSARY_BREAK",
2459 "break is not useful after a goto or return\n" . $hereprev);
2460 }
2461 }
2462
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002463# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2464 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2465 WARN("CONFIG_EXPERIMENTAL",
2466 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2467 }
2468
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002469# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002470 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002471 WARN("CVS_KEYWORD",
2472 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002473 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002474
Mike Frysinger42e41c52009-09-21 17:04:40 -07002475# Blackfin: don't use __builtin_bfin_[cs]sync
2476 if ($line =~ /__builtin_bfin_csync/) {
2477 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002478 ERROR("CSYNC",
2479 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002480 }
2481 if ($line =~ /__builtin_bfin_ssync/) {
2482 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002483 ERROR("SSYNC",
2484 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002485 }
2486
Joe Perches56e77d72013-02-21 16:44:14 -08002487# check for old HOTPLUG __dev<foo> section markings
2488 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2489 WARN("HOTPLUG_SECTION",
2490 "Using $1 is unnecessary\n" . $herecurr);
2491 }
2492
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002493# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002494 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2495 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002496#print "LINE<$line>\n";
2497 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002498 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002499 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002500 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002501 $stat =~ s/\n./\n /g;
2502 $cond =~ s/\n./\n /g;
2503
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002504#print "linenr<$linenr> <$stat>\n";
2505 # If this statement has no statement boundaries within
2506 # it there is no point in retrying a statement scan
2507 # until we hit end of it.
2508 my $frag = $stat; $frag =~ s/;+\s*$//;
2509 if ($frag !~ /(?:{|;)/) {
2510#print "skip<$line_nr_next>\n";
2511 $suppress_statement = $line_nr_next;
2512 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002513
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002514 # Find the real next line.
2515 $realline_next = $line_nr_next;
2516 if (defined $realline_next &&
2517 (!defined $lines[$realline_next - 1] ||
2518 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2519 $realline_next++;
2520 }
2521
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002522 my $s = $stat;
2523 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002524
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002525 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002526 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002527
2528 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002529 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002530
Andy Whitcroft463f2862009-09-21 17:04:34 -07002531 } elsif ($s =~ /^.\s*else\b/s) {
2532
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002533 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002534 } 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 -07002535 my $type = $1;
2536 $type =~ s/\s+/ /g;
2537 possible($type, "A:" . $s);
2538
Andy Whitcroft8905a672007-11-28 16:21:06 -08002539 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002540 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002541 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002542 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002543
2544 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002545 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002546 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002547 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002548
2549 # Check for any sort of function declaration.
2550 # int foo(something bar, other baz);
2551 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002552 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 -08002553 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002554
Andy Whitcroftcf655042008-03-04 14:28:20 -08002555 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002556 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002557 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002558
Andy Whitcroft8905a672007-11-28 16:21:06 -08002559 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002560 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002561
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002562 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002563 }
2564 }
2565 }
2566
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002567 }
2568
Andy Whitcroft653d4872007-06-23 17:16:34 -07002569#
2570# Checks which may be anchored in the context.
2571#
2572
2573# Check for switch () and associated case and default
2574# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002575 if ($line=~/\bswitch\s*\(.*\)/) {
2576 my $err = '';
2577 my $sep = '';
2578 my @ctx = ctx_block_outer($linenr, $realcnt);
2579 shift(@ctx);
2580 for my $ctx (@ctx) {
2581 my ($clen, $cindent) = line_stats($ctx);
2582 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2583 $indent != $cindent) {
2584 $err .= "$sep$ctx\n";
2585 $sep = '';
2586 } else {
2587 $sep = "[...]\n";
2588 }
2589 }
2590 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002591 ERROR("SWITCH_CASE_INDENT_LEVEL",
2592 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002593 }
2594 }
2595
2596# if/while/etc brace do not go on next line, unless defining a do while loop,
2597# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002598 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002599 my $pre_ctx = "$1$2";
2600
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002601 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002602
2603 if ($line =~ /^\+\t{6,}/) {
2604 WARN("DEEP_INDENTATION",
2605 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2606 }
2607
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002608 my $ctx_cnt = $realcnt - $#ctx - 1;
2609 my $ctx = join("\n", @ctx);
2610
Andy Whitcroft548596d2008-07-23 21:29:01 -07002611 my $ctx_ln = $linenr;
2612 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002613
Andy Whitcroft548596d2008-07-23 21:29:01 -07002614 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2615 defined $lines[$ctx_ln - 1] &&
2616 $lines[$ctx_ln - 1] =~ /^-/)) {
2617 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2618 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002619 $ctx_ln++;
2620 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002621
Andy Whitcroft53210162008-07-23 21:29:03 -07002622 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2623 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002624
2625 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002626 ERROR("OPEN_BRACE",
2627 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002628 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002629 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002630 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2631 $ctx =~ /\)\s*\;\s*$/ &&
2632 defined $lines[$ctx_ln - 1])
2633 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002634 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2635 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002636 WARN("TRAILING_SEMICOLON",
2637 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002638 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002639 }
2640 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002641 }
2642
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002643# Check relative indent for conditionals and blocks.
2644 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002645 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2646 ctx_statement_block($linenr, $realcnt, 0)
2647 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002648 my ($s, $c) = ($stat, $cond);
2649
2650 substr($s, 0, length($c), '');
2651
2652 # Make sure we remove the line prefixes as we have
2653 # none on the first line, and are going to readd them
2654 # where necessary.
2655 $s =~ s/\n./\n/gs;
2656
2657 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002658 my @newlines = ($c =~ /\n/gs);
2659 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002660
2661 # We want to check the first line inside the block
2662 # starting at the end of the conditional, so remove:
2663 # 1) any blank line termination
2664 # 2) any opening brace { on end of the line
2665 # 3) any do (...) {
2666 my $continuation = 0;
2667 my $check = 0;
2668 $s =~ s/^.*\bdo\b//;
2669 $s =~ s/^\s*{//;
2670 if ($s =~ s/^\s*\\//) {
2671 $continuation = 1;
2672 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002673 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002674 $check = 1;
2675 $cond_lines++;
2676 }
2677
2678 # Also ignore a loop construct at the end of a
2679 # preprocessor statement.
2680 if (($prevline =~ /^.\s*#\s*define\s/ ||
2681 $prevline =~ /\\\s*$/) && $continuation == 0) {
2682 $check = 0;
2683 }
2684
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002685 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002686 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002687 while ($cond_ptr != $cond_lines) {
2688 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002689
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002690 # If we see an #else/#elif then the code
2691 # is not linear.
2692 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2693 $check = 0;
2694 }
2695
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002696 # Ignore:
2697 # 1) blank lines, they should be at 0,
2698 # 2) preprocessor lines, and
2699 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002700 if ($continuation ||
2701 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002702 $s =~ /^\s*#\s*?/ ||
2703 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002704 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002705 if ($s =~ s/^.*?\n//) {
2706 $cond_lines++;
2707 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002708 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002709 }
2710
2711 my (undef, $sindent) = line_stats("+" . $s);
2712 my $stat_real = raw_line($linenr, $cond_lines);
2713
2714 # Check if either of these lines are modified, else
2715 # this is not this patch's fault.
2716 if (!defined($stat_real) ||
2717 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2718 $check = 0;
2719 }
2720 if (defined($stat_real) && $cond_lines > 1) {
2721 $stat_real = "[...]\n$stat_real";
2722 }
2723
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002724 #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 -07002725
2726 if ($check && (($sindent % 8) != 0 ||
2727 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002728 WARN("SUSPECT_CODE_INDENT",
2729 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002730 }
2731 }
2732
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002733 # Track the 'values' across context and added lines.
2734 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002735 my ($curr_values, $curr_vars) =
2736 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002737 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002738 if ($dbg_values) {
2739 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002740 print "$linenr > .$outline\n";
2741 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002742 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002743 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002744 $prev_values = substr($curr_values, -1);
2745
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002746#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002747 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002748
Andy Whitcroft653d4872007-06-23 17:16:34 -07002749# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002750 if ($dbg_type) {
2751 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002752 ERROR("TEST_TYPE",
2753 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002754 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002755 ERROR("TEST_NOT_TYPE",
2756 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002757 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002758 next;
2759 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002760# TEST: allow direct testing of the attribute matcher.
2761 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002762 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002763 ERROR("TEST_ATTR",
2764 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002765 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002766 ERROR("TEST_NOT_ATTR",
2767 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002768 }
2769 next;
2770 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002771
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002772# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002773 if ($line =~ /^.\s*{/ &&
2774 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002775 ERROR("OPEN_BRACE",
2776 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002777 }
2778
Andy Whitcroft653d4872007-06-23 17:16:34 -07002779#
2780# Checks which are anchored on the added line.
2781#
2782
2783# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002784 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002785 my $path = $1;
2786 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002787 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002788 "malformed #include filename\n" . $herecurr);
2789 }
2790 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2791 ERROR("UAPI_INCLUDE",
2792 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002793 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002794 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002795
2796# no C99 // comments
2797 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002798 if (ERROR("C99_COMMENTS",
2799 "do not use C99 // comments\n" . $herecurr) &&
2800 $fix) {
2801 my $line = $fixed[$linenr - 1];
2802 if ($line =~ /\/\/(.*)$/) {
2803 my $comment = trim($1);
2804 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2805 }
2806 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002807 }
2808 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002809 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002810 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002811
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002812# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2813# the whole statement.
2814#print "APW <$lines[$realline_next - 1]>\n";
2815 if (defined $realline_next &&
2816 exists $lines[$realline_next - 1] &&
2817 !defined $suppress_export{$realline_next} &&
2818 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2819 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002820 # Handle definitions which produce identifiers with
2821 # a prefix:
2822 # XXX(foo);
2823 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002824 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002825 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002826 $name =~ /^${Ident}_$2/) {
2827#print "FOO C name<$name>\n";
2828 $suppress_export{$realline_next} = 1;
2829
2830 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002831 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002832 ^.DEFINE_$Ident\(\Q$name\E\)|
2833 ^.DECLARE_$Ident\(\Q$name\E\)|
2834 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002835 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2836 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002837 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002838#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2839 $suppress_export{$realline_next} = 2;
2840 } else {
2841 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002842 }
2843 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002844 if (!defined $suppress_export{$linenr} &&
2845 $prevline =~ /^.\s*$/ &&
2846 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2847 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2848#print "FOO B <$lines[$linenr - 1]>\n";
2849 $suppress_export{$linenr} = 2;
2850 }
2851 if (defined $suppress_export{$linenr} &&
2852 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002853 WARN("EXPORT_SYMBOL",
2854 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002855 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002856
Joe Eloff5150bda2010-08-09 17:21:00 -07002857# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002858 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2859 if (ERROR("GLOBAL_INITIALISERS",
2860 "do not initialise globals to 0 or NULL\n" .
2861 $herecurr) &&
2862 $fix) {
2863 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2864 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002865 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002866# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002867 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2868 if (ERROR("INITIALISED_STATIC",
2869 "do not initialise statics to 0 or NULL\n" .
2870 $herecurr) &&
2871 $fix) {
2872 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2873 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002874 }
2875
Joe Perchescb710ec2010-10-26 14:23:20 -07002876# check for static const char * arrays.
2877 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002878 WARN("STATIC_CONST_CHAR_ARRAY",
2879 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002880 $herecurr);
2881 }
2882
2883# check for static char foo[] = "bar" declarations.
2884 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002885 WARN("STATIC_CONST_CHAR_ARRAY",
2886 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002887 $herecurr);
2888 }
2889
Joe Perches9b0fa602014-04-03 14:49:18 -07002890# check for non-global char *foo[] = {"bar", ...} declarations.
2891 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2892 WARN("STATIC_CONST_CHAR_ARRAY",
2893 "char * array declaration might be better as static const\n" .
2894 $herecurr);
2895 }
2896
Joe Perchesb36190c2014-01-27 17:07:18 -08002897# check for function declarations without arguments like "int foo()"
2898 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2899 if (ERROR("FUNCTION_WITHOUT_ARGS",
2900 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2901 $fix) {
2902 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2903 }
2904 }
2905
Joe Perches92e112f2013-12-13 11:36:22 -07002906# check for uses of DEFINE_PCI_DEVICE_TABLE
2907 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2908 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2909 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2910 $fix) {
2911 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2912 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002913 }
2914
Andy Whitcroft653d4872007-06-23 17:16:34 -07002915# check for new typedefs, only function parameters and sparse annotations
2916# make sense.
2917 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002918 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002919 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002920 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002921 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002922 WARN("NEW_TYPEDEFS",
2923 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002924 }
2925
2926# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002927 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002928 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2929 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002930 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002931
Andy Whitcroft65863862009-01-06 14:41:21 -08002932 # Should start with a space.
2933 $to =~ s/^(\S)/ $1/;
2934 # Should not end with a space.
2935 $to =~ s/\s+$//;
2936 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002937 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002938 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002939
Joe Perches3705ce52013-07-03 15:05:31 -07002940## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002941 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002942 if (ERROR("POINTER_LOCATION",
2943 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2944 $fix) {
2945 my $sub_from = $ident;
2946 my $sub_to = $ident;
2947 $sub_to =~ s/\Q$from\E/$to/;
2948 $fixed[$linenr - 1] =~
2949 s@\Q$sub_from\E@$sub_to@;
2950 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002951 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002952 }
2953 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2954 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002955 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002956
Andy Whitcroft65863862009-01-06 14:41:21 -08002957 # Should start with a space.
2958 $to =~ s/^(\S)/ $1/;
2959 # Should not end with a space.
2960 $to =~ s/\s+$//;
2961 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002962 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002963 }
2964 # Modifiers should have spaces.
2965 $to =~ s/(\b$Modifier$)/$1 /;
2966
Joe Perches3705ce52013-07-03 15:05:31 -07002967## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002968 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002969 if (ERROR("POINTER_LOCATION",
2970 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2971 $fix) {
2972
2973 my $sub_from = $match;
2974 my $sub_to = $match;
2975 $sub_to =~ s/\Q$from\E/$to/;
2976 $fixed[$linenr - 1] =~
2977 s@\Q$sub_from\E@$sub_to@;
2978 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002979 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002980 }
2981
2982# # no BUG() or BUG_ON()
2983# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2984# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2985# print "$herecurr";
2986# $clean = 0;
2987# }
2988
Andy Whitcroft8905a672007-11-28 16:21:06 -08002989 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002990 WARN("LINUX_VERSION_CODE",
2991 "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 -08002992 }
2993
Joe Perches17441222011-06-15 15:08:17 -07002994# check for uses of printk_ratelimit
2995 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002996 WARN("PRINTK_RATELIMITED",
2997"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002998 }
2999
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003000# printk should use KERN_* levels. Note that follow on printk's on the
3001# same line do not need a level, so we use the current block context
3002# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003003# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003004# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003005 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003006 my $ok = 0;
3007 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3008 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003009 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003010 # with "\n" ignore it, else it is to blame
3011 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3012 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3013 $ok = 1;
3014 }
3015 last;
3016 }
3017 }
3018 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003019 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3020 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003021 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003022 }
3023
Joe Perches243f3802012-05-31 16:26:09 -07003024 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3025 my $orig = $1;
3026 my $level = lc($orig);
3027 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003028 my $level2 = $level;
3029 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003030 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003031 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07003032 }
3033
3034 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003035 if (WARN("PREFER_PR_LEVEL",
3036 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3037 $fix) {
3038 $fixed[$linenr - 1] =~
3039 s/\bpr_warning\b/pr_warn/;
3040 }
Joe Perches243f3802012-05-31 16:26:09 -07003041 }
3042
Joe Perchesdc139312013-02-21 16:44:13 -08003043 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3044 my $orig = $1;
3045 my $level = lc($orig);
3046 $level = "warn" if ($level eq "warning");
3047 $level = "dbg" if ($level eq "debug");
3048 WARN("PREFER_DEV_LEVEL",
3049 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3050 }
3051
Andy Whitcroft653d4872007-06-23 17:16:34 -07003052# function brace can't be on same line, except for #defines of do while,
3053# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003054 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
3055 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003056 ERROR("OPEN_BRACE",
3057 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003058 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003059
Andy Whitcroft8905a672007-11-28 16:21:06 -08003060# open braces for enum, union and struct go on the same line.
3061 if ($line =~ /^.\s*{/ &&
3062 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003063 ERROR("OPEN_BRACE",
3064 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003065 }
3066
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003067# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003068 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3069 if (WARN("SPACING",
3070 "missing space after $1 definition\n" . $herecurr) &&
3071 $fix) {
3072 $fixed[$linenr - 1] =~
3073 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3074 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003075 }
3076
Joe Perches31070b52014-01-23 15:54:49 -08003077# Function pointer declarations
3078# check spacing between type, funcptr, and args
3079# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003080 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003081 my $declare = $1;
3082 my $pre_pointer_space = $2;
3083 my $post_pointer_space = $3;
3084 my $funcname = $4;
3085 my $post_funcname_space = $5;
3086 my $pre_args_space = $6;
3087
Joe Perches91f72e92014-04-03 14:49:12 -07003088# the $Declare variable will capture all spaces after the type
3089# so check it for a missing trailing missing space but pointer return types
3090# don't need a space so don't warn for those.
3091 my $post_declare_space = "";
3092 if ($declare =~ /(\s+)$/) {
3093 $post_declare_space = $1;
3094 $declare = rtrim($declare);
3095 }
3096 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003097 WARN("SPACING",
3098 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003099 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003100 }
3101
3102# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003103# This test is not currently implemented because these declarations are
3104# equivalent to
3105# int foo(int bar, ...)
3106# and this is form shouldn't/doesn't generate a checkpatch warning.
3107#
3108# elsif ($declare =~ /\s{2,}$/) {
3109# WARN("SPACING",
3110# "Multiple spaces after return type\n" . $herecurr);
3111# }
Joe Perches31070b52014-01-23 15:54:49 -08003112
3113# unnecessary space "type ( *funcptr)(args...)"
3114 if (defined $pre_pointer_space &&
3115 $pre_pointer_space =~ /^\s/) {
3116 WARN("SPACING",
3117 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3118 }
3119
3120# unnecessary space "type (* funcptr)(args...)"
3121 if (defined $post_pointer_space &&
3122 $post_pointer_space =~ /^\s/) {
3123 WARN("SPACING",
3124 "Unnecessary space before function pointer name\n" . $herecurr);
3125 }
3126
3127# unnecessary space "type (*funcptr )(args...)"
3128 if (defined $post_funcname_space &&
3129 $post_funcname_space =~ /^\s/) {
3130 WARN("SPACING",
3131 "Unnecessary space after function pointer name\n" . $herecurr);
3132 }
3133
3134# unnecessary space "type (*funcptr) (args...)"
3135 if (defined $pre_args_space &&
3136 $pre_args_space =~ /^\s/) {
3137 WARN("SPACING",
3138 "Unnecessary space before function pointer arguments\n" . $herecurr);
3139 }
3140
3141 if (show_type("SPACING") && $fix) {
3142 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003143 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003144 }
3145 }
3146
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003147# check for spacing round square brackets; allowed:
3148# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003149# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3150# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003151 while ($line =~ /(.*?\s)\[/g) {
3152 my ($where, $prefix) = ($-[1], $1);
3153 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003154 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003155 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003156 if (ERROR("BRACKET_SPACE",
3157 "space prohibited before open square bracket '['\n" . $herecurr) &&
3158 $fix) {
3159 $fixed[$linenr - 1] =~
3160 s/^(\+.*?)\s+\[/$1\[/;
3161 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003162 }
3163 }
3164
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003165# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003166 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003167 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003168 my $ctx_before = substr($line, 0, $-[1]);
3169 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003170
3171 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003172 if ($name =~ /^(?:
3173 if|for|while|switch|return|case|
3174 volatile|__volatile__|
3175 __attribute__|format|__extension__|
3176 asm|__asm__)$/x)
3177 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003178 # cpp #define statements have non-optional spaces, ie
3179 # if there is a space between the name and the open
3180 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003181 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003182
3183 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003184 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003185
3186 # If this whole things ends with a type its most
3187 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003188 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003189
3190 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003191 if (WARN("SPACING",
3192 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3193 $fix) {
3194 $fixed[$linenr - 1] =~
3195 s/\b$name\s+\(/$name\(/;
3196 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003197 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003198 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003199
Andy Whitcroft653d4872007-06-23 17:16:34 -07003200# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003201 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003202 my $fixed_line = "";
3203 my $line_fixed = 0;
3204
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003205 my $ops = qr{
3206 <<=|>>=|<=|>=|==|!=|
3207 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3208 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003209 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003210 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003211 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003212 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003213
3214## print("element count: <" . $#elements . ">\n");
3215## foreach my $el (@elements) {
3216## print("el: <$el>\n");
3217## }
3218
3219 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003220 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003221
Joe Perches3705ce52013-07-03 15:05:31 -07003222 foreach my $el (@elements) {
3223 push(@fix_elements, substr($rawline, $off, length($el)));
3224 $off += length($el);
3225 }
3226
3227 $off = 0;
3228
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003229 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003230 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003231
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003232 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003233
3234 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3235
3236## print("n: <$n> good: <$good>\n");
3237
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003238 $off += length($elements[$n]);
3239
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003240 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003241 my $ca = substr($opline, 0, $off);
3242 my $cc = '';
3243 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3244 $cc = substr($opline, $off + length($elements[$n + 1]));
3245 }
3246 my $cb = "$ca$;$cc";
3247
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003248 my $a = '';
3249 $a = 'V' if ($elements[$n] ne '');
3250 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003251 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003252 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3253 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003254 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003255
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003256 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003257
3258 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003259 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003260 $c = 'V' if ($elements[$n + 2] ne '');
3261 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003262 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003263 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3264 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003265 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003266 } else {
3267 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003268 }
3269
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003270 my $ctx = "${a}x${c}";
3271
3272 my $at = "(ctx:$ctx)";
3273
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003274 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003275 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003276
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003277 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003278 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003279
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003280 # Get the full operator variant.
3281 my $opv = $op . substr($curr_vars, $off, 1);
3282
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003283 # Ignore operators passed as parameters.
3284 if ($op_type ne 'V' &&
3285 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3286
Andy Whitcroftcf655042008-03-04 14:28:20 -08003287# # Ignore comments
3288# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003289
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003290 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003291 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003292 if ($ctx !~ /.x[WEBC]/ &&
3293 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003294 if (ERROR("SPACING",
3295 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003296 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003297 $line_fixed = 1;
3298 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003299 }
3300
3301 # // is a comment
3302 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003303
Joe Perchesb00e4812014-04-03 14:49:33 -07003304 # : when part of a bitfield
3305 } elsif ($opv eq ':B') {
3306 # skip the bitfield test for now
3307
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003308 # No spaces for:
3309 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003310 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003311 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003312 if (ERROR("SPACING",
3313 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003314 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003315 if (defined $fix_elements[$n + 2]) {
3316 $fix_elements[$n + 2] =~ s/^\s+//;
3317 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003318 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003319 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003320 }
3321
3322 # , must have a space on the right.
3323 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003324 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003325 if (ERROR("SPACING",
3326 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003327 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003328 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003329 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003330 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003331 }
3332
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003333 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003334 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003335 #warn "'*' is part of type\n";
3336
3337 # unary operators should have a space before and
3338 # none after. May be left adjacent to another
3339 # unary operator, or a cast
3340 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003341 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003342 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003343 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003344 if (ERROR("SPACING",
3345 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003346 if ($n != $last_after + 2) {
3347 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3348 $line_fixed = 1;
3349 }
Joe Perches3705ce52013-07-03 15:05:31 -07003350 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003351 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003352 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003353 # A unary '*' may be const
3354
3355 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003356 if (ERROR("SPACING",
3357 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003358 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003359 if (defined $fix_elements[$n + 2]) {
3360 $fix_elements[$n + 2] =~ s/^\s+//;
3361 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003362 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003363 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003364 }
3365
3366 # unary ++ and unary -- are allowed no space on one side.
3367 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003368 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003369 if (ERROR("SPACING",
3370 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003371 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003372 $line_fixed = 1;
3373 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003374 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003375 if ($ctx =~ /Wx[BE]/ ||
3376 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003377 if (ERROR("SPACING",
3378 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003379 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003380 $line_fixed = 1;
3381 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003382 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003383 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003384 if (ERROR("SPACING",
3385 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003386 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003387 if (defined $fix_elements[$n + 2]) {
3388 $fix_elements[$n + 2] =~ s/^\s+//;
3389 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003390 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003391 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003392 }
3393
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003394 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003395 } elsif ($op eq '<<' or $op eq '>>' or
3396 $op eq '&' or $op eq '^' or $op eq '|' or
3397 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003398 $op eq '*' or $op eq '/' or
3399 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003400 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003401 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003402 if (ERROR("SPACING",
3403 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003404 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3405 if (defined $fix_elements[$n + 2]) {
3406 $fix_elements[$n + 2] =~ s/^\s+//;
3407 }
Joe Perches3705ce52013-07-03 15:05:31 -07003408 $line_fixed = 1;
3409 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003410 }
3411
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003412 # A colon needs no spaces before when it is
3413 # terminating a case value or a label.
3414 } elsif ($opv eq ':C' || $opv eq ':L') {
3415 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003416 if (ERROR("SPACING",
3417 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003418 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003419 $line_fixed = 1;
3420 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003421 }
3422
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003423 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003424 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003425 my $ok = 0;
3426
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003427 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003428 if (($op eq '<' &&
3429 $cc =~ /^\S+\@\S+>/) ||
3430 ($op eq '>' &&
3431 $ca =~ /<\S+\@\S+$/))
3432 {
3433 $ok = 1;
3434 }
3435
Joe Perches84731622013-11-12 15:10:05 -08003436 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003437 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003438 my $msg_type = \&ERROR;
3439 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3440
3441 if (&{$msg_type}("SPACING",
3442 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003443 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3444 if (defined $fix_elements[$n + 2]) {
3445 $fix_elements[$n + 2] =~ s/^\s+//;
3446 }
Joe Perches3705ce52013-07-03 15:05:31 -07003447 $line_fixed = 1;
3448 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003449 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003450 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003451 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003452
3453## print("n: <$n> GOOD: <$good>\n");
3454
3455 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003456 }
Joe Perches3705ce52013-07-03 15:05:31 -07003457
3458 if (($#elements % 2) == 0) {
3459 $fixed_line = $fixed_line . $fix_elements[$#elements];
3460 }
3461
3462 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3463 $fixed[$linenr - 1] = $fixed_line;
3464 }
3465
3466
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003467 }
3468
Joe Perches786b6322013-07-03 15:05:32 -07003469# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003470 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003471 if (WARN("SPACING",
3472 "space prohibited before semicolon\n" . $herecurr) &&
3473 $fix) {
3474 1 while $fixed[$linenr - 1] =~
3475 s/^(\+.*\S)\s+;/$1;/;
3476 }
3477 }
3478
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003479# check for multiple assignments
3480 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003481 CHK("MULTIPLE_ASSIGNMENTS",
3482 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003483 }
3484
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003485## # check for multiple declarations, allowing for a function declaration
3486## # continuation.
3487## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3488## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3489##
3490## # Remove any bracketed sections to ensure we do not
3491## # falsly report the parameters of functions.
3492## my $ln = $line;
3493## while ($ln =~ s/\([^\(\)]*\)//g) {
3494## }
3495## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003496## WARN("MULTIPLE_DECLARATION",
3497## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003498## }
3499## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003500
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003501#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003502 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3503 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003504 if (ERROR("SPACING",
3505 "space required before the open brace '{'\n" . $herecurr) &&
3506 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003507 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003508 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003509 }
3510
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003511## # check for blank lines before declarations
3512## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3513## $prevrawline =~ /^.\s*$/) {
3514## WARN("SPACING",
3515## "No blank lines before declarations\n" . $hereprev);
3516## }
3517##
3518
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003519# closing brace should have a space following it when it has anything
3520# on the line
3521 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003522 if (ERROR("SPACING",
3523 "space required after that close brace '}'\n" . $herecurr) &&
3524 $fix) {
3525 $fixed[$linenr - 1] =~
3526 s/}((?!(?:,|;|\)))\S)/} $1/;
3527 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003528 }
3529
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003530# check spacing on square brackets
3531 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003532 if (ERROR("SPACING",
3533 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3534 $fix) {
3535 $fixed[$linenr - 1] =~
3536 s/\[\s+/\[/;
3537 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003538 }
3539 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003540 if (ERROR("SPACING",
3541 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3542 $fix) {
3543 $fixed[$linenr - 1] =~
3544 s/\s+\]/\]/;
3545 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003546 }
3547
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003548# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003549 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3550 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003551 if (ERROR("SPACING",
3552 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3553 $fix) {
3554 $fixed[$linenr - 1] =~
3555 s/\(\s+/\(/;
3556 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003557 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003558 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003559 $line !~ /for\s*\(.*;\s+\)/ &&
3560 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003561 if (ERROR("SPACING",
3562 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3563 $fix) {
3564 $fixed[$linenr - 1] =~
3565 s/\s+\)/\)/;
3566 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003567 }
3568
Joe Perchese2826fd2014-08-06 16:10:48 -07003569# check unnecessary parentheses around addressof/dereference single $Lvals
3570# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3571
3572 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3573 CHK("UNNECESSARY_PARENTHESES",
3574 "Unnecessary parentheses around $1\n" . $herecurr);
3575 }
3576
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003577#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003578 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003579 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003580 if (WARN("INDENTED_LABEL",
3581 "labels should not be indented\n" . $herecurr) &&
3582 $fix) {
3583 $fixed[$linenr - 1] =~
3584 s/^(.)\s+/$1/;
3585 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003586 }
3587
Joe Perches5b9553a2014-04-03 14:49:21 -07003588# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003589 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003590 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003591 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003592 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3593 my $value = $1;
3594 $value = deparenthesize($value);
3595 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3596 ERROR("RETURN_PARENTHESES",
3597 "return is not a function, parentheses are not required\n" . $herecurr);
3598 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003599 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003600 ERROR("SPACING",
3601 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003602 }
3603 }
Joe Perches507e5142013-11-12 15:10:13 -08003604
Joe Perchesb43ae212014-06-23 13:22:07 -07003605# unnecessary return in a void function
3606# at end-of-function, with the previous line a single leading tab, then return;
3607# and the line before that not a goto label target like "out:"
3608 if ($sline =~ /^[ \+]}\s*$/ &&
3609 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3610 $linenr >= 3 &&
3611 $lines[$linenr - 3] =~ /^[ +]/ &&
3612 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003613 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003614 "void function return statements are not generally useful\n" . $hereprev);
3615 }
Joe Perches9819cf22014-06-04 16:12:09 -07003616
Joe Perches189248d2014-01-23 15:54:47 -08003617# if statements using unnecessary parentheses - ie: if ((foo == bar))
3618 if ($^V && $^V ge 5.10.0 &&
3619 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3620 my $openparens = $1;
3621 my $count = $openparens =~ tr@\(@\(@;
3622 my $msg = "";
3623 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3624 my $comp = $4; #Not $1 because of $LvalOrFunc
3625 $msg = " - maybe == should be = ?" if ($comp eq "==");
3626 WARN("UNNECESSARY_PARENTHESES",
3627 "Unnecessary parentheses$msg\n" . $herecurr);
3628 }
3629 }
3630
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003631# Return of what appears to be an errno should normally be -'ve
3632 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3633 my $name = $1;
3634 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003635 WARN("USE_NEGATIVE_ERRNO",
3636 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003637 }
3638 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003639
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003640# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003641 if ($line =~ /\b(if|while|for|switch)\(/) {
3642 if (ERROR("SPACING",
3643 "space required before the open parenthesis '('\n" . $herecurr) &&
3644 $fix) {
3645 $fixed[$linenr - 1] =~
3646 s/\b(if|while|for|switch)\(/$1 \(/;
3647 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003648 }
3649
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003650# Check for illegal assignment in if conditional -- and check for trailing
3651# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003652 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003653 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3654 ctx_statement_block($linenr, $realcnt, 0)
3655 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003656 my ($stat_next) = ctx_statement_block($line_nr_next,
3657 $remain_next, $off_next);
3658 $stat_next =~ s/\n./\n /g;
3659 ##print "stat<$stat> stat_next<$stat_next>\n";
3660
3661 if ($stat_next =~ /^\s*while\b/) {
3662 # If the statement carries leading newlines,
3663 # then count those as offsets.
3664 my ($whitespace) =
3665 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3666 my $offset =
3667 statement_rawlines($whitespace) - 1;
3668
3669 $suppress_whiletrailers{$line_nr_next +
3670 $offset} = 1;
3671 }
3672 }
3673 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003674 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003675 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003676 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003677
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003678 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003679 ERROR("ASSIGN_IN_IF",
3680 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003681 }
3682
3683 # Find out what is on the end of the line after the
3684 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003685 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003686 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003687 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003688 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3689 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003690 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003691 # Find out how long the conditional actually is.
3692 my @newlines = ($c =~ /\n/gs);
3693 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003694 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003695
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003696 $stat_real = raw_line($linenr, $cond_lines)
3697 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003698 if (defined($stat_real) && $cond_lines > 1) {
3699 $stat_real = "[...]\n$stat_real";
3700 }
3701
Joe Perches000d1cc12011-07-25 17:13:25 -07003702 ERROR("TRAILING_STATEMENTS",
3703 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003704 }
3705 }
3706
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003707# Check for bitwise tests written as boolean
3708 if ($line =~ /
3709 (?:
3710 (?:\[|\(|\&\&|\|\|)
3711 \s*0[xX][0-9]+\s*
3712 (?:\&\&|\|\|)
3713 |
3714 (?:\&\&|\|\|)
3715 \s*0[xX][0-9]+\s*
3716 (?:\&\&|\|\||\)|\])
3717 )/x)
3718 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003719 WARN("HEXADECIMAL_BOOLEAN_TEST",
3720 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003721 }
3722
Andy Whitcroft8905a672007-11-28 16:21:06 -08003723# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003724 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3725 my $s = $1;
3726 $s =~ s/$;//g; # Remove any comments
3727 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003728 ERROR("TRAILING_STATEMENTS",
3729 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003730 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003731 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003732# if should not continue a brace
3733 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003734 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07003735 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003736 $herecurr);
3737 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003738# case and default should not have general statements after them
3739 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3740 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003741 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003742 \s*return\s+
3743 )/xg)
3744 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003745 ERROR("TRAILING_STATEMENTS",
3746 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003747 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003748
3749 # Check for }<nl>else {, these must be at the same
3750 # indent level to be relevant to each other.
3751 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3752 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003753 ERROR("ELSE_AFTER_BRACE",
3754 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003755 }
3756
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003757 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3758 $previndent == $indent) {
3759 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3760
3761 # Find out what is on the end of the line after the
3762 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003763 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003764 $s =~ s/\n.*//g;
3765
3766 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003767 ERROR("WHILE_AFTER_BRACE",
3768 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003769 }
3770 }
3771
Joe Perches95e2c602013-07-03 15:05:20 -07003772#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003773 while ($line =~ m{($Constant|$Lval)}g) {
3774 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003775
3776#gcc binary extension
3777 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003778 if (WARN("GCC_BINARY_CONSTANT",
3779 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3780 $fix) {
3781 my $hexval = sprintf("0x%x", oct($var));
3782 $fixed[$linenr - 1] =~
3783 s/\b$var\b/$hexval/;
3784 }
Joe Perches95e2c602013-07-03 15:05:20 -07003785 }
3786
3787#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003788 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003789 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003790#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003791 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003792#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003793 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003794 while ($var =~ m{($Ident)}g) {
3795 my $word = $1;
3796 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003797 if ($check) {
3798 seed_camelcase_includes();
3799 if (!$file && !$camelcase_file_seeded) {
3800 seed_camelcase_file($realfile);
3801 $camelcase_file_seeded = 1;
3802 }
3803 }
Joe Perches7e781f62013-09-11 14:23:55 -07003804 if (!defined $camelcase{$word}) {
3805 $camelcase{$word} = 1;
3806 CHK("CAMELCASE",
3807 "Avoid CamelCase: <$word>\n" . $herecurr);
3808 }
Joe Perches34456862013-07-03 15:05:34 -07003809 }
Joe Perches323c1262012-12-17 16:02:07 -08003810 }
3811 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003812
3813#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003814 if ($line =~ /\#\s*define.*\\\s+$/) {
3815 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3816 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3817 $fix) {
3818 $fixed[$linenr - 1] =~ s/\s+$//;
3819 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003820 }
3821
Andy Whitcroft653d4872007-06-23 17:16:34 -07003822#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003823 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003824 my $file = "$1.h";
3825 my $checkfile = "include/linux/$file";
3826 if (-f "$root/$checkfile" &&
3827 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003828 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003829 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003830 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003831 CHK("ARCH_INCLUDE_LINUX",
3832 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003833 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003834 WARN("INCLUDE_LINUX",
3835 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003836 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003837 }
3838 }
3839
Andy Whitcroft653d4872007-06-23 17:16:34 -07003840# multi-statement macros should be enclosed in a do while loop, grab the
3841# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003842# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07003843 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3844 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003845 my $ln = $linenr;
3846 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003847 my ($off, $dstat, $dcond, $rest);
3848 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003849 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003850 ctx_statement_block($linenr, $realcnt, 0);
3851 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003852 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003853 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003854
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003855 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003856 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003857 $dstat =~ s/\\\n.//g;
3858 $dstat =~ s/^\s*//s;
3859 $dstat =~ s/\s*$//s;
3860
3861 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003862 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3863 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003864 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003865 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003866 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003867
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003868 # Flatten any obvious string concatentation.
3869 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3870 $dstat =~ s/$Ident\s*("X*")/$1/)
3871 {
3872 }
3873
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003874 my $exceptions = qr{
3875 $Declare|
3876 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003877 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003878 DECLARE_PER_CPU|
3879 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003880 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003881 union|
3882 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003883 \.$Ident\s*=\s*|
3884 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003885 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003886 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003887 if ($dstat ne '' &&
3888 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3889 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003890 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07003891 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003892 $dstat !~ /$exceptions/ &&
3893 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003894 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003895 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003896 $dstat !~ /^for\s*$Constant$/ && # for (...)
3897 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3898 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003899 $dstat !~ /^\({/ && # ({...
3900 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003901 {
3902 $ctx =~ s/\n*$//;
3903 my $herectx = $here . "\n";
3904 my $cnt = statement_rawlines($ctx);
3905
3906 for (my $n = 0; $n < $cnt; $n++) {
3907 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003908 }
3909
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003910 if ($dstat =~ /;/) {
3911 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3912 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3913 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003914 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003915 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003916 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003917 }
Joe Perches5023d342012-12-17 16:01:47 -08003918
Joe Perches481eb482012-12-17 16:01:56 -08003919# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003920
3921 } else {
3922 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003923 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3924 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003925 $line =~ /^\+.*\\$/) {
3926 WARN("LINE_CONTINUATIONS",
3927 "Avoid unnecessary line continuations\n" . $herecurr);
3928 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003929 }
3930
Joe Perchesb13edf72012-07-30 14:41:24 -07003931# do {} while (0) macro tests:
3932# single-statement macros do not need to be enclosed in do while (0) loop,
3933# macro should not end with a semicolon
3934 if ($^V && $^V ge 5.10.0 &&
3935 $realfile !~ m@/vmlinux.lds.h$@ &&
3936 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3937 my $ln = $linenr;
3938 my $cnt = $realcnt;
3939 my ($off, $dstat, $dcond, $rest);
3940 my $ctx = '';
3941 ($dstat, $dcond, $ln, $cnt, $off) =
3942 ctx_statement_block($linenr, $realcnt, 0);
3943 $ctx = $dstat;
3944
3945 $dstat =~ s/\\\n.//g;
3946
3947 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3948 my $stmts = $2;
3949 my $semis = $3;
3950
3951 $ctx =~ s/\n*$//;
3952 my $cnt = statement_rawlines($ctx);
3953 my $herectx = $here . "\n";
3954
3955 for (my $n = 0; $n < $cnt; $n++) {
3956 $herectx .= raw_line($linenr, $n) . "\n";
3957 }
3958
Joe Perchesac8e97f2012-08-21 16:15:53 -07003959 if (($stmts =~ tr/;/;/) == 1 &&
3960 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003961 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3962 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3963 }
3964 if (defined $semis && $semis ne "") {
3965 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3966 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3967 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07003968 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
3969 $ctx =~ s/\n*$//;
3970 my $cnt = statement_rawlines($ctx);
3971 my $herectx = $here . "\n";
3972
3973 for (my $n = 0; $n < $cnt; $n++) {
3974 $herectx .= raw_line($linenr, $n) . "\n";
3975 }
3976
3977 WARN("TRAILING_SEMICOLON",
3978 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07003979 }
3980 }
3981
Mike Frysinger080ba922009-01-06 14:41:25 -08003982# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3983# all assignments may have only one of the following with an assignment:
3984# .
3985# ALIGN(...)
3986# VMLINUX_SYMBOL(...)
3987 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003988 WARN("MISSING_VMLINUX_SYMBOL",
3989 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003990 }
3991
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003992# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003993 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3994 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003995 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003996 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003997 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3998 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003999 my @allowed = ();
4000 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004001 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004002 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004003 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004004 for my $chunk (@chunks) {
4005 my ($cond, $block) = @{$chunk};
4006
Andy Whitcroft773647a2008-03-28 14:15:58 -07004007 # If the condition carries leading newlines, then count those as offsets.
4008 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4009 my $offset = statement_rawlines($whitespace) - 1;
4010
Joe Perchesaad4f612012-03-23 15:02:19 -07004011 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004012 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4013
4014 # We have looked at and allowed this specific line.
4015 $suppress_ifbraces{$ln + $offset} = 1;
4016
4017 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004018 $ln += statement_rawlines($block) - 1;
4019
Andy Whitcroft773647a2008-03-28 14:15:58 -07004020 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004021
4022 $seen++ if ($block =~ /^\s*{/);
4023
Joe Perchesaad4f612012-03-23 15:02:19 -07004024 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004025 if (statement_lines($cond) > 1) {
4026 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004027 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004028 }
4029 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004030 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004031 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004032 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004033 if (statement_block_size($block) > 1) {
4034 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004035 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004036 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004037 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004038 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004039 if ($seen) {
4040 my $sum_allowed = 0;
4041 foreach (@allowed) {
4042 $sum_allowed += $_;
4043 }
4044 if ($sum_allowed == 0) {
4045 WARN("BRACES",
4046 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4047 } elsif ($sum_allowed != $allow &&
4048 $seen != $allow) {
4049 CHK("BRACES",
4050 "braces {} should be used on all arms of this statement\n" . $herectx);
4051 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004052 }
4053 }
4054 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004055 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004056 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004057 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004058
Andy Whitcroftcf655042008-03-04 14:28:20 -08004059 # Check the pre-context.
4060 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4061 #print "APW: ALLOWED: pre<$1>\n";
4062 $allowed = 1;
4063 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004064
4065 my ($level, $endln, @chunks) =
4066 ctx_statement_full($linenr, $realcnt, $-[0]);
4067
Andy Whitcroftcf655042008-03-04 14:28:20 -08004068 # Check the condition.
4069 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004070 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004071 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004072 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004073 }
4074 if (statement_lines($cond) > 1) {
4075 #print "APW: ALLOWED: cond<$cond>\n";
4076 $allowed = 1;
4077 }
4078 if ($block =~/\b(?:if|for|while)\b/) {
4079 #print "APW: ALLOWED: block<$block>\n";
4080 $allowed = 1;
4081 }
4082 if (statement_block_size($block) > 1) {
4083 #print "APW: ALLOWED: lines block<$block>\n";
4084 $allowed = 1;
4085 }
4086 # Check the post-context.
4087 if (defined $chunks[1]) {
4088 my ($cond, $block) = @{$chunks[1]};
4089 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004090 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004091 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004092 if ($block =~ /^\s*\{/) {
4093 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4094 $allowed = 1;
4095 }
4096 }
4097 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004098 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004099 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004100
Andy Whitcroftf0556632008-10-15 22:02:23 -07004101 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004102 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004103 }
4104
Joe Perches000d1cc12011-07-25 17:13:25 -07004105 WARN("BRACES",
4106 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004107 }
4108 }
4109
Joe Perches0979ae62012-12-17 16:01:59 -08004110# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004111 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004112 CHK("BRACES",
4113 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4114 }
Joe Perches77b9a532013-07-03 15:05:29 -07004115 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004116 CHK("BRACES",
4117 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4118 }
4119
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004120# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004121 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4122 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004123 WARN("VOLATILE",
4124 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004125 }
4126
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004127# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004128 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004129 CHK("REDUNDANT_CODE",
4130 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004131 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004132 }
4133
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004134# check for needless "if (<foo>) fn(<foo>)" uses
4135 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4136 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4137 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4138 WARN('NEEDLESS_IF',
4139 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004140 }
4141 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004142
Joe Perchesebfdc402014-08-06 16:10:27 -07004143# check for unnecessary "Out of Memory" messages
4144 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4145 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4146 (defined $1 || defined $3) &&
4147 $linenr > 3) {
4148 my $testval = $2;
4149 my $testline = $lines[$linenr - 3];
4150
4151 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4152# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4153
4154 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4155 WARN("OOM_MESSAGE",
4156 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4157 }
4158 }
4159
Joe Perches8716de32013-09-11 14:24:05 -07004160# check for bad placement of section $InitAttribute (e.g.: __initdata)
4161 if ($line =~ /(\b$InitAttribute\b)/) {
4162 my $attr = $1;
4163 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4164 my $ptr = $1;
4165 my $var = $2;
4166 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4167 ERROR("MISPLACED_INIT",
4168 "$attr should be placed after $var\n" . $herecurr)) ||
4169 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4170 WARN("MISPLACED_INIT",
4171 "$attr should be placed after $var\n" . $herecurr))) &&
4172 $fix) {
4173 $fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
4174 }
4175 }
4176 }
4177
Joe Perchese970b8842013-11-12 15:10:10 -08004178# check for $InitAttributeData (ie: __initdata) with const
4179 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4180 my $attr = $1;
4181 $attr =~ /($InitAttributePrefix)(.*)/;
4182 my $attr_prefix = $1;
4183 my $attr_type = $2;
4184 if (ERROR("INIT_ATTRIBUTE",
4185 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4186 $fix) {
4187 $fixed[$linenr - 1] =~
4188 s/$InitAttributeData/${attr_prefix}initconst/;
4189 }
4190 }
4191
4192# check for $InitAttributeConst (ie: __initconst) without const
4193 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4194 my $attr = $1;
4195 if (ERROR("INIT_ATTRIBUTE",
4196 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4197 $fix) {
4198 my $lead = $fixed[$linenr - 1] =~
4199 /(^\+\s*(?:static\s+))/;
4200 $lead = rtrim($1);
4201 $lead = "$lead " if ($lead !~ /^\+$/);
4202 $lead = "${lead}const ";
4203 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
4204 }
4205 }
4206
Joe Perchesfbdb8132014-04-03 14:49:14 -07004207# don't use __constant_<foo> functions outside of include/uapi/
4208 if ($realfile !~ m@^include/uapi/@ &&
4209 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4210 my $constant_func = $1;
4211 my $func = $constant_func;
4212 $func =~ s/^__constant_//;
4213 if (WARN("CONSTANT_CONVERSION",
4214 "$constant_func should be $func\n" . $herecurr) &&
4215 $fix) {
4216 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4217 }
4218 }
4219
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004220# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004221 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004222 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004223 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004224 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004225 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004226 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4227 }
4228 if ($delay > 2000) {
4229 WARN("LONG_UDELAY",
4230 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004231 }
4232 }
4233
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004234# warn about unexpectedly long msleep's
4235 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4236 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004237 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004238 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004239 }
4240 }
4241
Joe Perches36ec1932013-07-03 15:05:25 -07004242# check for comparisons of jiffies
4243 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4244 WARN("JIFFIES_COMPARISON",
4245 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4246 }
4247
Joe Perches9d7a34a2013-07-03 15:05:26 -07004248# check for comparisons of get_jiffies_64()
4249 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4250 WARN("JIFFIES_COMPARISON",
4251 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4252 }
4253
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004254# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004255# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004256# print "#ifdef in C files should be avoided\n";
4257# print "$herecurr";
4258# $clean = 0;
4259# }
4260
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004261# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004262 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004263 if (ERROR("SPACING",
4264 "exactly one space required after that #$1\n" . $herecurr) &&
4265 $fix) {
4266 $fixed[$linenr - 1] =~
4267 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4268 }
4269
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004270 }
4271
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004272# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004273 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4274 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004275 my $which = $1;
4276 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004277 CHK("UNCOMMENTED_DEFINITION",
4278 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004279 }
4280 }
4281# check for memory barriers without a comment.
4282 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4283 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004284 WARN("MEMORY_BARRIER",
4285 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004286 }
4287 }
4288# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004289 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004290 CHK("ARCH_DEFINES",
4291 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004292 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004293
Tobias Klauserd4977c72010-05-24 14:33:30 -07004294# Check that the storage class is at the beginning of a declaration
4295 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004296 WARN("STORAGE_CLASS",
4297 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004298 }
4299
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004300# check the location of the inline attribute, that it is between
4301# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004302 if ($line =~ /\b$Type\s+$Inline\b/ ||
4303 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004304 ERROR("INLINE_LOCATION",
4305 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004306 }
4307
Andy Whitcroft8905a672007-11-28 16:21:06 -08004308# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004309 if ($realfile !~ m@\binclude/uapi/@ &&
4310 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004311 if (WARN("INLINE",
4312 "plain inline is preferred over $1\n" . $herecurr) &&
4313 $fix) {
4314 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4315
4316 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004317 }
4318
Joe Perches3d130fd2011-01-12 17:00:00 -08004319# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004320 if ($realfile !~ m@\binclude/uapi/@ &&
4321 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004322 WARN("PREFER_PACKED",
4323 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004324 }
4325
Joe Perches39b7e282011-07-25 17:13:24 -07004326# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004327 if ($realfile !~ m@\binclude/uapi/@ &&
4328 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004329 WARN("PREFER_ALIGNED",
4330 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004331 }
4332
Joe Perches5f14d3b2012-01-10 15:09:52 -08004333# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004334 if ($realfile !~ m@\binclude/uapi/@ &&
4335 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004336 if (WARN("PREFER_PRINTF",
4337 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4338 $fix) {
4339 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4340
4341 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004342 }
4343
Joe Perches6061d942012-03-23 15:02:16 -07004344# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004345 if ($realfile !~ m@\binclude/uapi/@ &&
4346 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004347 if (WARN("PREFER_SCANF",
4348 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4349 $fix) {
4350 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4351 }
Joe Perches6061d942012-03-23 15:02:16 -07004352 }
4353
Joe Perches8f53a9b2010-03-05 13:43:48 -08004354# check for sizeof(&)
4355 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004356 WARN("SIZEOF_ADDRESS",
4357 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004358 }
4359
Joe Perches66c80b62012-07-30 14:41:22 -07004360# check for sizeof without parenthesis
4361 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004362 if (WARN("SIZEOF_PARENTHESIS",
4363 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4364 $fix) {
4365 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4366 }
Joe Perches66c80b62012-07-30 14:41:22 -07004367 }
4368
Joe Perches428e2fd2011-05-24 17:13:39 -07004369# check for line continuations in quoted strings with odd counts of "
4370 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004371 WARN("LINE_CONTINUATIONS",
4372 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004373 }
4374
Joe Perches88982fe2012-12-17 16:02:00 -08004375# check for struct spinlock declarations
4376 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4377 WARN("USE_SPINLOCK_T",
4378 "struct spinlock should be spinlock_t\n" . $herecurr);
4379 }
4380
Joe Perchesa6962d72013-04-29 16:18:13 -07004381# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004382 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004383 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004384 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004385 if (WARN("PREFER_SEQ_PUTS",
4386 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4387 $fix) {
4388 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4389 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004390 }
4391 }
4392
Andy Whitcroft554e1652012-01-10 15:09:57 -08004393# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004394 if ($^V && $^V ge 5.10.0 &&
4395 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004396 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004397
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004398 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004399 my $ms_val = $7;
4400 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004401
Andy Whitcroft554e1652012-01-10 15:09:57 -08004402 if ($ms_size =~ /^(0x|)0$/i) {
4403 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004404 "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 -08004405 } elsif ($ms_size =~ /^(0x|)1$/i) {
4406 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004407 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4408 }
4409 }
4410
Joe Perches98a9bba2014-01-23 15:54:52 -08004411# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4412 if ($^V && $^V ge 5.10.0 &&
4413 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4414 if (WARN("PREFER_ETHER_ADDR_COPY",
4415 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4416 $fix) {
4417 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4418 }
4419 }
4420
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004421# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004422 if ($^V && $^V ge 5.10.0 &&
4423 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004424 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004425 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004426 my $call = $1;
4427 my $cast1 = deparenthesize($2);
4428 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004429 my $cast2 = deparenthesize($7);
4430 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004431 my $cast;
4432
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004433 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004434 $cast = "$cast1 or $cast2";
4435 } elsif ($cast1 ne "") {
4436 $cast = $cast1;
4437 } else {
4438 $cast = $cast2;
4439 }
4440 WARN("MINMAX",
4441 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004442 }
4443 }
4444
Joe Perches4a273192012-07-30 14:41:20 -07004445# check usleep_range arguments
4446 if ($^V && $^V ge 5.10.0 &&
4447 defined $stat &&
4448 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4449 my $min = $1;
4450 my $max = $7;
4451 if ($min eq $max) {
4452 WARN("USLEEP_RANGE",
4453 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4454 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4455 $min > $max) {
4456 WARN("USLEEP_RANGE",
4457 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4458 }
4459 }
4460
Joe Perches823b7942013-11-12 15:10:15 -08004461# check for naked sscanf
4462 if ($^V && $^V ge 5.10.0 &&
4463 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004464 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004465 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4466 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4467 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4468 my $lc = $stat =~ tr@\n@@;
4469 $lc = $lc + $linenr;
4470 my $stat_real = raw_line($linenr, 0);
4471 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4472 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4473 }
4474 WARN("NAKED_SSCANF",
4475 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4476 }
4477
Joe Perchesafc819a2014-06-04 16:12:08 -07004478# check for simple sscanf that should be kstrto<foo>
4479 if ($^V && $^V ge 5.10.0 &&
4480 defined $stat &&
4481 $line =~ /\bsscanf\b/) {
4482 my $lc = $stat =~ tr@\n@@;
4483 $lc = $lc + $linenr;
4484 my $stat_real = raw_line($linenr, 0);
4485 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4486 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4487 }
4488 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4489 my $format = $6;
4490 my $count = $format =~ tr@%@%@;
4491 if ($count == 1 &&
4492 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4493 WARN("SSCANF_TO_KSTRTO",
4494 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4495 }
4496 }
4497 }
4498
Joe Perches70dc8a42013-09-11 14:23:58 -07004499# check for new externs in .h files.
4500 if ($realfile =~ /\.h$/ &&
4501 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004502 if (CHK("AVOID_EXTERNS",
4503 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004504 $fix) {
4505 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4506 }
4507 }
4508
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004509# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004510 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004511 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004512 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004513 my $function_name = $1;
4514 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004515
4516 my $s = $stat;
4517 if (defined $cond) {
4518 substr($s, 0, length($cond), '');
4519 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004520 if ($s =~ /^\s*;/ &&
4521 $function_name ne 'uninitialized_var')
4522 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004523 WARN("AVOID_EXTERNS",
4524 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004525 }
4526
4527 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004528 WARN("FUNCTION_ARGUMENTS",
4529 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004530 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004531
4532 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4533 $stat =~ /^.\s*extern\s+/)
4534 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004535 WARN("AVOID_EXTERNS",
4536 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004537 }
4538
4539# checks for new __setup's
4540 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4541 my $name = $1;
4542
4543 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004544 CHK("UNDOCUMENTED_SETUP",
4545 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004546 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004547 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004548
4549# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004550 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004551 WARN("UNNECESSARY_CASTS",
4552 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004553 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004554
Joe Perchesa640d252013-07-03 15:05:21 -07004555# alloc style
4556# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4557 if ($^V && $^V ge 5.10.0 &&
4558 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4559 CHK("ALLOC_SIZEOF_STRUCT",
4560 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4561 }
4562
Joe Perches60a55362014-06-04 16:12:07 -07004563# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4564 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07004565 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07004566 my $oldfunc = $3;
4567 my $a1 = $4;
4568 my $a2 = $10;
4569 my $newfunc = "kmalloc_array";
4570 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07004571 my $r1 = $a1;
4572 my $r2 = $a2;
4573 if ($a1 =~ /^sizeof\s*\S/) {
4574 $r1 = $a2;
4575 $r2 = $a1;
4576 }
4577 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4578 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07004579 if (WARN("ALLOC_WITH_MULTIPLY",
4580 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4581 $fix) {
Joe Perches60a55362014-06-04 16:12:07 -07004582 $fixed[$linenr - 1] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
4583
4584 }
4585 }
4586 }
4587
Joe Perches972fdea2013-04-29 16:18:12 -07004588# check for krealloc arg reuse
4589 if ($^V && $^V ge 5.10.0 &&
4590 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4591 WARN("KREALLOC_ARG_REUSE",
4592 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4593 }
4594
Joe Perches5ce59ae2013-02-21 16:44:18 -08004595# check for alloc argument mismatch
4596 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4597 WARN("ALLOC_ARRAY_ARGS",
4598 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4599 }
4600
Joe Perchescaf2a542011-01-12 16:59:56 -08004601# check for multiple semicolons
4602 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004603 if (WARN("ONE_SEMICOLON",
4604 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4605 $fix) {
4606 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4607 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004608 }
4609
Joe Perchesc34c09a2014-01-23 15:54:43 -08004610# check for case / default statements not preceeded by break/fallthrough/switch
4611 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4612 my $has_break = 0;
4613 my $has_statement = 0;
4614 my $count = 0;
4615 my $prevline = $linenr;
4616 while ($prevline > 1 && $count < 3 && !$has_break) {
4617 $prevline--;
4618 my $rline = $rawlines[$prevline - 1];
4619 my $fline = $lines[$prevline - 1];
4620 last if ($fline =~ /^\@\@/);
4621 next if ($fline =~ /^\-/);
4622 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4623 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4624 next if ($fline =~ /^.[\s$;]*$/);
4625 $has_statement = 1;
4626 $count++;
4627 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4628 }
4629 if (!$has_break && $has_statement) {
4630 WARN("MISSING_BREAK",
4631 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4632 }
4633 }
4634
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004635# check for switch/default statements without a break;
4636 if ($^V && $^V ge 5.10.0 &&
4637 defined $stat &&
4638 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4639 my $ctx = '';
4640 my $herectx = $here . "\n";
4641 my $cnt = statement_rawlines($stat);
4642 for (my $n = 0; $n < $cnt; $n++) {
4643 $herectx .= raw_line($linenr, $n) . "\n";
4644 }
4645 WARN("DEFAULT_NO_BREAK",
4646 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004647 }
4648
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004649# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004650 if ($line =~ /\b__FUNCTION__\b/) {
4651 if (WARN("USE_FUNC",
4652 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4653 $fix) {
4654 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4655 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004656 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004657
Joe Perches2c924882012-03-23 15:02:20 -07004658# check for use of yield()
4659 if ($line =~ /\byield\s*\(\s*\)/) {
4660 WARN("YIELD",
4661 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4662 }
4663
Joe Perches179f8f42013-07-03 15:05:30 -07004664# check for comparisons against true and false
4665 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4666 my $lead = $1;
4667 my $arg = $2;
4668 my $test = $3;
4669 my $otype = $4;
4670 my $trail = $5;
4671 my $op = "!";
4672
4673 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4674
4675 my $type = lc($otype);
4676 if ($type =~ /^(?:true|false)$/) {
4677 if (("$test" eq "==" && "$type" eq "true") ||
4678 ("$test" eq "!=" && "$type" eq "false")) {
4679 $op = "";
4680 }
4681
4682 CHK("BOOL_COMPARISON",
4683 "Using comparison to $otype is error prone\n" . $herecurr);
4684
4685## maybe suggesting a correct construct would better
4686## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4687
4688 }
4689 }
4690
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004691# check for semaphores initialized locked
4692 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004693 WARN("CONSIDER_COMPLETION",
4694 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004695 }
Joe Perches6712d852012-03-23 15:02:20 -07004696
Joe Perches67d0a072011-10-31 17:13:10 -07004697# recommend kstrto* over simple_strto* and strict_strto*
4698 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004699 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004700 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004701 }
Joe Perches6712d852012-03-23 15:02:20 -07004702
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004703# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07004704 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004705 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004706 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004707 }
Joe Perches6712d852012-03-23 15:02:20 -07004708
Emese Revfy79404842010-03-05 13:43:53 -08004709# check for various ops structs, ensure they are const.
4710 my $struct_ops = qr{acpi_dock_ops|
4711 address_space_operations|
4712 backlight_ops|
4713 block_device_operations|
4714 dentry_operations|
4715 dev_pm_ops|
4716 dma_map_ops|
4717 extent_io_ops|
4718 file_lock_operations|
4719 file_operations|
4720 hv_ops|
4721 ide_dma_ops|
4722 intel_dvo_dev_ops|
4723 item_operations|
4724 iwl_ops|
4725 kgdb_arch|
4726 kgdb_io|
4727 kset_uevent_ops|
4728 lock_manager_operations|
4729 microcode_ops|
4730 mtrr_ops|
4731 neigh_ops|
4732 nlmsvc_binding|
4733 pci_raw_ops|
4734 pipe_buf_operations|
4735 platform_hibernation_ops|
4736 platform_suspend_ops|
4737 proto_ops|
4738 rpc_pipe_ops|
4739 seq_operations|
4740 snd_ac97_build_ops|
4741 soc_pcmcia_socket_ops|
4742 stacktrace_ops|
4743 sysfs_ops|
4744 tty_operations|
4745 usb_mon_operations|
4746 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004747 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004748 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004749 WARN("CONST_STRUCT",
4750 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004751 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004752 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004753
4754# use of NR_CPUS is usually wrong
4755# ignore definitions of NR_CPUS and usage to define arrays as likely right
4756 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004757 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4758 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004759 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4760 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4761 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004762 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004763 WARN("NR_CPUS",
4764 "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 -07004765 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004766
Joe Perches52ea8502013-11-12 15:10:09 -08004767# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4768 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4769 ERROR("DEFINE_ARCH_HAS",
4770 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4771 }
4772
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004773# check for %L{u,d,i} in strings
4774 my $string;
4775 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4776 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004777 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004778 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004779 WARN("PRINTF_L",
4780 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004781 last;
4782 }
4783 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004784
4785# whine mightly about in_atomic
4786 if ($line =~ /\bin_atomic\s*\(/) {
4787 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004788 ERROR("IN_ATOMIC",
4789 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004790 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004791 WARN("IN_ATOMIC",
4792 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004793 }
4794 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004795
4796# check for lockdep_set_novalidate_class
4797 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4798 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4799 if ($realfile !~ m@^kernel/lockdep@ &&
4800 $realfile !~ m@^include/linux/lockdep@ &&
4801 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004802 ERROR("LOCKDEP",
4803 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004804 }
4805 }
Dave Jones88f88312011-01-12 16:59:59 -08004806
4807 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4808 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004809 WARN("EXPORTED_WORLD_WRITABLE",
4810 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004811 }
Joe Perches24358802014-04-03 14:49:13 -07004812
Joe Perches515a2352014-04-03 14:49:24 -07004813# Mode permission misuses where it seems decimal should be octal
4814# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4815 if ($^V && $^V ge 5.10.0 &&
4816 $line =~ /$mode_perms_search/) {
4817 foreach my $entry (@mode_permission_funcs) {
4818 my $func = $entry->[0];
4819 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004820
Joe Perches515a2352014-04-03 14:49:24 -07004821 my $skip_args = "";
4822 if ($arg_pos > 1) {
4823 $arg_pos--;
4824 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4825 }
4826 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4827 if ($line =~ /$test/) {
4828 my $val = $1;
4829 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004830
Joe Perches515a2352014-04-03 14:49:24 -07004831 if ($val !~ /^0$/ &&
4832 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4833 length($val) ne 4)) {
4834 ERROR("NON_OCTAL_PERMISSIONS",
4835 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4836 }
Joe Perches24358802014-04-03 14:49:13 -07004837 }
4838 }
4839 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004840 }
4841
4842 # If we have no input at all, then there is nothing to report on
4843 # so just keep quiet.
4844 if ($#rawlines == -1) {
4845 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004846 }
4847
Andy Whitcroft8905a672007-11-28 16:21:06 -08004848 # In mailback mode only produce a report in the negative, for
4849 # things that appear to be patches.
4850 if ($mailback && ($clean == 1 || !$is_patch)) {
4851 exit(0);
4852 }
4853
4854 # This is not a patch, and we are are in 'no-patch' mode so
4855 # just keep quiet.
4856 if (!$chk_patch && !$is_patch) {
4857 exit(0);
4858 }
4859
4860 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004861 ERROR("NOT_UNIFIED_DIFF",
4862 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004863 }
4864 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004865 ERROR("MISSING_SIGN_OFF",
4866 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004867 }
4868
Andy Whitcroft8905a672007-11-28 16:21:06 -08004869 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004870 if ($summary && !($clean == 1 && $quiet == 1)) {
4871 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004872 print "total: $cnt_error errors, $cnt_warn warnings, " .
4873 (($check)? "$cnt_chk checks, " : "") .
4874 "$cnt_lines lines checked\n";
4875 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004876 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004877
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004878 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004879
4880 if ($^V lt 5.10.0) {
4881 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4882 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4883 }
4884
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004885 # If there were whitespace errors which cleanpatch can fix
4886 # then suggest that.
4887 if ($rpt_cleaners) {
4888 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4889 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004890 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004891 }
4892 }
4893
Joe Perches91bfe482013-09-11 14:23:59 -07004894 hash_show_words(\%use_type, "Used");
4895 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004896
Joe Perches3705ce52013-07-03 15:05:31 -07004897 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004898 my $newfile = $filename;
4899 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004900 my $linecount = 0;
4901 my $f;
4902
4903 open($f, '>', $newfile)
4904 or die "$P: Can't open $newfile for write\n";
4905 foreach my $fixed_line (@fixed) {
4906 $linecount++;
4907 if ($file) {
4908 if ($linecount > 3) {
4909 $fixed_line =~ s/^\+//;
4910 print $f $fixed_line. "\n";
4911 }
4912 } else {
4913 print $f $fixed_line . "\n";
4914 }
4915 }
4916 close($f);
4917
4918 if (!$quiet) {
4919 print << "EOM";
4920Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4921
4922Do _NOT_ trust the results written to this file.
4923Do _NOT_ submit these changes without inspecting them for correctness.
4924
4925This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4926No warranties, expressed or implied...
4927
4928EOM
4929 }
4930 }
4931
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004932 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004933 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004934 }
4935 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004936 print << "EOM";
4937$vname has style problems, please review.
4938
4939If any of these errors are false positives, please report
4940them to the maintainer, see CHECKPATCH in MAINTAINERS.
4941EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004942 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004943
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004944 return $clean;
4945}