blob: 7c290693b8af680d6331f6fdd9c690beba5373e4 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
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 Whitcroft0a920b52007-06-01 00:46:48 -0700120GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700121 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -0700161if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700162 print "$P: no input files\n";
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Perchese970b882013-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 Whitcroft00df3442007-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 = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700586my @fixed_inserted = ();
587my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700588my $fixlinenr = -1;
589
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800590my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700591for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800592 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700593 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800594 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700595 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800596 } elsif ($filename eq '-') {
597 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700598 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800599 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700600 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700601 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800602 if ($filename eq '-') {
603 $vname = 'Your patch';
604 } else {
605 $vname = $filename;
606 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800607 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700608 chomp;
609 push(@rawlines, $_);
610 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800611 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800612 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700613 $exit = 1;
614 }
615 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800616 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700617 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700618 @fixed_inserted = ();
619 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700620 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700621}
622
623exit($exit);
624
625sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700626 my ($root) = @_;
627
628 my @tree_check = (
629 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
630 "README", "Documentation", "arch", "include", "drivers",
631 "fs", "init", "ipc", "kernel", "lib", "scripts",
632 );
633
634 foreach my $check (@tree_check) {
635 if (! -e $root . '/' . $check) {
636 return 0;
637 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700638 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700639 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700640}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700641
Joe Perches20112472011-07-25 17:13:23 -0700642sub parse_email {
643 my ($formatted_email) = @_;
644
645 my $name = "";
646 my $address = "";
647 my $comment = "";
648
649 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
650 $name = $1;
651 $address = $2;
652 $comment = $3 if defined $3;
653 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
654 $address = $1;
655 $comment = $2 if defined $2;
656 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
657 $address = $1;
658 $comment = $2 if defined $2;
659 $formatted_email =~ s/$address.*$//;
660 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700661 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700662 $name =~ s/^\"|\"$//g;
663 # If there's a name left after stripping spaces and
664 # leading quotes, and the address doesn't have both
665 # leading and trailing angle brackets, the address
666 # is invalid. ie:
667 # "joe smith joe@smith.com" bad
668 # "joe smith <joe@smith.com" bad
669 if ($name ne "" && $address !~ /^<[^>]+>$/) {
670 $name = "";
671 $address = "";
672 $comment = "";
673 }
674 }
675
Joe Perches3705ce52013-07-03 15:05:31 -0700676 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700677 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700678 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700679 $address =~ s/^\<|\>$//g;
680
681 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
682 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
683 $name = "\"$name\"";
684 }
685
686 return ($name, $address, $comment);
687}
688
689sub format_email {
690 my ($name, $address) = @_;
691
692 my $formatted_email;
693
Joe Perches3705ce52013-07-03 15:05:31 -0700694 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700695 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700696 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700697
698 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
699 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
700 $name = "\"$name\"";
701 }
702
703 if ("$name" eq "") {
704 $formatted_email = "$address";
705 } else {
706 $formatted_email = "$name <$address>";
707 }
708
709 return $formatted_email;
710}
711
Joe Perchesd311cd42014-08-06 16:10:57 -0700712sub which {
713 my ($bin) = @_;
714
715 foreach my $path (split(/:/, $ENV{PATH})) {
716 if (-e "$path/$bin") {
717 return "$path/$bin";
718 }
719 }
720
721 return "";
722}
723
Joe Perches000d1cc12011-07-25 17:13:25 -0700724sub which_conf {
725 my ($conf) = @_;
726
727 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
728 if (-e "$path/$conf") {
729 return "$path/$conf";
730 }
731 }
732
733 return "";
734}
735
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700736sub expand_tabs {
737 my ($str) = @_;
738
739 my $res = '';
740 my $n = 0;
741 for my $c (split(//, $str)) {
742 if ($c eq "\t") {
743 $res .= ' ';
744 $n++;
745 for (; ($n % 8) != 0; $n++) {
746 $res .= ' ';
747 }
748 next;
749 }
750 $res .= $c;
751 $n++;
752 }
753
754 return $res;
755}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700756sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700757 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700758 return $res;
759}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700760
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700761sub line_stats {
762 my ($line) = @_;
763
764 # Drop the diff line leader and expand tabs
765 $line =~ s/^.//;
766 $line = expand_tabs($line);
767
768 # Pick the indent from the front of the line.
769 my ($white) = ($line =~ /^(\s*)/);
770
771 return (length($line), length($white));
772}
773
Andy Whitcroft773647a2008-03-28 14:15:58 -0700774my $sanitise_quote = '';
775
776sub sanitise_line_reset {
777 my ($in_comment) = @_;
778
779 if ($in_comment) {
780 $sanitise_quote = '*/';
781 } else {
782 $sanitise_quote = '';
783 }
784}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700785sub sanitise_line {
786 my ($line) = @_;
787
788 my $res = '';
789 my $l = '';
790
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800791 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700792 my $off = 0;
793 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700794
Andy Whitcroft773647a2008-03-28 14:15:58 -0700795 # Always copy over the diff marker.
796 $res = substr($line, 0, 1);
797
798 for ($off = 1; $off < length($line); $off++) {
799 $c = substr($line, $off, 1);
800
801 # Comments we are wacking completly including the begin
802 # and end, all to $;.
803 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
804 $sanitise_quote = '*/';
805
806 substr($res, $off, 2, "$;$;");
807 $off++;
808 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800809 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700810 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700811 $sanitise_quote = '';
812 substr($res, $off, 2, "$;$;");
813 $off++;
814 next;
815 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700816 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
817 $sanitise_quote = '//';
818
819 substr($res, $off, 2, $sanitise_quote);
820 $off++;
821 next;
822 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700823
824 # A \ in a string means ignore the next character.
825 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
826 $c eq "\\") {
827 substr($res, $off, 2, 'XX');
828 $off++;
829 next;
830 }
831 # Regular quotes.
832 if ($c eq "'" || $c eq '"') {
833 if ($sanitise_quote eq '') {
834 $sanitise_quote = $c;
835
836 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700837 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700838 } elsif ($sanitise_quote eq $c) {
839 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700840 }
841 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700842
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800843 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700844 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
845 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700846 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
847 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700848 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
849 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700850 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700851 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700852 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800853 }
854
Daniel Walker113f04a2009-09-21 17:04:35 -0700855 if ($sanitise_quote eq '//') {
856 $sanitise_quote = '';
857 }
858
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700860 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800861 my $clean = 'X' x length($1);
862 $res =~ s@\<.*\>@<$clean>@;
863
864 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700865 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800866 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700867 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800868 }
869
Andy Whitcroft00df3442007-06-08 13:47:06 -0700870 return $res;
871}
872
Joe Perchesa6962d72013-04-29 16:18:13 -0700873sub get_quoted_string {
874 my ($line, $rawline) = @_;
875
876 return "" if ($line !~ m/(\"[X]+\")/g);
877 return substr($rawline, $-[0], $+[0] - $-[0]);
878}
879
Andy Whitcroft8905a672007-11-28 16:21:06 -0800880sub ctx_statement_block {
881 my ($linenr, $remain, $off) = @_;
882 my $line = $linenr - 1;
883 my $blk = '';
884 my $soff = $off;
885 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700886 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800887
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800888 my $loff = 0;
889
Andy Whitcroft8905a672007-11-28 16:21:06 -0800890 my $type = '';
891 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800892 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800893 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800894 my $c;
895 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800896
897 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800898 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800899 @stack = (['', 0]) if ($#stack == -1);
900
Andy Whitcroft773647a2008-03-28 14:15:58 -0700901 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800902 # If we are about to drop off the end, pull in more
903 # context.
904 if ($off >= $len) {
905 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700906 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800908 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800909 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800910 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800911 $len = length($blk);
912 $line++;
913 last;
914 }
915 # Bail if there is no further context.
916 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800917 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800918 last;
919 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800920 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
921 $level++;
922 $type = '#';
923 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800924 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800925 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800926 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800927 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800928
Andy Whitcroft773647a2008-03-28 14:15:58 -0700929 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800930
931 # Handle nested #if/#else.
932 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
933 push(@stack, [ $type, $level ]);
934 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
935 ($type, $level) = @{$stack[$#stack - 1]};
936 } elsif ($remainder =~ /^#\s*endif\b/) {
937 ($type, $level) = @{pop(@stack)};
938 }
939
Andy Whitcroft8905a672007-11-28 16:21:06 -0800940 # Statement ends at the ';' or a close '}' at the
941 # outermost level.
942 if ($level == 0 && $c eq ';') {
943 last;
944 }
945
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800946 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700947 if ($level == 0 && $coff_set == 0 &&
948 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
949 $remainder =~ /^(else)(?:\s|{)/ &&
950 $remainder !~ /^else\s+if\b/) {
951 $coff = $off + length($1) - 1;
952 $coff_set = 1;
953 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
954 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800955 }
956
Andy Whitcroft8905a672007-11-28 16:21:06 -0800957 if (($type eq '' || $type eq '(') && $c eq '(') {
958 $level++;
959 $type = '(';
960 }
961 if ($type eq '(' && $c eq ')') {
962 $level--;
963 $type = ($level != 0)? '(' : '';
964
965 if ($level == 0 && $coff < $soff) {
966 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700967 $coff_set = 1;
968 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800969 }
970 }
971 if (($type eq '' || $type eq '{') && $c eq '{') {
972 $level++;
973 $type = '{';
974 }
975 if ($type eq '{' && $c eq '}') {
976 $level--;
977 $type = ($level != 0)? '{' : '';
978
979 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700980 if (substr($blk, $off + 1, 1) eq ';') {
981 $off++;
982 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800983 last;
984 }
985 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800986 # Preprocessor commands end at the newline unless escaped.
987 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
988 $level--;
989 $type = '';
990 $off++;
991 last;
992 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800993 $off++;
994 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700995 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800996 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700997 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800998 $line++;
999 $remain--;
1000 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001001
1002 my $statement = substr($blk, $soff, $off - $soff + 1);
1003 my $condition = substr($blk, $soff, $coff - $soff + 1);
1004
1005 #warn "STATEMENT<$statement>\n";
1006 #warn "CONDITION<$condition>\n";
1007
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001009
1010 return ($statement, $condition,
1011 $line, $remain + 1, $off - $loff + 1, $level);
1012}
1013
Andy Whitcroftcf655042008-03-04 14:28:20 -08001014sub statement_lines {
1015 my ($stmt) = @_;
1016
1017 # Strip the diff line prefixes and rip blank lines at start and end.
1018 $stmt =~ s/(^|\n)./$1/g;
1019 $stmt =~ s/^\s*//;
1020 $stmt =~ s/\s*$//;
1021
1022 my @stmt_lines = ($stmt =~ /\n/g);
1023
1024 return $#stmt_lines + 2;
1025}
1026
1027sub statement_rawlines {
1028 my ($stmt) = @_;
1029
1030 my @stmt_lines = ($stmt =~ /\n/g);
1031
1032 return $#stmt_lines + 2;
1033}
1034
1035sub statement_block_size {
1036 my ($stmt) = @_;
1037
1038 $stmt =~ s/(^|\n)./$1/g;
1039 $stmt =~ s/^\s*{//;
1040 $stmt =~ s/}\s*$//;
1041 $stmt =~ s/^\s*//;
1042 $stmt =~ s/\s*$//;
1043
1044 my @stmt_lines = ($stmt =~ /\n/g);
1045 my @stmt_statements = ($stmt =~ /;/g);
1046
1047 my $stmt_lines = $#stmt_lines + 2;
1048 my $stmt_statements = $#stmt_statements + 1;
1049
1050 if ($stmt_lines > $stmt_statements) {
1051 return $stmt_lines;
1052 } else {
1053 return $stmt_statements;
1054 }
1055}
1056
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001057sub ctx_statement_full {
1058 my ($linenr, $remain, $off) = @_;
1059 my ($statement, $condition, $level);
1060
1061 my (@chunks);
1062
Andy Whitcroftcf655042008-03-04 14:28:20 -08001063 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001064 ($statement, $condition, $linenr, $remain, $off, $level) =
1065 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001066 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001067 push(@chunks, [ $condition, $statement ]);
1068 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1069 return ($level, $linenr, @chunks);
1070 }
1071
1072 # Pull in the following conditional/block pairs and see if they
1073 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001074 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001075 ($statement, $condition, $linenr, $remain, $off, $level) =
1076 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001077 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001078 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001079 #print "C: push\n";
1080 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001081 }
1082
1083 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001084}
1085
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001086sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001087 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001088 my $line;
1089 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001090 my $blk = '';
1091 my @o;
1092 my @c;
1093 my @res = ();
1094
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001095 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001096 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001097 for ($line = $start; $remain > 0; $line++) {
1098 next if ($rawlines[$line] =~ /^-/);
1099 $remain--;
1100
1101 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001102
1103 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001104 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001105 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001106 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001107 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001108 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001109 $level = pop(@stack);
1110 }
1111
Andy Whitcroft01464f32010-10-26 14:23:19 -07001112 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001113 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1114 if ($off > 0) {
1115 $off--;
1116 next;
1117 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001118
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001119 if ($c eq $close && $level > 0) {
1120 $level--;
1121 last if ($level == 0);
1122 } elsif ($c eq $open) {
1123 $level++;
1124 }
1125 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001126
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001127 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001128 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001129 }
1130
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001131 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001132 }
1133
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001134 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001135}
1136sub ctx_block_outer {
1137 my ($linenr, $remain) = @_;
1138
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001139 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1140 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001141}
1142sub ctx_block {
1143 my ($linenr, $remain) = @_;
1144
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001145 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1146 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001147}
1148sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001149 my ($linenr, $remain, $off) = @_;
1150
1151 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1152 return @r;
1153}
1154sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001155 my ($linenr, $remain) = @_;
1156
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001157 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001158}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001159sub ctx_statement_level {
1160 my ($linenr, $remain, $off) = @_;
1161
1162 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1163}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001164
1165sub ctx_locate_comment {
1166 my ($first_line, $end_line) = @_;
1167
1168 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001169 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001170 return $current_comment if (defined $current_comment);
1171
1172 # Look through the context and try and figure out if there is a
1173 # comment.
1174 my $in_comment = 0;
1175 $current_comment = '';
1176 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001177 my $line = $rawlines[$linenr - 1];
1178 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001179 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1180 $in_comment = 1;
1181 }
1182 if ($line =~ m@/\*@) {
1183 $in_comment = 1;
1184 }
1185 if (!$in_comment && $current_comment ne '') {
1186 $current_comment = '';
1187 }
1188 $current_comment .= $line . "\n" if ($in_comment);
1189 if ($line =~ m@\*/@) {
1190 $in_comment = 0;
1191 }
1192 }
1193
1194 chomp($current_comment);
1195 return($current_comment);
1196}
1197sub ctx_has_comment {
1198 my ($first_line, $end_line) = @_;
1199 my $cmt = ctx_locate_comment($first_line, $end_line);
1200
Andy Whitcroft00df3442007-06-08 13:47:06 -07001201 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001202 ##print "CMMT: $cmt\n";
1203
1204 return ($cmt ne '');
1205}
1206
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001207sub raw_line {
1208 my ($linenr, $cnt) = @_;
1209
1210 my $offset = $linenr - 1;
1211 $cnt++;
1212
1213 my $line;
1214 while ($cnt) {
1215 $line = $rawlines[$offset++];
1216 next if (defined($line) && $line =~ /^-/);
1217 $cnt--;
1218 }
1219
1220 return $line;
1221}
1222
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001223sub cat_vet {
1224 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001225 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001226
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001227 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001228 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1229 $res .= $1;
1230 if ($2 ne '') {
1231 $coded = sprintf("^%c", unpack('C', $2) + 64);
1232 $res .= $coded;
1233 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001234 }
1235 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001236
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001237 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001238}
1239
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001240my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001241my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001242my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001243my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001244
1245sub annotate_reset {
1246 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001247 $av_pending = '_';
1248 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001249 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001250}
1251
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001252sub annotate_values {
1253 my ($stream, $type) = @_;
1254
1255 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001256 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001257 my $cur = $stream;
1258
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001259 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001260
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001261 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001262 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001263 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001264 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001265 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001266 print "WS($1)\n" if ($dbg_values > 1);
1267 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001268 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001269 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001270 }
1271
Florian Micklerc023e4732011-01-12 16:59:58 -08001272 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001273 print "CAST($1)\n" if ($dbg_values > 1);
1274 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001275 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001276
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001277 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001278 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001279 $type = 'T';
1280
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001281 } elsif ($cur =~ /^($Modifier)\s*/) {
1282 print "MODIFIER($1)\n" if ($dbg_values > 1);
1283 $type = 'T';
1284
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001285 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001286 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001287 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001288 push(@av_paren_type, $type);
1289 if ($2 ne '') {
1290 $av_pending = 'N';
1291 }
1292 $type = 'E';
1293
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001294 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001295 print "UNDEF($1)\n" if ($dbg_values > 1);
1296 $av_preprocessor = 1;
1297 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001298
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001299 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001300 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001301 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001302
1303 push(@av_paren_type, $type);
1304 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001305 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001306
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001307 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001308 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1309 $av_preprocessor = 1;
1310
1311 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1312
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001313 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001314
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001315 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001316 print "PRE_END($1)\n" if ($dbg_values > 1);
1317
1318 $av_preprocessor = 1;
1319
1320 # Assume all arms of the conditional end as this
1321 # one does, and continue as if the #endif was not here.
1322 pop(@av_paren_type);
1323 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001324 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001325
1326 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001327 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001328
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001329 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1330 print "ATTR($1)\n" if ($dbg_values > 1);
1331 $av_pending = $type;
1332 $type = 'N';
1333
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001334 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001335 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001336 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001337 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001338 }
1339 $type = 'N';
1340
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001341 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001342 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001343 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001344 $type = 'N';
1345
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001346 } elsif ($cur =~/^(case)/o) {
1347 print "CASE($1)\n" if ($dbg_values > 1);
1348 $av_pend_colon = 'C';
1349 $type = 'N';
1350
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001351 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001352 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001353 $type = 'N';
1354
1355 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001356 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001357 push(@av_paren_type, $av_pending);
1358 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001359 $type = 'N';
1360
1361 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001362 my $new_type = pop(@av_paren_type);
1363 if ($new_type ne '_') {
1364 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001365 print "PAREN('$1') -> $type\n"
1366 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001367 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001368 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001369 }
1370
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001371 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001372 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001373 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001374 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001375
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001376 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1377 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001378 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001379 } elsif ($type eq 'E') {
1380 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001381 }
1382 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1383 $type = 'V';
1384
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001385 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001386 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001387 $type = 'V';
1388
1389 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001390 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001391 $type = 'N';
1392
Andy Whitcroftcf655042008-03-04 14:28:20 -08001393 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001394 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001395 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001396 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001397
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001398 } elsif ($cur =~/^(,)/) {
1399 print "COMMA($1)\n" if ($dbg_values > 1);
1400 $type = 'C';
1401
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001402 } elsif ($cur =~ /^(\?)/o) {
1403 print "QUESTION($1)\n" if ($dbg_values > 1);
1404 $type = 'N';
1405
1406 } elsif ($cur =~ /^(:)/o) {
1407 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1408
1409 substr($var, length($res), 1, $av_pend_colon);
1410 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1411 $type = 'E';
1412 } else {
1413 $type = 'N';
1414 }
1415 $av_pend_colon = 'O';
1416
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001417 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001418 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001419 $type = 'N';
1420
Andy Whitcroft0d413862008-10-15 22:02:16 -07001421 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001422 my $variant;
1423
1424 print "OPV($1)\n" if ($dbg_values > 1);
1425 if ($type eq 'V') {
1426 $variant = 'B';
1427 } else {
1428 $variant = 'U';
1429 }
1430
1431 substr($var, length($res), 1, $variant);
1432 $type = 'N';
1433
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001434 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001435 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001436 if ($1 ne '++' && $1 ne '--') {
1437 $type = 'N';
1438 }
1439
1440 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001441 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001442 }
1443 if (defined $1) {
1444 $cur = substr($cur, length($1));
1445 $res .= $type x length($1);
1446 }
1447 }
1448
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001449 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001450}
1451
Andy Whitcroft8905a672007-11-28 16:21:06 -08001452sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001453 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001454 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001455 ^(?:
1456 $Modifier|
1457 $Storage|
1458 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001459 DEFINE_\S+
1460 )$|
1461 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001462 goto|
1463 return|
1464 case|
1465 else|
1466 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001467 do|
1468 \#|
1469 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001470 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001471 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001472 )}x;
1473 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1474 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001475 # Check for modifiers.
1476 $possible =~ s/\s*$Storage\s*//g;
1477 $possible =~ s/\s*$Sparse\s*//g;
1478 if ($possible =~ /^\s*$/) {
1479
1480 } elsif ($possible =~ /\s/) {
1481 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001482 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001483 if ($modifier !~ $notPermitted) {
1484 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1485 push(@modifierList, $modifier);
1486 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001487 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001488
1489 } else {
1490 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1491 push(@typeList, $possible);
1492 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001493 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001494 } else {
1495 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001496 }
1497}
1498
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001499my $prefix = '';
1500
Joe Perches000d1cc12011-07-25 17:13:25 -07001501sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001502 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001503
Joe Perchescbec18a2014-04-03 14:49:19 -07001504 return defined $use_type{$type} if (scalar keys %use_type > 0);
1505
1506 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001507}
1508
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001509sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001510 my ($level, $type, $msg) = @_;
1511
1512 if (!show_type($type) ||
1513 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001514 return 0;
1515 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001516 my $line;
1517 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001518 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001519 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001520 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001521 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001522 $line = (split('\n', $line))[0] . "\n" if ($terse);
1523
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001524 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001525
1526 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001527}
Joe Perchescbec18a2014-04-03 14:49:19 -07001528
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001529sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001530 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001531}
Joe Perches000d1cc12011-07-25 17:13:25 -07001532
Joe Perchesd752fcc2014-08-06 16:11:05 -07001533sub fixup_current_range {
1534 my ($lineRef, $offset, $length) = @_;
1535
1536 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1537 my $o = $1;
1538 my $l = $2;
1539 my $no = $o + $offset;
1540 my $nl = $l + $length;
1541 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1542 }
1543}
1544
1545sub fix_inserted_deleted_lines {
1546 my ($linesRef, $insertedRef, $deletedRef) = @_;
1547
1548 my $range_last_linenr = 0;
1549 my $delta_offset = 0;
1550
1551 my $old_linenr = 0;
1552 my $new_linenr = 0;
1553
1554 my $next_insert = 0;
1555 my $next_delete = 0;
1556
1557 my @lines = ();
1558
1559 my $inserted = @{$insertedRef}[$next_insert++];
1560 my $deleted = @{$deletedRef}[$next_delete++];
1561
1562 foreach my $old_line (@{$linesRef}) {
1563 my $save_line = 1;
1564 my $line = $old_line; #don't modify the array
1565 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1566 $delta_offset = 0;
1567 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1568 $range_last_linenr = $new_linenr;
1569 fixup_current_range(\$line, $delta_offset, 0);
1570 }
1571
1572 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1573 $deleted = @{$deletedRef}[$next_delete++];
1574 $save_line = 0;
1575 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1576 }
1577
1578 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1579 push(@lines, ${$inserted}{'LINE'});
1580 $inserted = @{$insertedRef}[$next_insert++];
1581 $new_linenr++;
1582 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1583 }
1584
1585 if ($save_line) {
1586 push(@lines, $line);
1587 $new_linenr++;
1588 }
1589
1590 $old_linenr++;
1591 }
1592
1593 return @lines;
1594}
1595
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001596sub fix_insert_line {
1597 my ($linenr, $line) = @_;
1598
1599 my $inserted = {
1600 LINENR => $linenr,
1601 LINE => $line,
1602 };
1603 push(@fixed_inserted, $inserted);
1604}
1605
1606sub fix_delete_line {
1607 my ($linenr, $line) = @_;
1608
1609 my $deleted = {
1610 LINENR => $linenr,
1611 LINE => $line,
1612 };
1613
1614 push(@fixed_deleted, $deleted);
1615}
1616
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001617sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001618 my ($type, $msg) = @_;
1619
1620 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001621 our $clean = 0;
1622 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001623 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001624 }
Joe Perches3705ce52013-07-03 15:05:31 -07001625 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001626}
1627sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001628 my ($type, $msg) = @_;
1629
1630 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001631 our $clean = 0;
1632 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001633 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001634 }
Joe Perches3705ce52013-07-03 15:05:31 -07001635 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001636}
1637sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001638 my ($type, $msg) = @_;
1639
1640 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001641 our $clean = 0;
1642 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001643 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644 }
Joe Perches3705ce52013-07-03 15:05:31 -07001645 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001646}
1647
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001648sub check_absolute_file {
1649 my ($absolute, $herecurr) = @_;
1650 my $file = $absolute;
1651
1652 ##print "absolute<$absolute>\n";
1653
1654 # See if any suffix of this path is a path within the tree.
1655 while ($file =~ s@^[^/]*/@@) {
1656 if (-f "$root/$file") {
1657 ##print "file<$file>\n";
1658 last;
1659 }
1660 }
1661 if (! -f _) {
1662 return 0;
1663 }
1664
1665 # It is, so see if the prefix is acceptable.
1666 my $prefix = $absolute;
1667 substr($prefix, -length($file)) = '';
1668
1669 ##print "prefix<$prefix>\n";
1670 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001671 WARN("USE_RELATIVE_PATH",
1672 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001673 }
1674}
1675
Joe Perches3705ce52013-07-03 15:05:31 -07001676sub trim {
1677 my ($string) = @_;
1678
Joe Perchesb34c6482013-09-11 14:24:01 -07001679 $string =~ s/^\s+|\s+$//g;
1680
1681 return $string;
1682}
1683
1684sub ltrim {
1685 my ($string) = @_;
1686
1687 $string =~ s/^\s+//;
1688
1689 return $string;
1690}
1691
1692sub rtrim {
1693 my ($string) = @_;
1694
1695 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001696
1697 return $string;
1698}
1699
Joe Perches52ea8502013-11-12 15:10:09 -08001700sub string_find_replace {
1701 my ($string, $find, $replace) = @_;
1702
1703 $string =~ s/$find/$replace/g;
1704
1705 return $string;
1706}
1707
Joe Perches3705ce52013-07-03 15:05:31 -07001708sub tabify {
1709 my ($leading) = @_;
1710
1711 my $source_indent = 8;
1712 my $max_spaces_before_tab = $source_indent - 1;
1713 my $spaces_to_tab = " " x $source_indent;
1714
1715 #convert leading spaces to tabs
1716 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1717 #Remove spaces before a tab
1718 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1719
1720 return "$leading";
1721}
1722
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001723sub pos_last_openparen {
1724 my ($line) = @_;
1725
1726 my $pos = 0;
1727
1728 my $opens = $line =~ tr/\(/\(/;
1729 my $closes = $line =~ tr/\)/\)/;
1730
1731 my $last_openparen = 0;
1732
1733 if (($opens == 0) || ($closes >= $opens)) {
1734 return -1;
1735 }
1736
1737 my $len = length($line);
1738
1739 for ($pos = 0; $pos < $len; $pos++) {
1740 my $string = substr($line, $pos);
1741 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1742 $pos += length($1) - 1;
1743 } elsif (substr($line, $pos, 1) eq '(') {
1744 $last_openparen = $pos;
1745 } elsif (index($string, '(') == -1) {
1746 last;
1747 }
1748 }
1749
Joe Perches91cb5192014-04-03 14:49:32 -07001750 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001751}
1752
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001753sub process {
1754 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001755
1756 my $linenr=0;
1757 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001758 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001759 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001761
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001762 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001763 my $indent;
1764 my $previndent=0;
1765 my $stashindent=0;
1766
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001767 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001768 my $signoff = 0;
1769 my $is_patch = 0;
1770
Joe Perches29ee1b02014-08-06 16:10:35 -07001771 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001772 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001773 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001774 my $non_utf8_charset = 0;
1775
Joe Perches365dd4e2014-08-06 16:10:42 -07001776 my $last_blank_line = 0;
1777
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001778 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001779 our $cnt_lines = 0;
1780 our $cnt_error = 0;
1781 our $cnt_warn = 0;
1782 our $cnt_chk = 0;
1783
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001784 # Trace the real file/line as we go.
1785 my $realfile = '';
1786 my $realline = 0;
1787 my $realcnt = 0;
1788 my $here = '';
1789 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001790 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001791 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001792 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001793
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001794 my $prev_values = 'E';
1795
1796 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001797 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001798 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001799 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001800 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001801
Joe Perches7e51f192013-09-11 14:23:57 -07001802 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001803
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001804 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001805 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001806 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001807 my @setup_docs = ();
1808 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001809
Joe Perchesd8b07712013-11-12 15:10:06 -08001810 my $camelcase_file_seeded = 0;
1811
Andy Whitcroft773647a2008-03-28 14:15:58 -07001812 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001813 my $line;
1814 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001815 $linenr++;
1816 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001817
Joe Perches3705ce52013-07-03 15:05:31 -07001818 push(@fixed, $rawline) if ($fix);
1819
Andy Whitcroft773647a2008-03-28 14:15:58 -07001820 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001821 $setup_docs = 0;
1822 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1823 $setup_docs = 1;
1824 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001825 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001826 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001827 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1828 $realline=$1-1;
1829 if (defined $2) {
1830 $realcnt=$3+1;
1831 } else {
1832 $realcnt=1+1;
1833 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001834 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001835
1836 # Guestimate if this is a continuing comment. Run
1837 # the context looking for a comment "edge". If this
1838 # edge is a close comment then we must be in a comment
1839 # at context start.
1840 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001841 my $cnt = $realcnt;
1842 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1843 next if (defined $rawlines[$ln - 1] &&
1844 $rawlines[$ln - 1] =~ /^-/);
1845 $cnt--;
1846 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001847 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001848 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1849 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1850 ($edge) = $1;
1851 last;
1852 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001853 }
1854 if (defined $edge && $edge eq '*/') {
1855 $in_comment = 1;
1856 }
1857
1858 # Guestimate if this is a continuing comment. If this
1859 # is the start of a diff block and this line starts
1860 # ' *' then it is very likely a comment.
1861 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001862 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001863 {
1864 $in_comment = 1;
1865 }
1866
1867 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1868 sanitise_line_reset($in_comment);
1869
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001870 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001871 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001872 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001873 $line = sanitise_line($rawline);
1874 }
1875 push(@lines, $line);
1876
1877 if ($realcnt > 1) {
1878 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1879 } else {
1880 $realcnt = 0;
1881 }
1882
1883 #print "==>$rawline\n";
1884 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001885
1886 if ($setup_docs && $line =~ /^\+/) {
1887 push(@setup_docs, $line);
1888 }
1889 }
1890
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001891 $prefix = '';
1892
Andy Whitcroft773647a2008-03-28 14:15:58 -07001893 $realcnt = 0;
1894 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001895 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001896 foreach my $line (@lines) {
1897 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001898 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001899 my $sline = $line; #copy of $line
1900 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001901
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001902 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001903
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001904#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001905 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001906 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001907 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001908 $realline=$1-1;
1909 if (defined $2) {
1910 $realcnt=$3+1;
1911 } else {
1912 $realcnt=1+1;
1913 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001914 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001915 $prev_values = 'E';
1916
Andy Whitcroft773647a2008-03-28 14:15:58 -07001917 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001918 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001919 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001920 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001921 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001922
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001923# track the line number as we move through the hunk, note that
1924# new versions of GNU diff omit the leading space on completely
1925# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001926 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001927 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001928 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001929
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001930 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001931 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001932
1933 # Track the previous line.
1934 ($prevline, $stashline) = ($stashline, $line);
1935 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001936 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1937
Andy Whitcroft773647a2008-03-28 14:15:58 -07001938 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001939
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001940 } elsif ($realcnt == 1) {
1941 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001942 }
1943
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001944 my $hunk_line = ($realcnt != 0);
1945
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001946#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001947 $prefix = "$filename:$realline: " if ($emacs && $file);
1948 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1949
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001950 $here = "#$linenr: " if (!$file);
1951 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001952
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001953 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001954 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001955 if ($line =~ /^diff --git.*?(\S+)$/) {
1956 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001957 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001958 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001959 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001960 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001961 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001962 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001963 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001964
1965 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001966 if (!$file && $tree && $p1_prefix ne '' &&
1967 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001968 WARN("PATCH_PREFIX",
1969 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001970 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001971
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001972 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001973 ERROR("MODIFIED_INCLUDE_ASM",
1974 "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 -07001975 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001976 $found_file = 1;
1977 }
1978
1979 if ($found_file) {
1980 if ($realfile =~ m@^(drivers/net/|net/)@) {
1981 $check = 1;
1982 } else {
1983 $check = $check_orig;
1984 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001985 next;
1986 }
1987
Randy Dunlap389834b2007-06-08 13:47:03 -07001988 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001989
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001990 my $hereline = "$here\n$rawline\n";
1991 my $herecurr = "$here\n$rawline\n";
1992 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001993
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001994 $cnt_lines++ if ($realcnt != 0);
1995
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001996# Check for incorrect file permissions
1997 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1998 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001999 if ($realfile !~ m@scripts/@ &&
2000 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002001 ERROR("EXECUTE_PERMISSIONS",
2002 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002003 }
2004 }
2005
Joe Perches20112472011-07-25 17:13:23 -07002006# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002007 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002008 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002009 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002010 }
2011
2012# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002013 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002014 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002015 my $space_before = $1;
2016 my $sign_off = $2;
2017 my $space_after = $3;
2018 my $email = $4;
2019 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2020
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002021 if ($sign_off !~ /$signature_tags/) {
2022 WARN("BAD_SIGN_OFF",
2023 "Non-standard signature: $sign_off\n" . $herecurr);
2024 }
Joe Perches20112472011-07-25 17:13:23 -07002025 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002026 if (WARN("BAD_SIGN_OFF",
2027 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2028 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002029 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002030 "$ucfirst_sign_off $email";
2031 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002032 }
Joe Perches20112472011-07-25 17:13:23 -07002033 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002034 if (WARN("BAD_SIGN_OFF",
2035 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2036 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002037 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002038 "$ucfirst_sign_off $email";
2039 }
2040
Joe Perches20112472011-07-25 17:13:23 -07002041 }
2042 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002043 if (WARN("BAD_SIGN_OFF",
2044 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2045 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002046 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002047 "$ucfirst_sign_off $email";
2048 }
Joe Perches20112472011-07-25 17:13:23 -07002049 }
2050
2051 my ($email_name, $email_address, $comment) = parse_email($email);
2052 my $suggested_email = format_email(($email_name, $email_address));
2053 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002054 ERROR("BAD_SIGN_OFF",
2055 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002056 } else {
2057 my $dequoted = $suggested_email;
2058 $dequoted =~ s/^"//;
2059 $dequoted =~ s/" </ </;
2060 # Don't force email to have quotes
2061 # Allow just an angle bracketed address
2062 if ("$dequoted$comment" ne $email &&
2063 "<$email_address>$comment" ne $email &&
2064 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002065 WARN("BAD_SIGN_OFF",
2066 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002067 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002068 }
Joe Perches7e51f192013-09-11 14:23:57 -07002069
2070# Check for duplicate signatures
2071 my $sig_nospace = $line;
2072 $sig_nospace =~ s/\s//g;
2073 $sig_nospace = lc($sig_nospace);
2074 if (defined $signatures{$sig_nospace}) {
2075 WARN("BAD_SIGN_OFF",
2076 "Duplicate signature\n" . $herecurr);
2077 } else {
2078 $signatures{$sig_nospace} = 1;
2079 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002080 }
2081
Joe Perches9b3189e2014-06-04 16:12:10 -07002082# Check for old stable address
2083 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2084 ERROR("STABLE_ADDRESS",
2085 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2086 }
2087
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002088# Check for unwanted Gerrit info
2089 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2090 ERROR("GERRIT_CHANGE_ID",
2091 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2092 }
2093
Joe Perchesd311cd42014-08-06 16:10:57 -07002094# Check for improperly formed commit descriptions
2095 if ($in_commit_log &&
2096 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
2097 $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) {
2098 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2099 my $init_char = $1;
2100 my $orig_commit = lc($2);
2101 my $id = '01234567890ab';
2102 my $desc = 'commit description';
2103 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2104 ERROR("GIT_COMMIT_ID",
2105 "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2106 }
2107
Joe Perches13f19372014-08-06 16:10:59 -07002108# Check for added, moved or deleted files
2109 if (!$reported_maintainer_file && !$in_commit_log &&
2110 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2111 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2112 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2113 (defined($1) || defined($2))))) {
2114 $reported_maintainer_file = 1;
2115 WARN("FILE_PATH_CHANGES",
2116 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2117 }
2118
Andy Whitcroft00df3442007-06-08 13:47:06 -07002119# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002120 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002121 ERROR("CORRUPTED_PATCH",
2122 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002123 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002124 }
2125
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002126# Check for absolute kernel paths.
2127 if ($tree) {
2128 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2129 my $file = $1;
2130
2131 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2132 check_absolute_file($1, $herecurr)) {
2133 #
2134 } else {
2135 check_absolute_file($file, $herecurr);
2136 }
2137 }
2138 }
2139
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002140# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2141 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002142 $rawline !~ m/^$UTF8*$/) {
2143 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2144
2145 my $blank = copy_spacing($rawline);
2146 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2147 my $hereptr = "$hereline$ptr\n";
2148
Joe Perches34d99212011-07-25 17:13:26 -07002149 CHK("INVALID_UTF8",
2150 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002151 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002152
Joe Perches15662b32011-10-31 17:13:12 -07002153# Check if it's the start of a commit log
2154# (not a header line and we haven't seen the patch filename)
2155 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002156 !($rawline =~ /^\s+\S/ ||
2157 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002158 $in_header_lines = 0;
2159 $in_commit_log = 1;
2160 }
2161
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002162# Check if there is UTF-8 in a commit log when a mail header has explicitly
2163# declined it, i.e defined some charset where it is missing.
2164 if ($in_header_lines &&
2165 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2166 $1 !~ /utf-8/i) {
2167 $non_utf8_charset = 1;
2168 }
2169
2170 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002171 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002172 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002173 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2174 }
2175
Andy Whitcroft306708542008-10-15 22:02:28 -07002176# ignore non-hunk lines and lines being removed
2177 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002178
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002179#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002180 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002181 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002182 if (ERROR("DOS_LINE_ENDINGS",
2183 "DOS line endings\n" . $herevet) &&
2184 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002185 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002186 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002187 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2188 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002189 if (ERROR("TRAILING_WHITESPACE",
2190 "trailing whitespace\n" . $herevet) &&
2191 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002192 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002193 }
2194
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002195 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002196 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002197
Josh Triplett4783f892013-11-12 15:10:12 -08002198# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002199 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002200 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2201 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002202 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2203 my $msg_type = \&ERROR;
2204 $msg_type = \&CHK if ($file);
2205 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002206 "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 -08002207 }
2208
Andi Kleen33549572010-05-24 14:33:29 -07002209# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002210# Only applies when adding the entry originally, after that we do not have
2211# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002212 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002213 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002214 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002215 my $cnt = $realcnt;
2216 my $ln = $linenr + 1;
2217 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002218 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002219 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002220 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002221 $f = $lines[$ln - 1];
2222 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2223 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002224
2225 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002226 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002227
Joe Perches8d73e0e2014-08-06 16:10:46 -07002228 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002229 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002230 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002231 $length = -1;
2232 }
2233
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002234 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002235 $f =~ s/#.*//;
2236 $f =~ s/^\s+//;
2237 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002238 if ($f =~ /^\s*config\s/) {
2239 $is_end = 1;
2240 last;
2241 }
Andi Kleen33549572010-05-24 14:33:29 -07002242 $length++;
2243 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002244 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002245 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2246 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002247 }
2248
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002249# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2250 if ($realfile =~ /Kconfig/ &&
2251 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2252 WARN("CONFIG_EXPERIMENTAL",
2253 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2254 }
2255
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002256 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2257 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2258 my $flag = $1;
2259 my $replacement = {
2260 'EXTRA_AFLAGS' => 'asflags-y',
2261 'EXTRA_CFLAGS' => 'ccflags-y',
2262 'EXTRA_CPPFLAGS' => 'cppflags-y',
2263 'EXTRA_LDFLAGS' => 'ldflags-y',
2264 };
2265
2266 WARN("DEPRECATED_VARIABLE",
2267 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2268 }
2269
Rob Herringbff5da42014-01-23 15:54:51 -08002270# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002271 if (defined $root &&
2272 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2273 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2274
Rob Herringbff5da42014-01-23 15:54:51 -08002275 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2276
Florian Vaussardcc933192014-04-03 14:49:27 -07002277 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2278 my $vp_file = $dt_path . "vendor-prefixes.txt";
2279
Rob Herringbff5da42014-01-23 15:54:51 -08002280 foreach my $compat (@compats) {
2281 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002282 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2283 my $compat3 = $compat;
2284 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2285 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002286 if ( $? >> 8 ) {
2287 WARN("UNDOCUMENTED_DT_STRING",
2288 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2289 }
2290
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002291 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2292 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002293 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002294 if ( $? >> 8 ) {
2295 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002296 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002297 }
2298 }
2299 }
2300
Andy Whitcroft5368df22008-10-15 22:02:27 -07002301# check we are in a valid source file if not then ignore this hunk
2302 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2303
Joe Perches6cd7f382012-12-17 16:01:54 -08002304#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002305 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002306 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002307 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002308 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002309 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002310 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002311 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002312 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002313 }
2314
Josh Triplettca56dc02012-03-23 15:02:21 -07002315# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002316# to grep for the string. Make exceptions when the previous string ends in a
2317# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2318# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002319 if ($line =~ /^\+\s*"/ &&
2320 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002321 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002322 WARN("SPLIT_STRING",
2323 "quoted string split across lines\n" . $hereprev);
2324 }
2325
Joe Perches5e79d962010-03-05 13:43:55 -08002326# check for spaces before a quoted newline
2327 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002328 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2329 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2330 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002331 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
Joe Perches3705ce52013-07-03 15:05:31 -07002332 }
2333
Joe Perches5e79d962010-03-05 13:43:55 -08002334 }
2335
Andy Whitcroft8905a672007-11-28 16:21:06 -08002336# check for adding lines without a newline.
2337 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002338 WARN("MISSING_EOF_NEWLINE",
2339 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002340 }
2341
Mike Frysinger42e41c52009-09-21 17:04:40 -07002342# Blackfin: use hi/lo macros
2343 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2344 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2345 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002346 ERROR("LO_MACRO",
2347 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002348 }
2349 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2350 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002351 ERROR("HI_MACRO",
2352 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002353 }
2354 }
2355
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002356# check we are in a valid source file C or perl if not then ignore this hunk
2357 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002358
2359# at the beginning of a line any tabs must come first and anything
2360# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002361 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2362 $rawline =~ /^\+\s* \s*/) {
2363 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002364 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002365 if (ERROR("CODE_INDENT",
2366 "code indent should use tabs where possible\n" . $herevet) &&
2367 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002368 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002369 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002370 }
2371
Alberto Panizzo08e44362010-03-05 13:43:54 -08002372# check for space before tabs.
2373 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2374 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002375 if (WARN("SPACE_BEFORE_TAB",
2376 "please, no space before tabs\n" . $herevet) &&
2377 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002378 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002379 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002380 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002381 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002382 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002383 }
2384
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002385# check for && or || at the start of a line
2386 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2387 CHK("LOGICAL_CONTINUATIONS",
2388 "Logical continuations should be on the previous line\n" . $hereprev);
2389 }
2390
2391# check multi-line statement indentation matches previous line
2392 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002393 $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 -07002394 $prevline =~ /^\+(\t*)(.*)$/;
2395 my $oldindent = $1;
2396 my $rest = $2;
2397
2398 my $pos = pos_last_openparen($rest);
2399 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002400 $line =~ /^(\+| )([ \t]*)/;
2401 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002402
2403 my $goodtabindent = $oldindent .
2404 "\t" x ($pos / 8) .
2405 " " x ($pos % 8);
2406 my $goodspaceindent = $oldindent . " " x $pos;
2407
2408 if ($newindent ne $goodtabindent &&
2409 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002410
2411 if (CHK("PARENTHESIS_ALIGNMENT",
2412 "Alignment should match open parenthesis\n" . $hereprev) &&
2413 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002414 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002415 s/^\+[ \t]*/\+$goodtabindent/;
2416 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002417 }
2418 }
2419 }
2420
Joe Perchesf27c95d2014-08-06 16:10:52 -07002421 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002422 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002423 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002424 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002425 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002426 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002427 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002428 }
2429
Joe Perches05880602012-10-04 17:13:35 -07002430 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002431 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002432 $rawline =~ /^\+[ \t]*\*/ &&
2433 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002434 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2435 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2436 }
2437
2438 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002439 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2440 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002441 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002442 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2443 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2444 "networking block comments start with * on subsequent lines\n" . $hereprev);
2445 }
2446
2447 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002448 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2449 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2450 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2451 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002452 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2453 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2454 }
2455
Joe Perches7f619192014-08-06 16:10:39 -07002456# check for missing blank lines after struct/union declarations
2457# with exceptions for various attributes and macros
2458 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2459 $line =~ /^\+/ &&
2460 !($line =~ /^\+\s*$/ ||
2461 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2462 $line =~ /^\+\s*MODULE_/i ||
2463 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2464 $line =~ /^\+[a-z_]*init/ ||
2465 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2466 $line =~ /^\+\s*DECLARE/ ||
2467 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002468 if (CHK("LINE_SPACING",
2469 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2470 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002471 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002472 }
Joe Perches7f619192014-08-06 16:10:39 -07002473 }
2474
Joe Perches365dd4e2014-08-06 16:10:42 -07002475# check for multiple consecutive blank lines
2476 if ($prevline =~ /^[\+ ]\s*$/ &&
2477 $line =~ /^\+\s*$/ &&
2478 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002479 if (CHK("LINE_SPACING",
2480 "Please don't use multiple blank lines\n" . $hereprev) &&
2481 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002482 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002483 }
2484
Joe Perches365dd4e2014-08-06 16:10:42 -07002485 $last_blank_line = $linenr;
2486 }
2487
Joe Perches3b617e32014-04-03 14:49:28 -07002488# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002489 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2490 # actual declarations
2491 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002492 # function pointer declarations
2493 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002494 # foo bar; where foo is some local typedef or #define
2495 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2496 # known declaration macros
2497 $prevline =~ /^\+\s+$declaration_macros/) &&
2498 # for "else if" which can look like "$Ident $Ident"
2499 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2500 # other possible extensions of declaration lines
2501 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2502 # not starting a section or a macro "\" extended line
2503 $prevline =~ /(?:\{\s*|\\)$/) &&
2504 # looks like a declaration
2505 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002506 # function pointer declarations
2507 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002508 # foo bar; where foo is some local typedef or #define
2509 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2510 # known declaration macros
2511 $sline =~ /^\+\s+$declaration_macros/ ||
2512 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002513 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002514 # start or end of block or continuation of declaration
2515 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2516 # bitfield continuation
2517 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2518 # other possible extensions of declaration lines
2519 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2520 # indentation of previous and current line are the same
2521 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002522 if (WARN("LINE_SPACING",
2523 "Missing a blank line after declarations\n" . $hereprev) &&
2524 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002525 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002526 }
Joe Perches3b617e32014-04-03 14:49:28 -07002527 }
2528
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002529# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002530# Exceptions:
2531# 1) within comments
2532# 2) indented preprocessor commands
2533# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002534 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002535 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002536 if (WARN("LEADING_SPACE",
2537 "please, no spaces at the start of a line\n" . $herevet) &&
2538 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002539 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002540 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002541 }
2542
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002543# check we are in a valid C source file if not then ignore this hunk
2544 next if ($realfile !~ /\.(h|c)$/);
2545
Joe Perches032a4c02014-08-06 16:10:29 -07002546# check indentation of any line with a bare else
2547# if the previous line is a break or return and is indented 1 tab more...
2548 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2549 my $tabs = length($1) + 1;
2550 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2551 WARN("UNNECESSARY_ELSE",
2552 "else is not generally useful after a break or return\n" . $hereprev);
2553 }
2554 }
2555
Joe Perchesc00df192014-08-06 16:11:01 -07002556# check indentation of a line with a break;
2557# if the previous line is a goto or return and is indented the same # of tabs
2558 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2559 my $tabs = $1;
2560 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2561 WARN("UNNECESSARY_BREAK",
2562 "break is not useful after a goto or return\n" . $hereprev);
2563 }
2564 }
2565
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002566# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2567 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2568 WARN("CONFIG_EXPERIMENTAL",
2569 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2570 }
2571
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002572# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002573 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002574 WARN("CVS_KEYWORD",
2575 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002576 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002577
Mike Frysinger42e41c52009-09-21 17:04:40 -07002578# Blackfin: don't use __builtin_bfin_[cs]sync
2579 if ($line =~ /__builtin_bfin_csync/) {
2580 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002581 ERROR("CSYNC",
2582 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002583 }
2584 if ($line =~ /__builtin_bfin_ssync/) {
2585 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002586 ERROR("SSYNC",
2587 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002588 }
2589
Joe Perches56e77d72013-02-21 16:44:14 -08002590# check for old HOTPLUG __dev<foo> section markings
2591 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2592 WARN("HOTPLUG_SECTION",
2593 "Using $1 is unnecessary\n" . $herecurr);
2594 }
2595
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002596# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002597 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2598 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002599#print "LINE<$line>\n";
2600 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002601 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002602 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002603 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002604 $stat =~ s/\n./\n /g;
2605 $cond =~ s/\n./\n /g;
2606
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002607#print "linenr<$linenr> <$stat>\n";
2608 # If this statement has no statement boundaries within
2609 # it there is no point in retrying a statement scan
2610 # until we hit end of it.
2611 my $frag = $stat; $frag =~ s/;+\s*$//;
2612 if ($frag !~ /(?:{|;)/) {
2613#print "skip<$line_nr_next>\n";
2614 $suppress_statement = $line_nr_next;
2615 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002616
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002617 # Find the real next line.
2618 $realline_next = $line_nr_next;
2619 if (defined $realline_next &&
2620 (!defined $lines[$realline_next - 1] ||
2621 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2622 $realline_next++;
2623 }
2624
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002625 my $s = $stat;
2626 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002627
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002628 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002629 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002630
2631 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002632 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002633
Andy Whitcroft463f2862009-09-21 17:04:34 -07002634 } elsif ($s =~ /^.\s*else\b/s) {
2635
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002636 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002637 } 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 -07002638 my $type = $1;
2639 $type =~ s/\s+/ /g;
2640 possible($type, "A:" . $s);
2641
Andy Whitcroft8905a672007-11-28 16:21:06 -08002642 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002643 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002644 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002645 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002646
2647 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002648 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002649 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002650 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002651
2652 # Check for any sort of function declaration.
2653 # int foo(something bar, other baz);
2654 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002655 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 -08002656 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002657
Andy Whitcroftcf655042008-03-04 14:28:20 -08002658 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002659 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002660 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002661
Andy Whitcroft8905a672007-11-28 16:21:06 -08002662 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002663 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002664
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002665 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002666 }
2667 }
2668 }
2669
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002670 }
2671
Andy Whitcroft653d4872007-06-23 17:16:34 -07002672#
2673# Checks which may be anchored in the context.
2674#
2675
2676# Check for switch () and associated case and default
2677# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002678 if ($line=~/\bswitch\s*\(.*\)/) {
2679 my $err = '';
2680 my $sep = '';
2681 my @ctx = ctx_block_outer($linenr, $realcnt);
2682 shift(@ctx);
2683 for my $ctx (@ctx) {
2684 my ($clen, $cindent) = line_stats($ctx);
2685 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2686 $indent != $cindent) {
2687 $err .= "$sep$ctx\n";
2688 $sep = '';
2689 } else {
2690 $sep = "[...]\n";
2691 }
2692 }
2693 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002694 ERROR("SWITCH_CASE_INDENT_LEVEL",
2695 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002696 }
2697 }
2698
2699# if/while/etc brace do not go on next line, unless defining a do while loop,
2700# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002701 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002702 my $pre_ctx = "$1$2";
2703
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002704 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002705
2706 if ($line =~ /^\+\t{6,}/) {
2707 WARN("DEEP_INDENTATION",
2708 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2709 }
2710
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002711 my $ctx_cnt = $realcnt - $#ctx - 1;
2712 my $ctx = join("\n", @ctx);
2713
Andy Whitcroft548596d2008-07-23 21:29:01 -07002714 my $ctx_ln = $linenr;
2715 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002716
Andy Whitcroft548596d2008-07-23 21:29:01 -07002717 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2718 defined $lines[$ctx_ln - 1] &&
2719 $lines[$ctx_ln - 1] =~ /^-/)) {
2720 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2721 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002722 $ctx_ln++;
2723 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002724
Andy Whitcroft53210162008-07-23 21:29:03 -07002725 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2726 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002727
Joe Perchesd752fcc2014-08-06 16:11:05 -07002728 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002729 ERROR("OPEN_BRACE",
2730 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002731 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002732 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002733 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2734 $ctx =~ /\)\s*\;\s*$/ &&
2735 defined $lines[$ctx_ln - 1])
2736 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002737 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2738 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002739 WARN("TRAILING_SEMICOLON",
2740 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002741 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002742 }
2743 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002744 }
2745
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002746# Check relative indent for conditionals and blocks.
2747 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002748 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2749 ctx_statement_block($linenr, $realcnt, 0)
2750 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002751 my ($s, $c) = ($stat, $cond);
2752
2753 substr($s, 0, length($c), '');
2754
2755 # Make sure we remove the line prefixes as we have
2756 # none on the first line, and are going to readd them
2757 # where necessary.
2758 $s =~ s/\n./\n/gs;
2759
2760 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002761 my @newlines = ($c =~ /\n/gs);
2762 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002763
2764 # We want to check the first line inside the block
2765 # starting at the end of the conditional, so remove:
2766 # 1) any blank line termination
2767 # 2) any opening brace { on end of the line
2768 # 3) any do (...) {
2769 my $continuation = 0;
2770 my $check = 0;
2771 $s =~ s/^.*\bdo\b//;
2772 $s =~ s/^\s*{//;
2773 if ($s =~ s/^\s*\\//) {
2774 $continuation = 1;
2775 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002776 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002777 $check = 1;
2778 $cond_lines++;
2779 }
2780
2781 # Also ignore a loop construct at the end of a
2782 # preprocessor statement.
2783 if (($prevline =~ /^.\s*#\s*define\s/ ||
2784 $prevline =~ /\\\s*$/) && $continuation == 0) {
2785 $check = 0;
2786 }
2787
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002788 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002789 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002790 while ($cond_ptr != $cond_lines) {
2791 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002792
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002793 # If we see an #else/#elif then the code
2794 # is not linear.
2795 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2796 $check = 0;
2797 }
2798
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002799 # Ignore:
2800 # 1) blank lines, they should be at 0,
2801 # 2) preprocessor lines, and
2802 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002803 if ($continuation ||
2804 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002805 $s =~ /^\s*#\s*?/ ||
2806 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002807 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002808 if ($s =~ s/^.*?\n//) {
2809 $cond_lines++;
2810 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002811 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002812 }
2813
2814 my (undef, $sindent) = line_stats("+" . $s);
2815 my $stat_real = raw_line($linenr, $cond_lines);
2816
2817 # Check if either of these lines are modified, else
2818 # this is not this patch's fault.
2819 if (!defined($stat_real) ||
2820 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2821 $check = 0;
2822 }
2823 if (defined($stat_real) && $cond_lines > 1) {
2824 $stat_real = "[...]\n$stat_real";
2825 }
2826
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002827 #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 -07002828
2829 if ($check && (($sindent % 8) != 0 ||
2830 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002831 WARN("SUSPECT_CODE_INDENT",
2832 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002833 }
2834 }
2835
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002836 # Track the 'values' across context and added lines.
2837 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002838 my ($curr_values, $curr_vars) =
2839 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002840 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002841 if ($dbg_values) {
2842 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002843 print "$linenr > .$outline\n";
2844 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002845 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002846 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002847 $prev_values = substr($curr_values, -1);
2848
Andy Whitcroft00df3442007-06-08 13:47:06 -07002849#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002850 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002851
Andy Whitcroft653d4872007-06-23 17:16:34 -07002852# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002853 if ($dbg_type) {
2854 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002855 ERROR("TEST_TYPE",
2856 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002857 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002858 ERROR("TEST_NOT_TYPE",
2859 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002860 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002861 next;
2862 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002863# TEST: allow direct testing of the attribute matcher.
2864 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002865 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002866 ERROR("TEST_ATTR",
2867 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002868 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002869 ERROR("TEST_NOT_ATTR",
2870 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002871 }
2872 next;
2873 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002874
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002875# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002876 if ($line =~ /^.\s*{/ &&
2877 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002878 if (ERROR("OPEN_BRACE",
2879 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002880 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
2881 fix_delete_line($fixlinenr - 1, $prevrawline);
2882 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002883 my $fixedline = $prevrawline;
2884 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002885 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002886 $fixedline = $line;
2887 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002888 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002889 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002890 }
2891
Andy Whitcroft653d4872007-06-23 17:16:34 -07002892#
2893# Checks which are anchored on the added line.
2894#
2895
2896# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002897 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002898 my $path = $1;
2899 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002900 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002901 "malformed #include filename\n" . $herecurr);
2902 }
2903 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2904 ERROR("UAPI_INCLUDE",
2905 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002906 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002907 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002908
2909# no C99 // comments
2910 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002911 if (ERROR("C99_COMMENTS",
2912 "do not use C99 // comments\n" . $herecurr) &&
2913 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002914 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07002915 if ($line =~ /\/\/(.*)$/) {
2916 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07002917 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07002918 }
2919 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002920 }
2921 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002922 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002923 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002924
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002925# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2926# the whole statement.
2927#print "APW <$lines[$realline_next - 1]>\n";
2928 if (defined $realline_next &&
2929 exists $lines[$realline_next - 1] &&
2930 !defined $suppress_export{$realline_next} &&
2931 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2932 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002933 # Handle definitions which produce identifiers with
2934 # a prefix:
2935 # XXX(foo);
2936 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002937 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002938 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002939 $name =~ /^${Ident}_$2/) {
2940#print "FOO C name<$name>\n";
2941 $suppress_export{$realline_next} = 1;
2942
2943 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002944 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002945 ^.DEFINE_$Ident\(\Q$name\E\)|
2946 ^.DECLARE_$Ident\(\Q$name\E\)|
2947 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002948 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2949 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002950 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002951#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2952 $suppress_export{$realline_next} = 2;
2953 } else {
2954 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002955 }
2956 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002957 if (!defined $suppress_export{$linenr} &&
2958 $prevline =~ /^.\s*$/ &&
2959 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2960 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2961#print "FOO B <$lines[$linenr - 1]>\n";
2962 $suppress_export{$linenr} = 2;
2963 }
2964 if (defined $suppress_export{$linenr} &&
2965 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002966 WARN("EXPORT_SYMBOL",
2967 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002968 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002969
Joe Eloff5150bda2010-08-09 17:21:00 -07002970# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002971 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2972 if (ERROR("GLOBAL_INITIALISERS",
2973 "do not initialise globals to 0 or NULL\n" .
2974 $herecurr) &&
2975 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002976 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002977 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002978 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002979# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002980 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2981 if (ERROR("INITIALISED_STATIC",
2982 "do not initialise statics to 0 or NULL\n" .
2983 $herecurr) &&
2984 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002985 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002986 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002987 }
2988
Joe Perchescb710ec2010-10-26 14:23:20 -07002989# check for static const char * arrays.
2990 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002991 WARN("STATIC_CONST_CHAR_ARRAY",
2992 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002993 $herecurr);
2994 }
2995
2996# check for static char foo[] = "bar" declarations.
2997 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002998 WARN("STATIC_CONST_CHAR_ARRAY",
2999 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003000 $herecurr);
3001 }
3002
Joe Perches9b0fa602014-04-03 14:49:18 -07003003# check for non-global char *foo[] = {"bar", ...} declarations.
3004 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3005 WARN("STATIC_CONST_CHAR_ARRAY",
3006 "char * array declaration might be better as static const\n" .
3007 $herecurr);
3008 }
3009
Joe Perchesb36190c2014-01-27 17:07:18 -08003010# check for function declarations without arguments like "int foo()"
3011 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3012 if (ERROR("FUNCTION_WITHOUT_ARGS",
3013 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3014 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003015 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003016 }
3017 }
3018
Joe Perches92e112f2013-12-13 11:36:22 -07003019# check for uses of DEFINE_PCI_DEVICE_TABLE
3020 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3021 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3022 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3023 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003024 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
Joe Perches92e112f2013-12-13 11:36:22 -07003025 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003026 }
3027
Andy Whitcroft653d4872007-06-23 17:16:34 -07003028# check for new typedefs, only function parameters and sparse annotations
3029# make sense.
3030 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003031 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003032 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003033 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003034 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003035 WARN("NEW_TYPEDEFS",
3036 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003037 }
3038
3039# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003040 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003041 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3042 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003043 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003044
Andy Whitcroft65863862009-01-06 14:41:21 -08003045 # Should start with a space.
3046 $to =~ s/^(\S)/ $1/;
3047 # Should not end with a space.
3048 $to =~ s/\s+$//;
3049 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003050 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003051 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003052
Joe Perches3705ce52013-07-03 15:05:31 -07003053## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003054 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003055 if (ERROR("POINTER_LOCATION",
3056 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3057 $fix) {
3058 my $sub_from = $ident;
3059 my $sub_to = $ident;
3060 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003061 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003062 s@\Q$sub_from\E@$sub_to@;
3063 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003064 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003065 }
3066 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3067 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003068 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003069
Andy Whitcroft65863862009-01-06 14:41:21 -08003070 # Should start with a space.
3071 $to =~ s/^(\S)/ $1/;
3072 # Should not end with a space.
3073 $to =~ s/\s+$//;
3074 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003075 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003076 }
3077 # Modifiers should have spaces.
3078 $to =~ s/(\b$Modifier$)/$1 /;
3079
Joe Perches3705ce52013-07-03 15:05:31 -07003080## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003081 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003082 if (ERROR("POINTER_LOCATION",
3083 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3084 $fix) {
3085
3086 my $sub_from = $match;
3087 my $sub_to = $match;
3088 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003089 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003090 s@\Q$sub_from\E@$sub_to@;
3091 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003092 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003093 }
3094
3095# # no BUG() or BUG_ON()
3096# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3097# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3098# print "$herecurr";
3099# $clean = 0;
3100# }
3101
Andy Whitcroft8905a672007-11-28 16:21:06 -08003102 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003103 WARN("LINUX_VERSION_CODE",
3104 "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 -08003105 }
3106
Joe Perches17441222011-06-15 15:08:17 -07003107# check for uses of printk_ratelimit
3108 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003109 WARN("PRINTK_RATELIMITED",
3110"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003111 }
3112
Andy Whitcroft00df3442007-06-08 13:47:06 -07003113# printk should use KERN_* levels. Note that follow on printk's on the
3114# same line do not need a level, so we use the current block context
3115# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003116# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003117# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003118 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003119 my $ok = 0;
3120 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3121 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003122 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003123 # with "\n" ignore it, else it is to blame
3124 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3125 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3126 $ok = 1;
3127 }
3128 last;
3129 }
3130 }
3131 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003132 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3133 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003134 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003135 }
3136
Joe Perches243f3802012-05-31 16:26:09 -07003137 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3138 my $orig = $1;
3139 my $level = lc($orig);
3140 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003141 my $level2 = $level;
3142 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003143 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003144 "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 -07003145 }
3146
3147 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003148 if (WARN("PREFER_PR_LEVEL",
3149 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3150 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003151 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003152 s/\bpr_warning\b/pr_warn/;
3153 }
Joe Perches243f3802012-05-31 16:26:09 -07003154 }
3155
Joe Perchesdc139312013-02-21 16:44:13 -08003156 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3157 my $orig = $1;
3158 my $level = lc($orig);
3159 $level = "warn" if ($level eq "warning");
3160 $level = "dbg" if ($level eq "debug");
3161 WARN("PREFER_DEV_LEVEL",
3162 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3163 }
3164
Andy Whitcroft653d4872007-06-23 17:16:34 -07003165# function brace can't be on same line, except for #defines of do while,
3166# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003167 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
3168 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003169 ERROR("OPEN_BRACE",
3170 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003171 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003172
Andy Whitcroft8905a672007-11-28 16:21:06 -08003173# open braces for enum, union and struct go on the same line.
3174 if ($line =~ /^.\s*{/ &&
3175 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003176 ERROR("OPEN_BRACE",
3177 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003178 }
3179
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003180# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003181 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3182 if (WARN("SPACING",
3183 "missing space after $1 definition\n" . $herecurr) &&
3184 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003185 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003186 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3187 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003188 }
3189
Joe Perches31070b52014-01-23 15:54:49 -08003190# Function pointer declarations
3191# check spacing between type, funcptr, and args
3192# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003193 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003194 my $declare = $1;
3195 my $pre_pointer_space = $2;
3196 my $post_pointer_space = $3;
3197 my $funcname = $4;
3198 my $post_funcname_space = $5;
3199 my $pre_args_space = $6;
3200
Joe Perches91f72e92014-04-03 14:49:12 -07003201# the $Declare variable will capture all spaces after the type
3202# so check it for a missing trailing missing space but pointer return types
3203# don't need a space so don't warn for those.
3204 my $post_declare_space = "";
3205 if ($declare =~ /(\s+)$/) {
3206 $post_declare_space = $1;
3207 $declare = rtrim($declare);
3208 }
3209 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003210 WARN("SPACING",
3211 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003212 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003213 }
3214
3215# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003216# This test is not currently implemented because these declarations are
3217# equivalent to
3218# int foo(int bar, ...)
3219# and this is form shouldn't/doesn't generate a checkpatch warning.
3220#
3221# elsif ($declare =~ /\s{2,}$/) {
3222# WARN("SPACING",
3223# "Multiple spaces after return type\n" . $herecurr);
3224# }
Joe Perches31070b52014-01-23 15:54:49 -08003225
3226# unnecessary space "type ( *funcptr)(args...)"
3227 if (defined $pre_pointer_space &&
3228 $pre_pointer_space =~ /^\s/) {
3229 WARN("SPACING",
3230 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3231 }
3232
3233# unnecessary space "type (* funcptr)(args...)"
3234 if (defined $post_pointer_space &&
3235 $post_pointer_space =~ /^\s/) {
3236 WARN("SPACING",
3237 "Unnecessary space before function pointer name\n" . $herecurr);
3238 }
3239
3240# unnecessary space "type (*funcptr )(args...)"
3241 if (defined $post_funcname_space &&
3242 $post_funcname_space =~ /^\s/) {
3243 WARN("SPACING",
3244 "Unnecessary space after function pointer name\n" . $herecurr);
3245 }
3246
3247# unnecessary space "type (*funcptr) (args...)"
3248 if (defined $pre_args_space &&
3249 $pre_args_space =~ /^\s/) {
3250 WARN("SPACING",
3251 "Unnecessary space before function pointer arguments\n" . $herecurr);
3252 }
3253
3254 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003255 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003256 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003257 }
3258 }
3259
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003260# check for spacing round square brackets; allowed:
3261# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003262# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3263# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003264 while ($line =~ /(.*?\s)\[/g) {
3265 my ($where, $prefix) = ($-[1], $1);
3266 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003267 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003268 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003269 if (ERROR("BRACKET_SPACE",
3270 "space prohibited before open square bracket '['\n" . $herecurr) &&
3271 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003272 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003273 s/^(\+.*?)\s+\[/$1\[/;
3274 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003275 }
3276 }
3277
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003278# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003279 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003280 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003281 my $ctx_before = substr($line, 0, $-[1]);
3282 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003283
3284 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003285 if ($name =~ /^(?:
3286 if|for|while|switch|return|case|
3287 volatile|__volatile__|
3288 __attribute__|format|__extension__|
3289 asm|__asm__)$/x)
3290 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003291 # cpp #define statements have non-optional spaces, ie
3292 # if there is a space between the name and the open
3293 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003294 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003295
3296 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003297 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003298
3299 # If this whole things ends with a type its most
3300 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003301 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003302
3303 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003304 if (WARN("SPACING",
3305 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3306 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003307 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003308 s/\b$name\s+\(/$name\(/;
3309 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003310 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003311 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003312
Andy Whitcroft653d4872007-06-23 17:16:34 -07003313# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003314 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003315 my $fixed_line = "";
3316 my $line_fixed = 0;
3317
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003318 my $ops = qr{
3319 <<=|>>=|<=|>=|==|!=|
3320 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3321 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003322 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003323 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003324 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003325 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003326
3327## print("element count: <" . $#elements . ">\n");
3328## foreach my $el (@elements) {
3329## print("el: <$el>\n");
3330## }
3331
3332 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003333 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003334
Joe Perches3705ce52013-07-03 15:05:31 -07003335 foreach my $el (@elements) {
3336 push(@fix_elements, substr($rawline, $off, length($el)));
3337 $off += length($el);
3338 }
3339
3340 $off = 0;
3341
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003342 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003343 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003344
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003345 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003346
3347 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3348
3349## print("n: <$n> good: <$good>\n");
3350
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003351 $off += length($elements[$n]);
3352
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003353 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003354 my $ca = substr($opline, 0, $off);
3355 my $cc = '';
3356 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3357 $cc = substr($opline, $off + length($elements[$n + 1]));
3358 }
3359 my $cb = "$ca$;$cc";
3360
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003361 my $a = '';
3362 $a = 'V' if ($elements[$n] ne '');
3363 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003364 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003365 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3366 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003367 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003368
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003369 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003370
3371 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003372 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003373 $c = 'V' if ($elements[$n + 2] ne '');
3374 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003375 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003376 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3377 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003378 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003379 } else {
3380 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003381 }
3382
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003383 my $ctx = "${a}x${c}";
3384
3385 my $at = "(ctx:$ctx)";
3386
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003387 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003388 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003389
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003390 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003391 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003392
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003393 # Get the full operator variant.
3394 my $opv = $op . substr($curr_vars, $off, 1);
3395
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003396 # Ignore operators passed as parameters.
3397 if ($op_type ne 'V' &&
3398 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3399
Andy Whitcroftcf655042008-03-04 14:28:20 -08003400# # Ignore comments
3401# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003402
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003403 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003404 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003405 if ($ctx !~ /.x[WEBC]/ &&
3406 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003407 if (ERROR("SPACING",
3408 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003409 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003410 $line_fixed = 1;
3411 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003412 }
3413
3414 # // is a comment
3415 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003416
Joe Perchesb00e4812014-04-03 14:49:33 -07003417 # : when part of a bitfield
3418 } elsif ($opv eq ':B') {
3419 # skip the bitfield test for now
3420
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003421 # No spaces for:
3422 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003423 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003424 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003425 if (ERROR("SPACING",
3426 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003427 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003428 if (defined $fix_elements[$n + 2]) {
3429 $fix_elements[$n + 2] =~ s/^\s+//;
3430 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003431 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003432 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003433 }
3434
3435 # , must have a space on the right.
3436 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003437 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003438 if (ERROR("SPACING",
3439 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003440 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003441 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003442 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003443 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003444 }
3445
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003446 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003447 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003448 #warn "'*' is part of type\n";
3449
3450 # unary operators should have a space before and
3451 # none after. May be left adjacent to another
3452 # unary operator, or a cast
3453 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003454 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003455 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003456 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003457 if (ERROR("SPACING",
3458 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003459 if ($n != $last_after + 2) {
3460 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3461 $line_fixed = 1;
3462 }
Joe Perches3705ce52013-07-03 15:05:31 -07003463 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003464 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003465 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003466 # A unary '*' may be const
3467
3468 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003469 if (ERROR("SPACING",
3470 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003471 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003472 if (defined $fix_elements[$n + 2]) {
3473 $fix_elements[$n + 2] =~ s/^\s+//;
3474 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003475 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003476 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003477 }
3478
3479 # unary ++ and unary -- are allowed no space on one side.
3480 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003481 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003482 if (ERROR("SPACING",
3483 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003484 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003485 $line_fixed = 1;
3486 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003487 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003488 if ($ctx =~ /Wx[BE]/ ||
3489 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003490 if (ERROR("SPACING",
3491 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003492 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003493 $line_fixed = 1;
3494 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003495 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003496 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003497 if (ERROR("SPACING",
3498 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003499 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003500 if (defined $fix_elements[$n + 2]) {
3501 $fix_elements[$n + 2] =~ s/^\s+//;
3502 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003503 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003504 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003505 }
3506
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003507 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003508 } elsif ($op eq '<<' or $op eq '>>' or
3509 $op eq '&' or $op eq '^' or $op eq '|' or
3510 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003511 $op eq '*' or $op eq '/' or
3512 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003513 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003514 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003515 if (ERROR("SPACING",
3516 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003517 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3518 if (defined $fix_elements[$n + 2]) {
3519 $fix_elements[$n + 2] =~ s/^\s+//;
3520 }
Joe Perches3705ce52013-07-03 15:05:31 -07003521 $line_fixed = 1;
3522 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003523 }
3524
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003525 # A colon needs no spaces before when it is
3526 # terminating a case value or a label.
3527 } elsif ($opv eq ':C' || $opv eq ':L') {
3528 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003529 if (ERROR("SPACING",
3530 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003531 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003532 $line_fixed = 1;
3533 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003534 }
3535
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003536 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003537 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003538 my $ok = 0;
3539
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003540 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003541 if (($op eq '<' &&
3542 $cc =~ /^\S+\@\S+>/) ||
3543 ($op eq '>' &&
3544 $ca =~ /<\S+\@\S+$/))
3545 {
3546 $ok = 1;
3547 }
3548
Joe Perches84731622013-11-12 15:10:05 -08003549 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003550 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003551 my $msg_type = \&ERROR;
3552 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3553
3554 if (&{$msg_type}("SPACING",
3555 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003556 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3557 if (defined $fix_elements[$n + 2]) {
3558 $fix_elements[$n + 2] =~ s/^\s+//;
3559 }
Joe Perches3705ce52013-07-03 15:05:31 -07003560 $line_fixed = 1;
3561 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003562 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003563 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003564 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003565
3566## print("n: <$n> GOOD: <$good>\n");
3567
3568 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003569 }
Joe Perches3705ce52013-07-03 15:05:31 -07003570
3571 if (($#elements % 2) == 0) {
3572 $fixed_line = $fixed_line . $fix_elements[$#elements];
3573 }
3574
Joe Perches194f66f2014-08-06 16:11:03 -07003575 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3576 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003577 }
3578
3579
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003580 }
3581
Joe Perches786b6322013-07-03 15:05:32 -07003582# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003583 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003584 if (WARN("SPACING",
3585 "space prohibited before semicolon\n" . $herecurr) &&
3586 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003587 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003588 s/^(\+.*\S)\s+;/$1;/;
3589 }
3590 }
3591
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003592# check for multiple assignments
3593 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003594 CHK("MULTIPLE_ASSIGNMENTS",
3595 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003596 }
3597
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003598## # check for multiple declarations, allowing for a function declaration
3599## # continuation.
3600## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3601## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3602##
3603## # Remove any bracketed sections to ensure we do not
3604## # falsly report the parameters of functions.
3605## my $ln = $line;
3606## while ($ln =~ s/\([^\(\)]*\)//g) {
3607## }
3608## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003609## WARN("MULTIPLE_DECLARATION",
3610## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003611## }
3612## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003613
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003614#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003615 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3616 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003617 if (ERROR("SPACING",
3618 "space required before the open brace '{'\n" . $herecurr) &&
3619 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003620 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003621 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003622 }
3623
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003624## # check for blank lines before declarations
3625## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3626## $prevrawline =~ /^.\s*$/) {
3627## WARN("SPACING",
3628## "No blank lines before declarations\n" . $hereprev);
3629## }
3630##
3631
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003632# closing brace should have a space following it when it has anything
3633# on the line
3634 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003635 if (ERROR("SPACING",
3636 "space required after that close brace '}'\n" . $herecurr) &&
3637 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003638 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003639 s/}((?!(?:,|;|\)))\S)/} $1/;
3640 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003641 }
3642
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003643# check spacing on square brackets
3644 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003645 if (ERROR("SPACING",
3646 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3647 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003648 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003649 s/\[\s+/\[/;
3650 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003651 }
3652 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003653 if (ERROR("SPACING",
3654 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3655 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003656 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003657 s/\s+\]/\]/;
3658 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003659 }
3660
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003661# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003662 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3663 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003664 if (ERROR("SPACING",
3665 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3666 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003667 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003668 s/\(\s+/\(/;
3669 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003670 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003671 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003672 $line !~ /for\s*\(.*;\s+\)/ &&
3673 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003674 if (ERROR("SPACING",
3675 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3676 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003677 print("fixlinenr: <$fixlinenr> fixed[fixlinenr]: <$fixed[$fixlinenr]>\n");
3678 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003679 s/\s+\)/\)/;
3680 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003681 }
3682
Joe Perchese2826fd2014-08-06 16:10:48 -07003683# check unnecessary parentheses around addressof/dereference single $Lvals
3684# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3685
3686 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3687 CHK("UNNECESSARY_PARENTHESES",
3688 "Unnecessary parentheses around $1\n" . $herecurr);
3689 }
3690
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003691#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003692 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003693 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003694 if (WARN("INDENTED_LABEL",
3695 "labels should not be indented\n" . $herecurr) &&
3696 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003697 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003698 s/^(.)\s+/$1/;
3699 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003700 }
3701
Joe Perches5b9553a2014-04-03 14:49:21 -07003702# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003703 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003704 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003705 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003706 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3707 my $value = $1;
3708 $value = deparenthesize($value);
3709 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3710 ERROR("RETURN_PARENTHESES",
3711 "return is not a function, parentheses are not required\n" . $herecurr);
3712 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003713 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003714 ERROR("SPACING",
3715 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003716 }
3717 }
Joe Perches507e5142013-11-12 15:10:13 -08003718
Joe Perchesb43ae212014-06-23 13:22:07 -07003719# unnecessary return in a void function
3720# at end-of-function, with the previous line a single leading tab, then return;
3721# and the line before that not a goto label target like "out:"
3722 if ($sline =~ /^[ \+]}\s*$/ &&
3723 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3724 $linenr >= 3 &&
3725 $lines[$linenr - 3] =~ /^[ +]/ &&
3726 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003727 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003728 "void function return statements are not generally useful\n" . $hereprev);
3729 }
Joe Perches9819cf22014-06-04 16:12:09 -07003730
Joe Perches189248d2014-01-23 15:54:47 -08003731# if statements using unnecessary parentheses - ie: if ((foo == bar))
3732 if ($^V && $^V ge 5.10.0 &&
3733 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3734 my $openparens = $1;
3735 my $count = $openparens =~ tr@\(@\(@;
3736 my $msg = "";
3737 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3738 my $comp = $4; #Not $1 because of $LvalOrFunc
3739 $msg = " - maybe == should be = ?" if ($comp eq "==");
3740 WARN("UNNECESSARY_PARENTHESES",
3741 "Unnecessary parentheses$msg\n" . $herecurr);
3742 }
3743 }
3744
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003745# Return of what appears to be an errno should normally be -'ve
3746 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3747 my $name = $1;
3748 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003749 WARN("USE_NEGATIVE_ERRNO",
3750 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003751 }
3752 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003753
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003754# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003755 if ($line =~ /\b(if|while|for|switch)\(/) {
3756 if (ERROR("SPACING",
3757 "space required before the open parenthesis '('\n" . $herecurr) &&
3758 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003759 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003760 s/\b(if|while|for|switch)\(/$1 \(/;
3761 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003762 }
3763
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003764# Check for illegal assignment in if conditional -- and check for trailing
3765# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003766 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003767 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3768 ctx_statement_block($linenr, $realcnt, 0)
3769 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003770 my ($stat_next) = ctx_statement_block($line_nr_next,
3771 $remain_next, $off_next);
3772 $stat_next =~ s/\n./\n /g;
3773 ##print "stat<$stat> stat_next<$stat_next>\n";
3774
3775 if ($stat_next =~ /^\s*while\b/) {
3776 # If the statement carries leading newlines,
3777 # then count those as offsets.
3778 my ($whitespace) =
3779 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3780 my $offset =
3781 statement_rawlines($whitespace) - 1;
3782
3783 $suppress_whiletrailers{$line_nr_next +
3784 $offset} = 1;
3785 }
3786 }
3787 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003788 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003789 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003790 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003791
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003792 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003793 ERROR("ASSIGN_IN_IF",
3794 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003795 }
3796
3797 # Find out what is on the end of the line after the
3798 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003799 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003800 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003801 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003802 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3803 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003804 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003805 # Find out how long the conditional actually is.
3806 my @newlines = ($c =~ /\n/gs);
3807 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003808 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003809
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003810 $stat_real = raw_line($linenr, $cond_lines)
3811 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003812 if (defined($stat_real) && $cond_lines > 1) {
3813 $stat_real = "[...]\n$stat_real";
3814 }
3815
Joe Perches000d1cc12011-07-25 17:13:25 -07003816 ERROR("TRAILING_STATEMENTS",
3817 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003818 }
3819 }
3820
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003821# Check for bitwise tests written as boolean
3822 if ($line =~ /
3823 (?:
3824 (?:\[|\(|\&\&|\|\|)
3825 \s*0[xX][0-9]+\s*
3826 (?:\&\&|\|\|)
3827 |
3828 (?:\&\&|\|\|)
3829 \s*0[xX][0-9]+\s*
3830 (?:\&\&|\|\||\)|\])
3831 )/x)
3832 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003833 WARN("HEXADECIMAL_BOOLEAN_TEST",
3834 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003835 }
3836
Andy Whitcroft8905a672007-11-28 16:21:06 -08003837# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003838 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3839 my $s = $1;
3840 $s =~ s/$;//g; # Remove any comments
3841 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003842 ERROR("TRAILING_STATEMENTS",
3843 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003844 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003845 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003846# if should not continue a brace
3847 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003848 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07003849 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003850 $herecurr);
3851 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003852# case and default should not have general statements after them
3853 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3854 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003855 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003856 \s*return\s+
3857 )/xg)
3858 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003859 ERROR("TRAILING_STATEMENTS",
3860 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003861 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003862
3863 # Check for }<nl>else {, these must be at the same
3864 # indent level to be relevant to each other.
3865 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3866 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003867 ERROR("ELSE_AFTER_BRACE",
3868 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003869 }
3870
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003871 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3872 $previndent == $indent) {
3873 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3874
3875 # Find out what is on the end of the line after the
3876 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003877 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003878 $s =~ s/\n.*//g;
3879
3880 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003881 ERROR("WHILE_AFTER_BRACE",
3882 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003883 }
3884 }
3885
Joe Perches95e2c602013-07-03 15:05:20 -07003886#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003887 while ($line =~ m{($Constant|$Lval)}g) {
3888 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003889
3890#gcc binary extension
3891 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003892 if (WARN("GCC_BINARY_CONSTANT",
3893 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3894 $fix) {
3895 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07003896 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003897 s/\b$var\b/$hexval/;
3898 }
Joe Perches95e2c602013-07-03 15:05:20 -07003899 }
3900
3901#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003902 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003903 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003904#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003905 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003906#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003907 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003908 while ($var =~ m{($Ident)}g) {
3909 my $word = $1;
3910 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003911 if ($check) {
3912 seed_camelcase_includes();
3913 if (!$file && !$camelcase_file_seeded) {
3914 seed_camelcase_file($realfile);
3915 $camelcase_file_seeded = 1;
3916 }
3917 }
Joe Perches7e781f62013-09-11 14:23:55 -07003918 if (!defined $camelcase{$word}) {
3919 $camelcase{$word} = 1;
3920 CHK("CAMELCASE",
3921 "Avoid CamelCase: <$word>\n" . $herecurr);
3922 }
Joe Perches34456862013-07-03 15:05:34 -07003923 }
Joe Perches323c1262012-12-17 16:02:07 -08003924 }
3925 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003926
3927#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003928 if ($line =~ /\#\s*define.*\\\s+$/) {
3929 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3930 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3931 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003932 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003933 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003934 }
3935
Andy Whitcroft653d4872007-06-23 17:16:34 -07003936#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003937 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003938 my $file = "$1.h";
3939 my $checkfile = "include/linux/$file";
3940 if (-f "$root/$checkfile" &&
3941 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003942 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003943 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003944 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003945 CHK("ARCH_INCLUDE_LINUX",
3946 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003947 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003948 WARN("INCLUDE_LINUX",
3949 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003950 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003951 }
3952 }
3953
Andy Whitcroft653d4872007-06-23 17:16:34 -07003954# multi-statement macros should be enclosed in a do while loop, grab the
3955# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003956# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003957 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3958 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003959 my $ln = $linenr;
3960 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003961 my ($off, $dstat, $dcond, $rest);
3962 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003963 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003964 ctx_statement_block($linenr, $realcnt, 0);
3965 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003966 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003967 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003968
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003969 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003970 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003971 $dstat =~ s/\\\n.//g;
3972 $dstat =~ s/^\s*//s;
3973 $dstat =~ s/\s*$//s;
3974
3975 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003976 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3977 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003978 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003979 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003980 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003981
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003982 # Flatten any obvious string concatentation.
3983 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3984 $dstat =~ s/$Ident\s*("X*")/$1/)
3985 {
3986 }
3987
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003988 my $exceptions = qr{
3989 $Declare|
3990 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003991 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003992 DECLARE_PER_CPU|
3993 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003994 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003995 union|
3996 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003997 \.$Ident\s*=\s*|
3998 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003999 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004000 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004001 if ($dstat ne '' &&
4002 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4003 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004004 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004005 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004006 $dstat !~ /$exceptions/ &&
4007 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004008 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004009 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004010 $dstat !~ /^for\s*$Constant$/ && # for (...)
4011 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4012 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004013 $dstat !~ /^\({/ && # ({...
4014 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004015 {
4016 $ctx =~ s/\n*$//;
4017 my $herectx = $here . "\n";
4018 my $cnt = statement_rawlines($ctx);
4019
4020 for (my $n = 0; $n < $cnt; $n++) {
4021 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004022 }
4023
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004024 if ($dstat =~ /;/) {
4025 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4026 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4027 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004028 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004029 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004030 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004031 }
Joe Perches5023d342012-12-17 16:01:47 -08004032
Joe Perches481eb482012-12-17 16:01:56 -08004033# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004034
4035 } else {
4036 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004037 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4038 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004039 $line =~ /^\+.*\\$/) {
4040 WARN("LINE_CONTINUATIONS",
4041 "Avoid unnecessary line continuations\n" . $herecurr);
4042 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004043 }
4044
Joe Perchesb13edf72012-07-30 14:41:24 -07004045# do {} while (0) macro tests:
4046# single-statement macros do not need to be enclosed in do while (0) loop,
4047# macro should not end with a semicolon
4048 if ($^V && $^V ge 5.10.0 &&
4049 $realfile !~ m@/vmlinux.lds.h$@ &&
4050 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4051 my $ln = $linenr;
4052 my $cnt = $realcnt;
4053 my ($off, $dstat, $dcond, $rest);
4054 my $ctx = '';
4055 ($dstat, $dcond, $ln, $cnt, $off) =
4056 ctx_statement_block($linenr, $realcnt, 0);
4057 $ctx = $dstat;
4058
4059 $dstat =~ s/\\\n.//g;
4060
4061 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4062 my $stmts = $2;
4063 my $semis = $3;
4064
4065 $ctx =~ s/\n*$//;
4066 my $cnt = statement_rawlines($ctx);
4067 my $herectx = $here . "\n";
4068
4069 for (my $n = 0; $n < $cnt; $n++) {
4070 $herectx .= raw_line($linenr, $n) . "\n";
4071 }
4072
Joe Perchesac8e97f2012-08-21 16:15:53 -07004073 if (($stmts =~ tr/;/;/) == 1 &&
4074 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004075 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4076 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4077 }
4078 if (defined $semis && $semis ne "") {
4079 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4080 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4081 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004082 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4083 $ctx =~ s/\n*$//;
4084 my $cnt = statement_rawlines($ctx);
4085 my $herectx = $here . "\n";
4086
4087 for (my $n = 0; $n < $cnt; $n++) {
4088 $herectx .= raw_line($linenr, $n) . "\n";
4089 }
4090
4091 WARN("TRAILING_SEMICOLON",
4092 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004093 }
4094 }
4095
Mike Frysinger080ba922009-01-06 14:41:25 -08004096# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4097# all assignments may have only one of the following with an assignment:
4098# .
4099# ALIGN(...)
4100# VMLINUX_SYMBOL(...)
4101 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004102 WARN("MISSING_VMLINUX_SYMBOL",
4103 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004104 }
4105
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004106# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004107 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4108 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004109 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004110 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004111 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4112 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004113 my @allowed = ();
4114 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004115 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004116 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004117 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004118 for my $chunk (@chunks) {
4119 my ($cond, $block) = @{$chunk};
4120
Andy Whitcroft773647a2008-03-28 14:15:58 -07004121 # If the condition carries leading newlines, then count those as offsets.
4122 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4123 my $offset = statement_rawlines($whitespace) - 1;
4124
Joe Perchesaad4f612012-03-23 15:02:19 -07004125 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004126 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4127
4128 # We have looked at and allowed this specific line.
4129 $suppress_ifbraces{$ln + $offset} = 1;
4130
4131 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004132 $ln += statement_rawlines($block) - 1;
4133
Andy Whitcroft773647a2008-03-28 14:15:58 -07004134 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004135
4136 $seen++ if ($block =~ /^\s*{/);
4137
Joe Perchesaad4f612012-03-23 15:02:19 -07004138 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004139 if (statement_lines($cond) > 1) {
4140 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004141 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004142 }
4143 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004144 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004145 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004146 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004147 if (statement_block_size($block) > 1) {
4148 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004149 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004150 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004151 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004152 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004153 if ($seen) {
4154 my $sum_allowed = 0;
4155 foreach (@allowed) {
4156 $sum_allowed += $_;
4157 }
4158 if ($sum_allowed == 0) {
4159 WARN("BRACES",
4160 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4161 } elsif ($sum_allowed != $allow &&
4162 $seen != $allow) {
4163 CHK("BRACES",
4164 "braces {} should be used on all arms of this statement\n" . $herectx);
4165 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004166 }
4167 }
4168 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004169 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004170 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004171 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004172
Andy Whitcroftcf655042008-03-04 14:28:20 -08004173 # Check the pre-context.
4174 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4175 #print "APW: ALLOWED: pre<$1>\n";
4176 $allowed = 1;
4177 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004178
4179 my ($level, $endln, @chunks) =
4180 ctx_statement_full($linenr, $realcnt, $-[0]);
4181
Andy Whitcroftcf655042008-03-04 14:28:20 -08004182 # Check the condition.
4183 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004184 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004185 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004186 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004187 }
4188 if (statement_lines($cond) > 1) {
4189 #print "APW: ALLOWED: cond<$cond>\n";
4190 $allowed = 1;
4191 }
4192 if ($block =~/\b(?:if|for|while)\b/) {
4193 #print "APW: ALLOWED: block<$block>\n";
4194 $allowed = 1;
4195 }
4196 if (statement_block_size($block) > 1) {
4197 #print "APW: ALLOWED: lines block<$block>\n";
4198 $allowed = 1;
4199 }
4200 # Check the post-context.
4201 if (defined $chunks[1]) {
4202 my ($cond, $block) = @{$chunks[1]};
4203 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004204 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004205 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004206 if ($block =~ /^\s*\{/) {
4207 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4208 $allowed = 1;
4209 }
4210 }
4211 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004212 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004213 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004214
Andy Whitcroftf0556632008-10-15 22:02:23 -07004215 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004216 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004217 }
4218
Joe Perches000d1cc12011-07-25 17:13:25 -07004219 WARN("BRACES",
4220 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004221 }
4222 }
4223
Joe Perches0979ae62012-12-17 16:01:59 -08004224# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004225 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004226 CHK("BRACES",
4227 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4228 }
Joe Perches77b9a532013-07-03 15:05:29 -07004229 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004230 CHK("BRACES",
4231 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4232 }
4233
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004234# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004235 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4236 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004237 WARN("VOLATILE",
4238 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004239 }
4240
Andy Whitcroft00df3442007-06-08 13:47:06 -07004241# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004242 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004243 CHK("REDUNDANT_CODE",
4244 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004245 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004246 }
4247
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004248# check for needless "if (<foo>) fn(<foo>)" uses
4249 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4250 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4251 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4252 WARN('NEEDLESS_IF',
4253 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004254 }
4255 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004256
Joe Perchesebfdc402014-08-06 16:10:27 -07004257# check for unnecessary "Out of Memory" messages
4258 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4259 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4260 (defined $1 || defined $3) &&
4261 $linenr > 3) {
4262 my $testval = $2;
4263 my $testline = $lines[$linenr - 3];
4264
4265 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4266# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4267
4268 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4269 WARN("OOM_MESSAGE",
4270 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4271 }
4272 }
4273
Joe Perches8716de32013-09-11 14:24:05 -07004274# check for bad placement of section $InitAttribute (e.g.: __initdata)
4275 if ($line =~ /(\b$InitAttribute\b)/) {
4276 my $attr = $1;
4277 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4278 my $ptr = $1;
4279 my $var = $2;
4280 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4281 ERROR("MISPLACED_INIT",
4282 "$attr should be placed after $var\n" . $herecurr)) ||
4283 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4284 WARN("MISPLACED_INIT",
4285 "$attr should be placed after $var\n" . $herecurr))) &&
4286 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004287 $fixed[$fixlinenr] =~ 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;
Joe Perches8716de32013-09-11 14:24:05 -07004288 }
4289 }
4290 }
4291
Joe Perchese970b882013-11-12 15:10:10 -08004292# check for $InitAttributeData (ie: __initdata) with const
4293 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4294 my $attr = $1;
4295 $attr =~ /($InitAttributePrefix)(.*)/;
4296 my $attr_prefix = $1;
4297 my $attr_type = $2;
4298 if (ERROR("INIT_ATTRIBUTE",
4299 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4300 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004301 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004302 s/$InitAttributeData/${attr_prefix}initconst/;
4303 }
4304 }
4305
4306# check for $InitAttributeConst (ie: __initconst) without const
4307 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4308 my $attr = $1;
4309 if (ERROR("INIT_ATTRIBUTE",
4310 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4311 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004312 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004313 /(^\+\s*(?:static\s+))/;
4314 $lead = rtrim($1);
4315 $lead = "$lead " if ($lead !~ /^\+$/);
4316 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004317 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08004318 }
4319 }
4320
Joe Perchesfbdb8132014-04-03 14:49:14 -07004321# don't use __constant_<foo> functions outside of include/uapi/
4322 if ($realfile !~ m@^include/uapi/@ &&
4323 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4324 my $constant_func = $1;
4325 my $func = $constant_func;
4326 $func =~ s/^__constant_//;
4327 if (WARN("CONSTANT_CONVERSION",
4328 "$constant_func should be $func\n" . $herecurr) &&
4329 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004330 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004331 }
4332 }
4333
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004334# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004335 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004336 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004337 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004338 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004339 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004340 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4341 }
4342 if ($delay > 2000) {
4343 WARN("LONG_UDELAY",
4344 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004345 }
4346 }
4347
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004348# warn about unexpectedly long msleep's
4349 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4350 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004351 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004352 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004353 }
4354 }
4355
Joe Perches36ec1932013-07-03 15:05:25 -07004356# check for comparisons of jiffies
4357 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4358 WARN("JIFFIES_COMPARISON",
4359 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4360 }
4361
Joe Perches9d7a34a2013-07-03 15:05:26 -07004362# check for comparisons of get_jiffies_64()
4363 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4364 WARN("JIFFIES_COMPARISON",
4365 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4366 }
4367
Andy Whitcroft00df3442007-06-08 13:47:06 -07004368# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004369# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004370# print "#ifdef in C files should be avoided\n";
4371# print "$herecurr";
4372# $clean = 0;
4373# }
4374
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004375# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004376 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004377 if (ERROR("SPACING",
4378 "exactly one space required after that #$1\n" . $herecurr) &&
4379 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004380 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004381 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4382 }
4383
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004384 }
4385
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004386# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004387 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4388 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004389 my $which = $1;
4390 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004391 CHK("UNCOMMENTED_DEFINITION",
4392 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004393 }
4394 }
4395# check for memory barriers without a comment.
4396 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4397 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004398 WARN("MEMORY_BARRIER",
4399 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004400 }
4401 }
4402# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004403 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004404 CHK("ARCH_DEFINES",
4405 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004406 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004407
Tobias Klauserd4977c72010-05-24 14:33:30 -07004408# Check that the storage class is at the beginning of a declaration
4409 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004410 WARN("STORAGE_CLASS",
4411 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004412 }
4413
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004414# check the location of the inline attribute, that it is between
4415# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004416 if ($line =~ /\b$Type\s+$Inline\b/ ||
4417 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004418 ERROR("INLINE_LOCATION",
4419 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004420 }
4421
Andy Whitcroft8905a672007-11-28 16:21:06 -08004422# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004423 if ($realfile !~ m@\binclude/uapi/@ &&
4424 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004425 if (WARN("INLINE",
4426 "plain inline is preferred over $1\n" . $herecurr) &&
4427 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004428 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004429
4430 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004431 }
4432
Joe Perches3d130fd2011-01-12 17:00:00 -08004433# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004434 if ($realfile !~ m@\binclude/uapi/@ &&
4435 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004436 WARN("PREFER_PACKED",
4437 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004438 }
4439
Joe Perches39b7e282011-07-25 17:13:24 -07004440# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004441 if ($realfile !~ m@\binclude/uapi/@ &&
4442 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004443 WARN("PREFER_ALIGNED",
4444 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004445 }
4446
Joe Perches5f14d3b2012-01-10 15:09:52 -08004447# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004448 if ($realfile !~ m@\binclude/uapi/@ &&
4449 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004450 if (WARN("PREFER_PRINTF",
4451 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4452 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004453 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004454
4455 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004456 }
4457
Joe Perches6061d942012-03-23 15:02:16 -07004458# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004459 if ($realfile !~ m@\binclude/uapi/@ &&
4460 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004461 if (WARN("PREFER_SCANF",
4462 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4463 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004464 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004465 }
Joe Perches6061d942012-03-23 15:02:16 -07004466 }
4467
Joe Perches8f53a9b2010-03-05 13:43:48 -08004468# check for sizeof(&)
4469 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004470 WARN("SIZEOF_ADDRESS",
4471 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004472 }
4473
Joe Perches66c80b62012-07-30 14:41:22 -07004474# check for sizeof without parenthesis
4475 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004476 if (WARN("SIZEOF_PARENTHESIS",
4477 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4478 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004479 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004480 }
Joe Perches66c80b62012-07-30 14:41:22 -07004481 }
4482
Joe Perches428e2fd2011-05-24 17:13:39 -07004483# check for line continuations in quoted strings with odd counts of "
4484 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004485 WARN("LINE_CONTINUATIONS",
4486 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004487 }
4488
Joe Perches88982fe2012-12-17 16:02:00 -08004489# check for struct spinlock declarations
4490 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4491 WARN("USE_SPINLOCK_T",
4492 "struct spinlock should be spinlock_t\n" . $herecurr);
4493 }
4494
Joe Perchesa6962d72013-04-29 16:18:13 -07004495# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004496 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004497 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004498 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004499 if (WARN("PREFER_SEQ_PUTS",
4500 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4501 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004502 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004503 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004504 }
4505 }
4506
Andy Whitcroft554e1652012-01-10 15:09:57 -08004507# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004508 if ($^V && $^V ge 5.10.0 &&
4509 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004510 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004511
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004512 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004513 my $ms_val = $7;
4514 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004515
Andy Whitcroft554e1652012-01-10 15:09:57 -08004516 if ($ms_size =~ /^(0x|)0$/i) {
4517 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004518 "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 -08004519 } elsif ($ms_size =~ /^(0x|)1$/i) {
4520 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004521 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4522 }
4523 }
4524
Joe Perches98a9bba2014-01-23 15:54:52 -08004525# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4526 if ($^V && $^V ge 5.10.0 &&
4527 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4528 if (WARN("PREFER_ETHER_ADDR_COPY",
4529 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4530 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004531 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
Joe Perches98a9bba2014-01-23 15:54:52 -08004532 }
4533 }
4534
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004535# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004536 if ($^V && $^V ge 5.10.0 &&
4537 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004538 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004539 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004540 my $call = $1;
4541 my $cast1 = deparenthesize($2);
4542 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004543 my $cast2 = deparenthesize($7);
4544 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004545 my $cast;
4546
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004547 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004548 $cast = "$cast1 or $cast2";
4549 } elsif ($cast1 ne "") {
4550 $cast = $cast1;
4551 } else {
4552 $cast = $cast2;
4553 }
4554 WARN("MINMAX",
4555 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004556 }
4557 }
4558
Joe Perches4a273192012-07-30 14:41:20 -07004559# check usleep_range arguments
4560 if ($^V && $^V ge 5.10.0 &&
4561 defined $stat &&
4562 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4563 my $min = $1;
4564 my $max = $7;
4565 if ($min eq $max) {
4566 WARN("USLEEP_RANGE",
4567 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4568 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4569 $min > $max) {
4570 WARN("USLEEP_RANGE",
4571 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4572 }
4573 }
4574
Joe Perches823b7942013-11-12 15:10:15 -08004575# check for naked sscanf
4576 if ($^V && $^V ge 5.10.0 &&
4577 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004578 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004579 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4580 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4581 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4582 my $lc = $stat =~ tr@\n@@;
4583 $lc = $lc + $linenr;
4584 my $stat_real = raw_line($linenr, 0);
4585 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4586 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4587 }
4588 WARN("NAKED_SSCANF",
4589 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4590 }
4591
Joe Perchesafc819a2014-06-04 16:12:08 -07004592# check for simple sscanf that should be kstrto<foo>
4593 if ($^V && $^V ge 5.10.0 &&
4594 defined $stat &&
4595 $line =~ /\bsscanf\b/) {
4596 my $lc = $stat =~ tr@\n@@;
4597 $lc = $lc + $linenr;
4598 my $stat_real = raw_line($linenr, 0);
4599 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4600 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4601 }
4602 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4603 my $format = $6;
4604 my $count = $format =~ tr@%@%@;
4605 if ($count == 1 &&
4606 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4607 WARN("SSCANF_TO_KSTRTO",
4608 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4609 }
4610 }
4611 }
4612
Joe Perches70dc8a42013-09-11 14:23:58 -07004613# check for new externs in .h files.
4614 if ($realfile =~ /\.h$/ &&
4615 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004616 if (CHK("AVOID_EXTERNS",
4617 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004618 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004619 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07004620 }
4621 }
4622
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004623# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004624 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004625 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004626 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004627 my $function_name = $1;
4628 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004629
4630 my $s = $stat;
4631 if (defined $cond) {
4632 substr($s, 0, length($cond), '');
4633 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004634 if ($s =~ /^\s*;/ &&
4635 $function_name ne 'uninitialized_var')
4636 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004637 WARN("AVOID_EXTERNS",
4638 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004639 }
4640
4641 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004642 WARN("FUNCTION_ARGUMENTS",
4643 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004644 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004645
4646 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4647 $stat =~ /^.\s*extern\s+/)
4648 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004649 WARN("AVOID_EXTERNS",
4650 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004651 }
4652
4653# checks for new __setup's
4654 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4655 my $name = $1;
4656
4657 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004658 CHK("UNDOCUMENTED_SETUP",
4659 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004660 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004661 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004662
4663# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004664 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004665 WARN("UNNECESSARY_CASTS",
4666 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004667 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004668
Joe Perchesa640d252013-07-03 15:05:21 -07004669# alloc style
4670# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4671 if ($^V && $^V ge 5.10.0 &&
4672 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4673 CHK("ALLOC_SIZEOF_STRUCT",
4674 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4675 }
4676
Joe Perches60a55362014-06-04 16:12:07 -07004677# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4678 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07004679 $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 -07004680 my $oldfunc = $3;
4681 my $a1 = $4;
4682 my $a2 = $10;
4683 my $newfunc = "kmalloc_array";
4684 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07004685 my $r1 = $a1;
4686 my $r2 = $a2;
4687 if ($a1 =~ /^sizeof\s*\S/) {
4688 $r1 = $a2;
4689 $r2 = $a1;
4690 }
4691 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4692 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07004693 if (WARN("ALLOC_WITH_MULTIPLY",
4694 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4695 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004696 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
Joe Perches60a55362014-06-04 16:12:07 -07004697
4698 }
4699 }
4700 }
4701
Joe Perches972fdea2013-04-29 16:18:12 -07004702# check for krealloc arg reuse
4703 if ($^V && $^V ge 5.10.0 &&
4704 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4705 WARN("KREALLOC_ARG_REUSE",
4706 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4707 }
4708
Joe Perches5ce59ae2013-02-21 16:44:18 -08004709# check for alloc argument mismatch
4710 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4711 WARN("ALLOC_ARRAY_ARGS",
4712 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4713 }
4714
Joe Perchescaf2a542011-01-12 16:59:56 -08004715# check for multiple semicolons
4716 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004717 if (WARN("ONE_SEMICOLON",
4718 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4719 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004720 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004721 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004722 }
4723
Joe Perchesc34c09a2014-01-23 15:54:43 -08004724# check for case / default statements not preceeded by break/fallthrough/switch
4725 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4726 my $has_break = 0;
4727 my $has_statement = 0;
4728 my $count = 0;
4729 my $prevline = $linenr;
4730 while ($prevline > 1 && $count < 3 && !$has_break) {
4731 $prevline--;
4732 my $rline = $rawlines[$prevline - 1];
4733 my $fline = $lines[$prevline - 1];
4734 last if ($fline =~ /^\@\@/);
4735 next if ($fline =~ /^\-/);
4736 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4737 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4738 next if ($fline =~ /^.[\s$;]*$/);
4739 $has_statement = 1;
4740 $count++;
4741 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4742 }
4743 if (!$has_break && $has_statement) {
4744 WARN("MISSING_BREAK",
4745 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4746 }
4747 }
4748
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004749# check for switch/default statements without a break;
4750 if ($^V && $^V ge 5.10.0 &&
4751 defined $stat &&
4752 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4753 my $ctx = '';
4754 my $herectx = $here . "\n";
4755 my $cnt = statement_rawlines($stat);
4756 for (my $n = 0; $n < $cnt; $n++) {
4757 $herectx .= raw_line($linenr, $n) . "\n";
4758 }
4759 WARN("DEFAULT_NO_BREAK",
4760 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004761 }
4762
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004763# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004764 if ($line =~ /\b__FUNCTION__\b/) {
4765 if (WARN("USE_FUNC",
4766 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4767 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004768 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004769 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004770 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004771
Joe Perches2c924882012-03-23 15:02:20 -07004772# check for use of yield()
4773 if ($line =~ /\byield\s*\(\s*\)/) {
4774 WARN("YIELD",
4775 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4776 }
4777
Joe Perches179f8f42013-07-03 15:05:30 -07004778# check for comparisons against true and false
4779 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4780 my $lead = $1;
4781 my $arg = $2;
4782 my $test = $3;
4783 my $otype = $4;
4784 my $trail = $5;
4785 my $op = "!";
4786
4787 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4788
4789 my $type = lc($otype);
4790 if ($type =~ /^(?:true|false)$/) {
4791 if (("$test" eq "==" && "$type" eq "true") ||
4792 ("$test" eq "!=" && "$type" eq "false")) {
4793 $op = "";
4794 }
4795
4796 CHK("BOOL_COMPARISON",
4797 "Using comparison to $otype is error prone\n" . $herecurr);
4798
4799## maybe suggesting a correct construct would better
4800## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4801
4802 }
4803 }
4804
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004805# check for semaphores initialized locked
4806 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004807 WARN("CONSIDER_COMPLETION",
4808 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004809 }
Joe Perches6712d852012-03-23 15:02:20 -07004810
Joe Perches67d0a072011-10-31 17:13:10 -07004811# recommend kstrto* over simple_strto* and strict_strto*
4812 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004813 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004814 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004815 }
Joe Perches6712d852012-03-23 15:02:20 -07004816
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004817# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07004818 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004819 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004820 "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 -07004821 }
Joe Perches6712d852012-03-23 15:02:20 -07004822
Emese Revfy79404842010-03-05 13:43:53 -08004823# check for various ops structs, ensure they are const.
4824 my $struct_ops = qr{acpi_dock_ops|
4825 address_space_operations|
4826 backlight_ops|
4827 block_device_operations|
4828 dentry_operations|
4829 dev_pm_ops|
4830 dma_map_ops|
4831 extent_io_ops|
4832 file_lock_operations|
4833 file_operations|
4834 hv_ops|
4835 ide_dma_ops|
4836 intel_dvo_dev_ops|
4837 item_operations|
4838 iwl_ops|
4839 kgdb_arch|
4840 kgdb_io|
4841 kset_uevent_ops|
4842 lock_manager_operations|
4843 microcode_ops|
4844 mtrr_ops|
4845 neigh_ops|
4846 nlmsvc_binding|
4847 pci_raw_ops|
4848 pipe_buf_operations|
4849 platform_hibernation_ops|
4850 platform_suspend_ops|
4851 proto_ops|
4852 rpc_pipe_ops|
4853 seq_operations|
4854 snd_ac97_build_ops|
4855 soc_pcmcia_socket_ops|
4856 stacktrace_ops|
4857 sysfs_ops|
4858 tty_operations|
4859 usb_mon_operations|
4860 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004861 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004862 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004863 WARN("CONST_STRUCT",
4864 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004865 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004866 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004867
4868# use of NR_CPUS is usually wrong
4869# ignore definitions of NR_CPUS and usage to define arrays as likely right
4870 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004871 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4872 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004873 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4874 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4875 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004876 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004877 WARN("NR_CPUS",
4878 "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 -07004879 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004880
Joe Perches52ea8502013-11-12 15:10:09 -08004881# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4882 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4883 ERROR("DEFINE_ARCH_HAS",
4884 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4885 }
4886
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004887# check for %L{u,d,i} in strings
4888 my $string;
4889 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4890 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004891 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004892 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004893 WARN("PRINTF_L",
4894 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004895 last;
4896 }
4897 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004898
4899# whine mightly about in_atomic
4900 if ($line =~ /\bin_atomic\s*\(/) {
4901 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004902 ERROR("IN_ATOMIC",
4903 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004904 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004905 WARN("IN_ATOMIC",
4906 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004907 }
4908 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004909
4910# check for lockdep_set_novalidate_class
4911 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4912 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4913 if ($realfile !~ m@^kernel/lockdep@ &&
4914 $realfile !~ m@^include/linux/lockdep@ &&
4915 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004916 ERROR("LOCKDEP",
4917 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004918 }
4919 }
Dave Jones88f88312011-01-12 16:59:59 -08004920
4921 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4922 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004923 WARN("EXPORTED_WORLD_WRITABLE",
4924 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004925 }
Joe Perches24358802014-04-03 14:49:13 -07004926
Joe Perches515a2352014-04-03 14:49:24 -07004927# Mode permission misuses where it seems decimal should be octal
4928# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4929 if ($^V && $^V ge 5.10.0 &&
4930 $line =~ /$mode_perms_search/) {
4931 foreach my $entry (@mode_permission_funcs) {
4932 my $func = $entry->[0];
4933 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004934
Joe Perches515a2352014-04-03 14:49:24 -07004935 my $skip_args = "";
4936 if ($arg_pos > 1) {
4937 $arg_pos--;
4938 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4939 }
4940 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4941 if ($line =~ /$test/) {
4942 my $val = $1;
4943 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004944
Joe Perches515a2352014-04-03 14:49:24 -07004945 if ($val !~ /^0$/ &&
4946 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4947 length($val) ne 4)) {
4948 ERROR("NON_OCTAL_PERMISSIONS",
4949 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4950 }
Joe Perches24358802014-04-03 14:49:13 -07004951 }
4952 }
4953 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004954 }
4955
4956 # If we have no input at all, then there is nothing to report on
4957 # so just keep quiet.
4958 if ($#rawlines == -1) {
4959 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004960 }
4961
Andy Whitcroft8905a672007-11-28 16:21:06 -08004962 # In mailback mode only produce a report in the negative, for
4963 # things that appear to be patches.
4964 if ($mailback && ($clean == 1 || !$is_patch)) {
4965 exit(0);
4966 }
4967
4968 # This is not a patch, and we are are in 'no-patch' mode so
4969 # just keep quiet.
4970 if (!$chk_patch && !$is_patch) {
4971 exit(0);
4972 }
4973
4974 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004975 ERROR("NOT_UNIFIED_DIFF",
4976 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004977 }
4978 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004979 ERROR("MISSING_SIGN_OFF",
4980 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004981 }
4982
Andy Whitcroft8905a672007-11-28 16:21:06 -08004983 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004984 if ($summary && !($clean == 1 && $quiet == 1)) {
4985 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004986 print "total: $cnt_error errors, $cnt_warn warnings, " .
4987 (($check)? "$cnt_chk checks, " : "") .
4988 "$cnt_lines lines checked\n";
4989 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004990 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004991
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004992 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004993
4994 if ($^V lt 5.10.0) {
4995 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4996 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4997 }
4998
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004999 # If there were whitespace errors which cleanpatch can fix
5000 # then suggest that.
5001 if ($rpt_cleaners) {
5002 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5003 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005004 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005005 }
5006 }
5007
Joe Perches91bfe482013-09-11 14:23:59 -07005008 hash_show_words(\%use_type, "Used");
5009 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005010
Joe Perchesd752fcc2014-08-06 16:11:05 -07005011 if ($clean == 0 && $fix &&
5012 ("@rawlines" ne "@fixed" ||
5013 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005014 my $newfile = $filename;
5015 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005016 my $linecount = 0;
5017 my $f;
5018
Joe Perchesd752fcc2014-08-06 16:11:05 -07005019 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5020
Joe Perches3705ce52013-07-03 15:05:31 -07005021 open($f, '>', $newfile)
5022 or die "$P: Can't open $newfile for write\n";
5023 foreach my $fixed_line (@fixed) {
5024 $linecount++;
5025 if ($file) {
5026 if ($linecount > 3) {
5027 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005028 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005029 }
5030 } else {
5031 print $f $fixed_line . "\n";
5032 }
5033 }
5034 close($f);
5035
5036 if (!$quiet) {
5037 print << "EOM";
5038Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5039
5040Do _NOT_ trust the results written to this file.
5041Do _NOT_ submit these changes without inspecting them for correctness.
5042
5043This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5044No warranties, expressed or implied...
5045
5046EOM
5047 }
5048 }
5049
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005050 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005051 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005052 }
5053 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005054 print << "EOM";
5055$vname has style problems, please review.
5056
5057If any of these errors are false positives, please report
5058them to the maintainer, see CHECKPATCH in MAINTAINERS.
5059EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005060 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005061
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005062 return $clean;
5063}