blob: 1700720166d1d4520161b689d346b9c9119e7254 [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 Perches18130872014-08-06 16:11:22 -0700312our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700313our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800314our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700315our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800316our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700317our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800318
Joe Perches15662b32011-10-31 17:13:12 -0700319our $NON_ASCII_UTF8 = qr{
320 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700321 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
322 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
323 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
324 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
325 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
326 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
327}x;
328
Joe Perches15662b32011-10-31 17:13:12 -0700329our $UTF8 = qr{
330 [\x09\x0A\x0D\x20-\x7E] # ASCII
331 | $NON_ASCII_UTF8
332}x;
333
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700334our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700335 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700336 atomic_t
337)};
338
Joe Perches691e6692010-03-05 13:43:51 -0800339our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700340 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700341 (?:[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 -0700342 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700343 panic|
Joe Perches06668722013-11-12 15:10:07 -0800344 MODULE_[A-Z_]+|
345 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800346)};
347
Joe Perches20112472011-07-25 17:13:23 -0700348our $signature_tags = qr{(?xi:
349 Signed-off-by:|
350 Acked-by:|
351 Tested-by:|
352 Reviewed-by:|
353 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700354 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700355 To:|
356 Cc:
357)};
358
Joe Perches18130872014-08-06 16:11:22 -0700359our @typeListMisordered = (
360 qr{char\s+(?:un)?signed},
361 qr{int\s+(?:(?:un)?signed\s+)?short\s},
362 qr{int\s+short(?:\s+(?:un)?signed)},
363 qr{short\s+int(?:\s+(?:un)?signed)},
364 qr{(?:un)?signed\s+int\s+short},
365 qr{short\s+(?:un)?signed},
366 qr{long\s+int\s+(?:un)?signed},
367 qr{int\s+long\s+(?:un)?signed},
368 qr{long\s+(?:un)?signed\s+int},
369 qr{int\s+(?:un)?signed\s+long},
370 qr{int\s+(?:un)?signed},
371 qr{int\s+long\s+long\s+(?:un)?signed},
372 qr{long\s+long\s+int\s+(?:un)?signed},
373 qr{long\s+long\s+(?:un)?signed\s+int},
374 qr{long\s+long\s+(?:un)?signed},
375 qr{long\s+(?:un)?signed},
376);
377
Andy Whitcroft8905a672007-11-28 16:21:06 -0800378our @typeList = (
379 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700380 qr{(?:(?:un)?signed\s+)?char},
381 qr{(?:(?:un)?signed\s+)?short\s+int},
382 qr{(?:(?:un)?signed\s+)?short},
383 qr{(?:(?:un)?signed\s+)?int},
384 qr{(?:(?:un)?signed\s+)?long\s+int},
385 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
386 qr{(?:(?:un)?signed\s+)?long\s+long},
387 qr{(?:(?:un)?signed\s+)?long},
388 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800389 qr{float},
390 qr{double},
391 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392 qr{struct\s+$Ident},
393 qr{union\s+$Ident},
394 qr{enum\s+$Ident},
395 qr{${Ident}_t},
396 qr{${Ident}_handler},
397 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700398 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800399);
Joe Perches8716de32013-09-11 14:24:05 -0700400our @typeListWithAttr = (
401 @typeList,
402 qr{struct\s+$InitAttribute\s+$Ident},
403 qr{union\s+$InitAttribute\s+$Ident},
404);
405
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700406our @modifierList = (
407 qr{fastcall},
408);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800409
Joe Perches24358802014-04-03 14:49:13 -0700410our @mode_permission_funcs = (
411 ["module_param", 3],
412 ["module_param_(?:array|named|string)", 4],
413 ["module_param_array_named", 5],
414 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
415 ["proc_create(?:_data|)", 2],
416 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
417);
418
Joe Perches515a2352014-04-03 14:49:24 -0700419#Create a search pattern for all these functions to speed up a loop below
420our $mode_perms_search = "";
421foreach my $entry (@mode_permission_funcs) {
422 $mode_perms_search .= '|' if ($mode_perms_search ne "");
423 $mode_perms_search .= $entry->[0];
424}
425
Wolfram Sang7840a942010-08-09 17:20:57 -0700426our $allowed_asm_includes = qr{(?x:
427 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700428 memory|
429 time|
430 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700431)};
432# memory.h: ARM has a custom one
433
Andy Whitcroft8905a672007-11-28 16:21:06 -0800434sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700435 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
436 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700437 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700438 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700439 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700441 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800442 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800443 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700444 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700445 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800446 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700447 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800448 }x;
Joe Perches18130872014-08-06 16:11:22 -0700449 $NonptrTypeMisordered = qr{
450 (?:$Modifier\s+|const\s+)*
451 (?:
452 (?:${Misordered}\b)
453 )
454 (?:\s+$Modifier|\s+const)*
455 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700456 $NonptrTypeWithAttr = qr{
457 (?:$Modifier\s+|const\s+)*
458 (?:
459 (?:typeof|__typeof__)\s*\([^\)]*\)|
460 (?:$typeTypedefs\b)|
461 (?:${allWithAttr}\b)
462 )
463 (?:\s+$Modifier|\s+const)*
464 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800465 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700466 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700467 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700468 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800469 }x;
Joe Perches18130872014-08-06 16:11:22 -0700470 $TypeMisordered = qr{
471 $NonptrTypeMisordered
472 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
473 (?:\s+$Inline|\s+$Modifier)*
474 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700475 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700476 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800477}
478build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700479
Joe Perches7d2367a2011-07-25 17:13:22 -0700480our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700481
482# Using $balanced_parens, $LvalOrFunc, or $FuncArg
483# requires at least perl version v5.10.0
484# Any use must be runtime checked with $^V
485
486our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700487our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800488our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700489
Joe Perchesf8422302014-08-06 16:11:31 -0700490our $declaration_macros = qr{(?x:
491 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
492 (?:$Storage\s+)?LIST_HEAD\s*\(|
493 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
494)};
495
Joe Perches7d2367a2011-07-25 17:13:22 -0700496sub deparenthesize {
497 my ($string) = @_;
498 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700499
500 while ($string =~ /^\s*\(.*\)\s*$/) {
501 $string =~ s@^\s*\(\s*@@;
502 $string =~ s@\s*\)\s*$@@;
503 }
504
Joe Perches7d2367a2011-07-25 17:13:22 -0700505 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700506
Joe Perches7d2367a2011-07-25 17:13:22 -0700507 return $string;
508}
509
Joe Perches34456862013-07-03 15:05:34 -0700510sub seed_camelcase_file {
511 my ($file) = @_;
512
513 return if (!(-f $file));
514
515 local $/;
516
517 open(my $include_file, '<', "$file")
518 or warn "$P: Can't read '$file' $!\n";
519 my $text = <$include_file>;
520 close($include_file);
521
522 my @lines = split('\n', $text);
523
524 foreach my $line (@lines) {
525 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
526 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
527 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800528 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
529 $camelcase{$1} = 1;
530 } 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 -0700531 $camelcase{$1} = 1;
532 }
533 }
534}
535
536my $camelcase_seeded = 0;
537sub seed_camelcase_includes {
538 return if ($camelcase_seeded);
539
540 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700541 my $camelcase_cache = "";
542 my @include_files = ();
543
544 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700545
Richard Genoud3645e322014-02-10 14:25:32 -0800546 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700547 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
548 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700549 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700550 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700551 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700552 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700553 @include_files = split('\n', $files);
554 foreach my $file (@include_files) {
555 my $date = POSIX::strftime("%Y%m%d%H%M",
556 localtime((stat $file)[9]));
557 $last_mod_date = $date if ($last_mod_date < $date);
558 }
559 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700560 }
Joe Perchesc707a812013-07-08 16:00:43 -0700561
562 if ($camelcase_cache ne "" && -f $camelcase_cache) {
563 open(my $camelcase_file, '<', "$camelcase_cache")
564 or warn "$P: Can't read '$camelcase_cache' $!\n";
565 while (<$camelcase_file>) {
566 chomp;
567 $camelcase{$_} = 1;
568 }
569 close($camelcase_file);
570
571 return;
572 }
573
Richard Genoud3645e322014-02-10 14:25:32 -0800574 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700575 $files = `git ls-files "include/*.h"`;
576 @include_files = split('\n', $files);
577 }
578
Joe Perches34456862013-07-03 15:05:34 -0700579 foreach my $file (@include_files) {
580 seed_camelcase_file($file);
581 }
Joe Perches351b2a12013-07-03 15:05:36 -0700582
Joe Perchesc707a812013-07-08 16:00:43 -0700583 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700584 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700585 open(my $camelcase_file, '>', "$camelcase_cache")
586 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700587 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
588 print $camelcase_file ("$_\n");
589 }
590 close($camelcase_file);
591 }
Joe Perches34456862013-07-03 15:05:34 -0700592}
593
Joe Perchesd311cd42014-08-06 16:10:57 -0700594sub git_commit_info {
595 my ($commit, $id, $desc) = @_;
596
597 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
598
599 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
600 $output =~ s/^\s*//gm;
601 my @lines = split("\n", $output);
602
603 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
604# Maybe one day convert this block of bash into something that returns
605# all matching commit ids, but it's very slow...
606#
607# echo "checking commits $1..."
608# git rev-list --remotes | grep -i "^$1" |
609# while read line ; do
610# git log --format='%H %s' -1 $line |
611# echo "commit $(cut -c 1-12,41-)"
612# done
613 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
614 } else {
615 $id = substr($lines[0], 0, 12);
616 $desc = substr($lines[0], 41);
617 }
618
619 return ($id, $desc);
620}
621
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700622$chk_signoff = 0 if ($file);
623
Andy Whitcroft00df3442007-06-08 13:47:06 -0700624my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800625my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700626my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700627my @fixed_inserted = ();
628my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700629my $fixlinenr = -1;
630
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800631my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700632for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800633 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700634 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800635 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700636 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800637 } elsif ($filename eq '-') {
638 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700639 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800640 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700641 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700642 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800643 if ($filename eq '-') {
644 $vname = 'Your patch';
645 } else {
646 $vname = $filename;
647 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800648 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700649 chomp;
650 push(@rawlines, $_);
651 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800652 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800653 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700654 $exit = 1;
655 }
656 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800657 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700658 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700659 @fixed_inserted = ();
660 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700661 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700662}
663
664exit($exit);
665
666sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700667 my ($root) = @_;
668
669 my @tree_check = (
670 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
671 "README", "Documentation", "arch", "include", "drivers",
672 "fs", "init", "ipc", "kernel", "lib", "scripts",
673 );
674
675 foreach my $check (@tree_check) {
676 if (! -e $root . '/' . $check) {
677 return 0;
678 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700679 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700680 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700681}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700682
Joe Perches20112472011-07-25 17:13:23 -0700683sub parse_email {
684 my ($formatted_email) = @_;
685
686 my $name = "";
687 my $address = "";
688 my $comment = "";
689
690 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
691 $name = $1;
692 $address = $2;
693 $comment = $3 if defined $3;
694 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
695 $address = $1;
696 $comment = $2 if defined $2;
697 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
698 $address = $1;
699 $comment = $2 if defined $2;
700 $formatted_email =~ s/$address.*$//;
701 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700702 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700703 $name =~ s/^\"|\"$//g;
704 # If there's a name left after stripping spaces and
705 # leading quotes, and the address doesn't have both
706 # leading and trailing angle brackets, the address
707 # is invalid. ie:
708 # "joe smith joe@smith.com" bad
709 # "joe smith <joe@smith.com" bad
710 if ($name ne "" && $address !~ /^<[^>]+>$/) {
711 $name = "";
712 $address = "";
713 $comment = "";
714 }
715 }
716
Joe Perches3705ce52013-07-03 15:05:31 -0700717 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700718 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700719 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700720 $address =~ s/^\<|\>$//g;
721
722 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
723 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
724 $name = "\"$name\"";
725 }
726
727 return ($name, $address, $comment);
728}
729
730sub format_email {
731 my ($name, $address) = @_;
732
733 my $formatted_email;
734
Joe Perches3705ce52013-07-03 15:05:31 -0700735 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700736 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700737 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700738
739 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
740 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
741 $name = "\"$name\"";
742 }
743
744 if ("$name" eq "") {
745 $formatted_email = "$address";
746 } else {
747 $formatted_email = "$name <$address>";
748 }
749
750 return $formatted_email;
751}
752
Joe Perchesd311cd42014-08-06 16:10:57 -0700753sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700754 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700755
Joe Perchesbd474ca2014-08-06 16:11:10 -0700756 foreach my $path (split(/:/, $ENV{PATH})) {
757 if (-e "$path/$bin") {
758 return "$path/$bin";
759 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700760 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700761
Joe Perchesbd474ca2014-08-06 16:11:10 -0700762 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700763}
764
Joe Perches000d1cc12011-07-25 17:13:25 -0700765sub which_conf {
766 my ($conf) = @_;
767
768 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
769 if (-e "$path/$conf") {
770 return "$path/$conf";
771 }
772 }
773
774 return "";
775}
776
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700777sub expand_tabs {
778 my ($str) = @_;
779
780 my $res = '';
781 my $n = 0;
782 for my $c (split(//, $str)) {
783 if ($c eq "\t") {
784 $res .= ' ';
785 $n++;
786 for (; ($n % 8) != 0; $n++) {
787 $res .= ' ';
788 }
789 next;
790 }
791 $res .= $c;
792 $n++;
793 }
794
795 return $res;
796}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700797sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700798 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700799 return $res;
800}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700801
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700802sub line_stats {
803 my ($line) = @_;
804
805 # Drop the diff line leader and expand tabs
806 $line =~ s/^.//;
807 $line = expand_tabs($line);
808
809 # Pick the indent from the front of the line.
810 my ($white) = ($line =~ /^(\s*)/);
811
812 return (length($line), length($white));
813}
814
Andy Whitcroft773647a2008-03-28 14:15:58 -0700815my $sanitise_quote = '';
816
817sub sanitise_line_reset {
818 my ($in_comment) = @_;
819
820 if ($in_comment) {
821 $sanitise_quote = '*/';
822 } else {
823 $sanitise_quote = '';
824 }
825}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700826sub sanitise_line {
827 my ($line) = @_;
828
829 my $res = '';
830 my $l = '';
831
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800832 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700833 my $off = 0;
834 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700835
Andy Whitcroft773647a2008-03-28 14:15:58 -0700836 # Always copy over the diff marker.
837 $res = substr($line, 0, 1);
838
839 for ($off = 1; $off < length($line); $off++) {
840 $c = substr($line, $off, 1);
841
842 # Comments we are wacking completly including the begin
843 # and end, all to $;.
844 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
845 $sanitise_quote = '*/';
846
847 substr($res, $off, 2, "$;$;");
848 $off++;
849 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800850 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700851 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700852 $sanitise_quote = '';
853 substr($res, $off, 2, "$;$;");
854 $off++;
855 next;
856 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700857 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
858 $sanitise_quote = '//';
859
860 substr($res, $off, 2, $sanitise_quote);
861 $off++;
862 next;
863 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700864
865 # A \ in a string means ignore the next character.
866 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
867 $c eq "\\") {
868 substr($res, $off, 2, 'XX');
869 $off++;
870 next;
871 }
872 # Regular quotes.
873 if ($c eq "'" || $c eq '"') {
874 if ($sanitise_quote eq '') {
875 $sanitise_quote = $c;
876
877 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700878 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700879 } elsif ($sanitise_quote eq $c) {
880 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700881 }
882 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700883
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800884 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700885 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
886 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700887 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
888 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700889 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
890 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700891 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700892 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700893 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800894 }
895
Daniel Walker113f04a2009-09-21 17:04:35 -0700896 if ($sanitise_quote eq '//') {
897 $sanitise_quote = '';
898 }
899
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800900 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700901 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800902 my $clean = 'X' x length($1);
903 $res =~ s@\<.*\>@<$clean>@;
904
905 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700906 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700908 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800909 }
910
Andy Whitcroft00df3442007-06-08 13:47:06 -0700911 return $res;
912}
913
Joe Perchesa6962d72013-04-29 16:18:13 -0700914sub get_quoted_string {
915 my ($line, $rawline) = @_;
916
917 return "" if ($line !~ m/(\"[X]+\")/g);
918 return substr($rawline, $-[0], $+[0] - $-[0]);
919}
920
Andy Whitcroft8905a672007-11-28 16:21:06 -0800921sub ctx_statement_block {
922 my ($linenr, $remain, $off) = @_;
923 my $line = $linenr - 1;
924 my $blk = '';
925 my $soff = $off;
926 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700927 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800928
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800929 my $loff = 0;
930
Andy Whitcroft8905a672007-11-28 16:21:06 -0800931 my $type = '';
932 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800933 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800934 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800935 my $c;
936 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800937
938 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800939 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800940 @stack = (['', 0]) if ($#stack == -1);
941
Andy Whitcroft773647a2008-03-28 14:15:58 -0700942 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800943 # If we are about to drop off the end, pull in more
944 # context.
945 if ($off >= $len) {
946 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700947 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800948 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800949 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800950 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800951 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800952 $len = length($blk);
953 $line++;
954 last;
955 }
956 # Bail if there is no further context.
957 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800958 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800959 last;
960 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800961 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
962 $level++;
963 $type = '#';
964 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800965 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800966 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800967 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800968 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800969
Andy Whitcroft773647a2008-03-28 14:15:58 -0700970 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800971
972 # Handle nested #if/#else.
973 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
974 push(@stack, [ $type, $level ]);
975 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
976 ($type, $level) = @{$stack[$#stack - 1]};
977 } elsif ($remainder =~ /^#\s*endif\b/) {
978 ($type, $level) = @{pop(@stack)};
979 }
980
Andy Whitcroft8905a672007-11-28 16:21:06 -0800981 # Statement ends at the ';' or a close '}' at the
982 # outermost level.
983 if ($level == 0 && $c eq ';') {
984 last;
985 }
986
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800987 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700988 if ($level == 0 && $coff_set == 0 &&
989 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
990 $remainder =~ /^(else)(?:\s|{)/ &&
991 $remainder !~ /^else\s+if\b/) {
992 $coff = $off + length($1) - 1;
993 $coff_set = 1;
994 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
995 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800996 }
997
Andy Whitcroft8905a672007-11-28 16:21:06 -0800998 if (($type eq '' || $type eq '(') && $c eq '(') {
999 $level++;
1000 $type = '(';
1001 }
1002 if ($type eq '(' && $c eq ')') {
1003 $level--;
1004 $type = ($level != 0)? '(' : '';
1005
1006 if ($level == 0 && $coff < $soff) {
1007 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008 $coff_set = 1;
1009 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001010 }
1011 }
1012 if (($type eq '' || $type eq '{') && $c eq '{') {
1013 $level++;
1014 $type = '{';
1015 }
1016 if ($type eq '{' && $c eq '}') {
1017 $level--;
1018 $type = ($level != 0)? '{' : '';
1019
1020 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001021 if (substr($blk, $off + 1, 1) eq ';') {
1022 $off++;
1023 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001024 last;
1025 }
1026 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001027 # Preprocessor commands end at the newline unless escaped.
1028 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1029 $level--;
1030 $type = '';
1031 $off++;
1032 last;
1033 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001034 $off++;
1035 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001036 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001037 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001038 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001039 $line++;
1040 $remain--;
1041 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001042
1043 my $statement = substr($blk, $soff, $off - $soff + 1);
1044 my $condition = substr($blk, $soff, $coff - $soff + 1);
1045
1046 #warn "STATEMENT<$statement>\n";
1047 #warn "CONDITION<$condition>\n";
1048
Andy Whitcroft773647a2008-03-28 14:15:58 -07001049 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001050
1051 return ($statement, $condition,
1052 $line, $remain + 1, $off - $loff + 1, $level);
1053}
1054
Andy Whitcroftcf655042008-03-04 14:28:20 -08001055sub statement_lines {
1056 my ($stmt) = @_;
1057
1058 # Strip the diff line prefixes and rip blank lines at start and end.
1059 $stmt =~ s/(^|\n)./$1/g;
1060 $stmt =~ s/^\s*//;
1061 $stmt =~ s/\s*$//;
1062
1063 my @stmt_lines = ($stmt =~ /\n/g);
1064
1065 return $#stmt_lines + 2;
1066}
1067
1068sub statement_rawlines {
1069 my ($stmt) = @_;
1070
1071 my @stmt_lines = ($stmt =~ /\n/g);
1072
1073 return $#stmt_lines + 2;
1074}
1075
1076sub statement_block_size {
1077 my ($stmt) = @_;
1078
1079 $stmt =~ s/(^|\n)./$1/g;
1080 $stmt =~ s/^\s*{//;
1081 $stmt =~ s/}\s*$//;
1082 $stmt =~ s/^\s*//;
1083 $stmt =~ s/\s*$//;
1084
1085 my @stmt_lines = ($stmt =~ /\n/g);
1086 my @stmt_statements = ($stmt =~ /;/g);
1087
1088 my $stmt_lines = $#stmt_lines + 2;
1089 my $stmt_statements = $#stmt_statements + 1;
1090
1091 if ($stmt_lines > $stmt_statements) {
1092 return $stmt_lines;
1093 } else {
1094 return $stmt_statements;
1095 }
1096}
1097
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001098sub ctx_statement_full {
1099 my ($linenr, $remain, $off) = @_;
1100 my ($statement, $condition, $level);
1101
1102 my (@chunks);
1103
Andy Whitcroftcf655042008-03-04 14:28:20 -08001104 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001105 ($statement, $condition, $linenr, $remain, $off, $level) =
1106 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001107 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001108 push(@chunks, [ $condition, $statement ]);
1109 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1110 return ($level, $linenr, @chunks);
1111 }
1112
1113 # Pull in the following conditional/block pairs and see if they
1114 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001115 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001116 ($statement, $condition, $linenr, $remain, $off, $level) =
1117 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001118 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001119 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001120 #print "C: push\n";
1121 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001122 }
1123
1124 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001125}
1126
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001127sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001128 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001129 my $line;
1130 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001131 my $blk = '';
1132 my @o;
1133 my @c;
1134 my @res = ();
1135
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001136 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001137 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001138 for ($line = $start; $remain > 0; $line++) {
1139 next if ($rawlines[$line] =~ /^-/);
1140 $remain--;
1141
1142 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001143
1144 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001145 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001146 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001147 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001148 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001149 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001150 $level = pop(@stack);
1151 }
1152
Andy Whitcroft01464f32010-10-26 14:23:19 -07001153 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001154 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1155 if ($off > 0) {
1156 $off--;
1157 next;
1158 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001159
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001160 if ($c eq $close && $level > 0) {
1161 $level--;
1162 last if ($level == 0);
1163 } elsif ($c eq $open) {
1164 $level++;
1165 }
1166 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001167
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001168 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001169 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001170 }
1171
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001172 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001173 }
1174
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001175 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001176}
1177sub ctx_block_outer {
1178 my ($linenr, $remain) = @_;
1179
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001180 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1181 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001182}
1183sub ctx_block {
1184 my ($linenr, $remain) = @_;
1185
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001186 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1187 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001188}
1189sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001190 my ($linenr, $remain, $off) = @_;
1191
1192 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1193 return @r;
1194}
1195sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001196 my ($linenr, $remain) = @_;
1197
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001198 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001199}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001200sub ctx_statement_level {
1201 my ($linenr, $remain, $off) = @_;
1202
1203 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1204}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001205
1206sub ctx_locate_comment {
1207 my ($first_line, $end_line) = @_;
1208
1209 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001210 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001211 return $current_comment if (defined $current_comment);
1212
1213 # Look through the context and try and figure out if there is a
1214 # comment.
1215 my $in_comment = 0;
1216 $current_comment = '';
1217 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001218 my $line = $rawlines[$linenr - 1];
1219 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001220 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1221 $in_comment = 1;
1222 }
1223 if ($line =~ m@/\*@) {
1224 $in_comment = 1;
1225 }
1226 if (!$in_comment && $current_comment ne '') {
1227 $current_comment = '';
1228 }
1229 $current_comment .= $line . "\n" if ($in_comment);
1230 if ($line =~ m@\*/@) {
1231 $in_comment = 0;
1232 }
1233 }
1234
1235 chomp($current_comment);
1236 return($current_comment);
1237}
1238sub ctx_has_comment {
1239 my ($first_line, $end_line) = @_;
1240 my $cmt = ctx_locate_comment($first_line, $end_line);
1241
Andy Whitcroft00df3442007-06-08 13:47:06 -07001242 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001243 ##print "CMMT: $cmt\n";
1244
1245 return ($cmt ne '');
1246}
1247
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001248sub raw_line {
1249 my ($linenr, $cnt) = @_;
1250
1251 my $offset = $linenr - 1;
1252 $cnt++;
1253
1254 my $line;
1255 while ($cnt) {
1256 $line = $rawlines[$offset++];
1257 next if (defined($line) && $line =~ /^-/);
1258 $cnt--;
1259 }
1260
1261 return $line;
1262}
1263
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001264sub cat_vet {
1265 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001266 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001267
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001268 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001269 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1270 $res .= $1;
1271 if ($2 ne '') {
1272 $coded = sprintf("^%c", unpack('C', $2) + 64);
1273 $res .= $coded;
1274 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001275 }
1276 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001277
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001278 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001279}
1280
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001281my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001282my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001283my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001284my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001285
1286sub annotate_reset {
1287 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001288 $av_pending = '_';
1289 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001290 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001291}
1292
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001293sub annotate_values {
1294 my ($stream, $type) = @_;
1295
1296 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001297 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001298 my $cur = $stream;
1299
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001300 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001301
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001302 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001303 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001304 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001305 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001306 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001307 print "WS($1)\n" if ($dbg_values > 1);
1308 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001309 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001310 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001311 }
1312
Florian Micklerc023e4732011-01-12 16:59:58 -08001313 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001314 print "CAST($1)\n" if ($dbg_values > 1);
1315 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001316 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001317
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001318 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001319 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001320 $type = 'T';
1321
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001322 } elsif ($cur =~ /^($Modifier)\s*/) {
1323 print "MODIFIER($1)\n" if ($dbg_values > 1);
1324 $type = 'T';
1325
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001326 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001327 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001328 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001329 push(@av_paren_type, $type);
1330 if ($2 ne '') {
1331 $av_pending = 'N';
1332 }
1333 $type = 'E';
1334
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001335 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001336 print "UNDEF($1)\n" if ($dbg_values > 1);
1337 $av_preprocessor = 1;
1338 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001339
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001340 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001341 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001342 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001343
1344 push(@av_paren_type, $type);
1345 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001346 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001347
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001348 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001349 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1350 $av_preprocessor = 1;
1351
1352 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1353
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001354 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001355
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001356 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001357 print "PRE_END($1)\n" if ($dbg_values > 1);
1358
1359 $av_preprocessor = 1;
1360
1361 # Assume all arms of the conditional end as this
1362 # one does, and continue as if the #endif was not here.
1363 pop(@av_paren_type);
1364 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001365 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001366
1367 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001368 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001369
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001370 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1371 print "ATTR($1)\n" if ($dbg_values > 1);
1372 $av_pending = $type;
1373 $type = 'N';
1374
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001375 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001376 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001377 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001378 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001379 }
1380 $type = 'N';
1381
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001382 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001383 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001384 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001385 $type = 'N';
1386
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001387 } elsif ($cur =~/^(case)/o) {
1388 print "CASE($1)\n" if ($dbg_values > 1);
1389 $av_pend_colon = 'C';
1390 $type = 'N';
1391
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001392 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001393 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001394 $type = 'N';
1395
1396 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001397 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001398 push(@av_paren_type, $av_pending);
1399 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001400 $type = 'N';
1401
1402 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001403 my $new_type = pop(@av_paren_type);
1404 if ($new_type ne '_') {
1405 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001406 print "PAREN('$1') -> $type\n"
1407 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001408 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001409 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001410 }
1411
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001412 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001413 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001414 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001415 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001416
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001417 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1418 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001419 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001420 } elsif ($type eq 'E') {
1421 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001422 }
1423 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1424 $type = 'V';
1425
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001426 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001427 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001428 $type = 'V';
1429
1430 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001431 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001432 $type = 'N';
1433
Andy Whitcroftcf655042008-03-04 14:28:20 -08001434 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001435 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001436 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001437 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001438
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001439 } elsif ($cur =~/^(,)/) {
1440 print "COMMA($1)\n" if ($dbg_values > 1);
1441 $type = 'C';
1442
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001443 } elsif ($cur =~ /^(\?)/o) {
1444 print "QUESTION($1)\n" if ($dbg_values > 1);
1445 $type = 'N';
1446
1447 } elsif ($cur =~ /^(:)/o) {
1448 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1449
1450 substr($var, length($res), 1, $av_pend_colon);
1451 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1452 $type = 'E';
1453 } else {
1454 $type = 'N';
1455 }
1456 $av_pend_colon = 'O';
1457
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001458 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001459 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001460 $type = 'N';
1461
Andy Whitcroft0d413862008-10-15 22:02:16 -07001462 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001463 my $variant;
1464
1465 print "OPV($1)\n" if ($dbg_values > 1);
1466 if ($type eq 'V') {
1467 $variant = 'B';
1468 } else {
1469 $variant = 'U';
1470 }
1471
1472 substr($var, length($res), 1, $variant);
1473 $type = 'N';
1474
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001475 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001476 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001477 if ($1 ne '++' && $1 ne '--') {
1478 $type = 'N';
1479 }
1480
1481 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001482 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001483 }
1484 if (defined $1) {
1485 $cur = substr($cur, length($1));
1486 $res .= $type x length($1);
1487 }
1488 }
1489
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001490 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001491}
1492
Andy Whitcroft8905a672007-11-28 16:21:06 -08001493sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001494 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001495 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001496 ^(?:
1497 $Modifier|
1498 $Storage|
1499 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001500 DEFINE_\S+
1501 )$|
1502 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001503 goto|
1504 return|
1505 case|
1506 else|
1507 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001508 do|
1509 \#|
1510 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001511 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001512 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001513 )}x;
1514 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1515 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001516 # Check for modifiers.
1517 $possible =~ s/\s*$Storage\s*//g;
1518 $possible =~ s/\s*$Sparse\s*//g;
1519 if ($possible =~ /^\s*$/) {
1520
1521 } elsif ($possible =~ /\s/) {
1522 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001523 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001524 if ($modifier !~ $notPermitted) {
1525 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1526 push(@modifierList, $modifier);
1527 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001528 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001529
1530 } else {
1531 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1532 push(@typeList, $possible);
1533 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001534 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001535 } else {
1536 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001537 }
1538}
1539
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001540my $prefix = '';
1541
Joe Perches000d1cc12011-07-25 17:13:25 -07001542sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001543 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001544
Joe Perchescbec18a2014-04-03 14:49:19 -07001545 return defined $use_type{$type} if (scalar keys %use_type > 0);
1546
1547 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001548}
1549
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001550sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001551 my ($level, $type, $msg) = @_;
1552
1553 if (!show_type($type) ||
1554 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001555 return 0;
1556 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001557 my $line;
1558 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001559 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001560 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001561 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001562 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001563 $line = (split('\n', $line))[0] . "\n" if ($terse);
1564
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001565 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001566
1567 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001568}
Joe Perchescbec18a2014-04-03 14:49:19 -07001569
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001570sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001571 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001572}
Joe Perches000d1cc12011-07-25 17:13:25 -07001573
Joe Perchesd752fcc2014-08-06 16:11:05 -07001574sub fixup_current_range {
1575 my ($lineRef, $offset, $length) = @_;
1576
1577 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1578 my $o = $1;
1579 my $l = $2;
1580 my $no = $o + $offset;
1581 my $nl = $l + $length;
1582 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1583 }
1584}
1585
1586sub fix_inserted_deleted_lines {
1587 my ($linesRef, $insertedRef, $deletedRef) = @_;
1588
1589 my $range_last_linenr = 0;
1590 my $delta_offset = 0;
1591
1592 my $old_linenr = 0;
1593 my $new_linenr = 0;
1594
1595 my $next_insert = 0;
1596 my $next_delete = 0;
1597
1598 my @lines = ();
1599
1600 my $inserted = @{$insertedRef}[$next_insert++];
1601 my $deleted = @{$deletedRef}[$next_delete++];
1602
1603 foreach my $old_line (@{$linesRef}) {
1604 my $save_line = 1;
1605 my $line = $old_line; #don't modify the array
1606 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1607 $delta_offset = 0;
1608 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1609 $range_last_linenr = $new_linenr;
1610 fixup_current_range(\$line, $delta_offset, 0);
1611 }
1612
1613 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1614 $deleted = @{$deletedRef}[$next_delete++];
1615 $save_line = 0;
1616 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1617 }
1618
1619 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1620 push(@lines, ${$inserted}{'LINE'});
1621 $inserted = @{$insertedRef}[$next_insert++];
1622 $new_linenr++;
1623 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1624 }
1625
1626 if ($save_line) {
1627 push(@lines, $line);
1628 $new_linenr++;
1629 }
1630
1631 $old_linenr++;
1632 }
1633
1634 return @lines;
1635}
1636
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001637sub fix_insert_line {
1638 my ($linenr, $line) = @_;
1639
1640 my $inserted = {
1641 LINENR => $linenr,
1642 LINE => $line,
1643 };
1644 push(@fixed_inserted, $inserted);
1645}
1646
1647sub fix_delete_line {
1648 my ($linenr, $line) = @_;
1649
1650 my $deleted = {
1651 LINENR => $linenr,
1652 LINE => $line,
1653 };
1654
1655 push(@fixed_deleted, $deleted);
1656}
1657
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001658sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001659 my ($type, $msg) = @_;
1660
1661 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001662 our $clean = 0;
1663 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001664 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001665 }
Joe Perches3705ce52013-07-03 15:05:31 -07001666 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001667}
1668sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001669 my ($type, $msg) = @_;
1670
1671 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001672 our $clean = 0;
1673 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001674 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001675 }
Joe Perches3705ce52013-07-03 15:05:31 -07001676 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001677}
1678sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001679 my ($type, $msg) = @_;
1680
1681 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001682 our $clean = 0;
1683 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001684 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001685 }
Joe Perches3705ce52013-07-03 15:05:31 -07001686 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001687}
1688
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001689sub check_absolute_file {
1690 my ($absolute, $herecurr) = @_;
1691 my $file = $absolute;
1692
1693 ##print "absolute<$absolute>\n";
1694
1695 # See if any suffix of this path is a path within the tree.
1696 while ($file =~ s@^[^/]*/@@) {
1697 if (-f "$root/$file") {
1698 ##print "file<$file>\n";
1699 last;
1700 }
1701 }
1702 if (! -f _) {
1703 return 0;
1704 }
1705
1706 # It is, so see if the prefix is acceptable.
1707 my $prefix = $absolute;
1708 substr($prefix, -length($file)) = '';
1709
1710 ##print "prefix<$prefix>\n";
1711 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001712 WARN("USE_RELATIVE_PATH",
1713 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001714 }
1715}
1716
Joe Perches3705ce52013-07-03 15:05:31 -07001717sub trim {
1718 my ($string) = @_;
1719
Joe Perchesb34c6482013-09-11 14:24:01 -07001720 $string =~ s/^\s+|\s+$//g;
1721
1722 return $string;
1723}
1724
1725sub ltrim {
1726 my ($string) = @_;
1727
1728 $string =~ s/^\s+//;
1729
1730 return $string;
1731}
1732
1733sub rtrim {
1734 my ($string) = @_;
1735
1736 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001737
1738 return $string;
1739}
1740
Joe Perches52ea8502013-11-12 15:10:09 -08001741sub string_find_replace {
1742 my ($string, $find, $replace) = @_;
1743
1744 $string =~ s/$find/$replace/g;
1745
1746 return $string;
1747}
1748
Joe Perches3705ce52013-07-03 15:05:31 -07001749sub tabify {
1750 my ($leading) = @_;
1751
1752 my $source_indent = 8;
1753 my $max_spaces_before_tab = $source_indent - 1;
1754 my $spaces_to_tab = " " x $source_indent;
1755
1756 #convert leading spaces to tabs
1757 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1758 #Remove spaces before a tab
1759 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1760
1761 return "$leading";
1762}
1763
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001764sub pos_last_openparen {
1765 my ($line) = @_;
1766
1767 my $pos = 0;
1768
1769 my $opens = $line =~ tr/\(/\(/;
1770 my $closes = $line =~ tr/\)/\)/;
1771
1772 my $last_openparen = 0;
1773
1774 if (($opens == 0) || ($closes >= $opens)) {
1775 return -1;
1776 }
1777
1778 my $len = length($line);
1779
1780 for ($pos = 0; $pos < $len; $pos++) {
1781 my $string = substr($line, $pos);
1782 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1783 $pos += length($1) - 1;
1784 } elsif (substr($line, $pos, 1) eq '(') {
1785 $last_openparen = $pos;
1786 } elsif (index($string, '(') == -1) {
1787 last;
1788 }
1789 }
1790
Joe Perches91cb5192014-04-03 14:49:32 -07001791 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001792}
1793
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001794sub process {
1795 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001796
1797 my $linenr=0;
1798 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001799 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001800 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001801 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001802
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001803 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001804 my $indent;
1805 my $previndent=0;
1806 my $stashindent=0;
1807
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001808 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001809 my $signoff = 0;
1810 my $is_patch = 0;
1811
Joe Perches29ee1b02014-08-06 16:10:35 -07001812 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001813 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001814 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001815 my $non_utf8_charset = 0;
1816
Joe Perches365dd4e2014-08-06 16:10:42 -07001817 my $last_blank_line = 0;
1818
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001819 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001820 our $cnt_lines = 0;
1821 our $cnt_error = 0;
1822 our $cnt_warn = 0;
1823 our $cnt_chk = 0;
1824
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001825 # Trace the real file/line as we go.
1826 my $realfile = '';
1827 my $realline = 0;
1828 my $realcnt = 0;
1829 my $here = '';
1830 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001831 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001832 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001833 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001834
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001835 my $prev_values = 'E';
1836
1837 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001838 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001839 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001840 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001841 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001842
Joe Perches7e51f192013-09-11 14:23:57 -07001843 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001844
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001845 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001846 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001847 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001848 my @setup_docs = ();
1849 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001850
Joe Perchesd8b07712013-11-12 15:10:06 -08001851 my $camelcase_file_seeded = 0;
1852
Andy Whitcroft773647a2008-03-28 14:15:58 -07001853 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001854 my $line;
1855 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001856 $linenr++;
1857 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001858
Joe Perches3705ce52013-07-03 15:05:31 -07001859 push(@fixed, $rawline) if ($fix);
1860
Andy Whitcroft773647a2008-03-28 14:15:58 -07001861 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001862 $setup_docs = 0;
1863 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1864 $setup_docs = 1;
1865 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001866 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001867 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001868 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1869 $realline=$1-1;
1870 if (defined $2) {
1871 $realcnt=$3+1;
1872 } else {
1873 $realcnt=1+1;
1874 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001875 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001876
1877 # Guestimate if this is a continuing comment. Run
1878 # the context looking for a comment "edge". If this
1879 # edge is a close comment then we must be in a comment
1880 # at context start.
1881 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001882 my $cnt = $realcnt;
1883 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1884 next if (defined $rawlines[$ln - 1] &&
1885 $rawlines[$ln - 1] =~ /^-/);
1886 $cnt--;
1887 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001888 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001889 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1890 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1891 ($edge) = $1;
1892 last;
1893 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001894 }
1895 if (defined $edge && $edge eq '*/') {
1896 $in_comment = 1;
1897 }
1898
1899 # Guestimate if this is a continuing comment. If this
1900 # is the start of a diff block and this line starts
1901 # ' *' then it is very likely a comment.
1902 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001903 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001904 {
1905 $in_comment = 1;
1906 }
1907
1908 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1909 sanitise_line_reset($in_comment);
1910
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001911 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001912 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001913 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001914 $line = sanitise_line($rawline);
1915 }
1916 push(@lines, $line);
1917
1918 if ($realcnt > 1) {
1919 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1920 } else {
1921 $realcnt = 0;
1922 }
1923
1924 #print "==>$rawline\n";
1925 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001926
1927 if ($setup_docs && $line =~ /^\+/) {
1928 push(@setup_docs, $line);
1929 }
1930 }
1931
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001932 $prefix = '';
1933
Andy Whitcroft773647a2008-03-28 14:15:58 -07001934 $realcnt = 0;
1935 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001936 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001937 foreach my $line (@lines) {
1938 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001939 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001940 my $sline = $line; #copy of $line
1941 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001942
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001943 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001944
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001945#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001946 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001947 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001948 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001949 $realline=$1-1;
1950 if (defined $2) {
1951 $realcnt=$3+1;
1952 } else {
1953 $realcnt=1+1;
1954 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001955 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001956 $prev_values = 'E';
1957
Andy Whitcroft773647a2008-03-28 14:15:58 -07001958 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001959 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001960 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001961 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001962 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001963
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001964# track the line number as we move through the hunk, note that
1965# new versions of GNU diff omit the leading space on completely
1966# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001967 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001968 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001969 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001970
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001971 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001972 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001973
1974 # Track the previous line.
1975 ($prevline, $stashline) = ($stashline, $line);
1976 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001977 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1978
Andy Whitcroft773647a2008-03-28 14:15:58 -07001979 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001980
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001981 } elsif ($realcnt == 1) {
1982 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001983 }
1984
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001985 my $hunk_line = ($realcnt != 0);
1986
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001987#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001988 $prefix = "$filename:$realline: " if ($emacs && $file);
1989 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1990
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001991 $here = "#$linenr: " if (!$file);
1992 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001993
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001994 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001995 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001996 if ($line =~ /^diff --git.*?(\S+)$/) {
1997 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001998 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001999 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002000 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002001 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002002 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002003 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002004 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002005
2006 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002007 if (!$file && $tree && $p1_prefix ne '' &&
2008 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002009 WARN("PATCH_PREFIX",
2010 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002011 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002012
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002013 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002014 ERROR("MODIFIED_INCLUDE_ASM",
2015 "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 -07002016 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002017 $found_file = 1;
2018 }
2019
2020 if ($found_file) {
2021 if ($realfile =~ m@^(drivers/net/|net/)@) {
2022 $check = 1;
2023 } else {
2024 $check = $check_orig;
2025 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002026 next;
2027 }
2028
Randy Dunlap389834b2007-06-08 13:47:03 -07002029 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002030
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002031 my $hereline = "$here\n$rawline\n";
2032 my $herecurr = "$here\n$rawline\n";
2033 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002034
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002035 $cnt_lines++ if ($realcnt != 0);
2036
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002037# Check for incorrect file permissions
2038 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2039 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002040 if ($realfile !~ m@scripts/@ &&
2041 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002042 ERROR("EXECUTE_PERMISSIONS",
2043 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002044 }
2045 }
2046
Joe Perches20112472011-07-25 17:13:23 -07002047# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002048 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002049 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002050 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002051 }
2052
2053# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002054 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002055 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002056 my $space_before = $1;
2057 my $sign_off = $2;
2058 my $space_after = $3;
2059 my $email = $4;
2060 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2061
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002062 if ($sign_off !~ /$signature_tags/) {
2063 WARN("BAD_SIGN_OFF",
2064 "Non-standard signature: $sign_off\n" . $herecurr);
2065 }
Joe Perches20112472011-07-25 17:13:23 -07002066 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002067 if (WARN("BAD_SIGN_OFF",
2068 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2069 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002070 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002071 "$ucfirst_sign_off $email";
2072 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002073 }
Joe Perches20112472011-07-25 17:13:23 -07002074 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002075 if (WARN("BAD_SIGN_OFF",
2076 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2077 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002078 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002079 "$ucfirst_sign_off $email";
2080 }
2081
Joe Perches20112472011-07-25 17:13:23 -07002082 }
2083 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002084 if (WARN("BAD_SIGN_OFF",
2085 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2086 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002087 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002088 "$ucfirst_sign_off $email";
2089 }
Joe Perches20112472011-07-25 17:13:23 -07002090 }
2091
2092 my ($email_name, $email_address, $comment) = parse_email($email);
2093 my $suggested_email = format_email(($email_name, $email_address));
2094 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002095 ERROR("BAD_SIGN_OFF",
2096 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002097 } else {
2098 my $dequoted = $suggested_email;
2099 $dequoted =~ s/^"//;
2100 $dequoted =~ s/" </ </;
2101 # Don't force email to have quotes
2102 # Allow just an angle bracketed address
2103 if ("$dequoted$comment" ne $email &&
2104 "<$email_address>$comment" ne $email &&
2105 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002106 WARN("BAD_SIGN_OFF",
2107 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002108 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002109 }
Joe Perches7e51f192013-09-11 14:23:57 -07002110
2111# Check for duplicate signatures
2112 my $sig_nospace = $line;
2113 $sig_nospace =~ s/\s//g;
2114 $sig_nospace = lc($sig_nospace);
2115 if (defined $signatures{$sig_nospace}) {
2116 WARN("BAD_SIGN_OFF",
2117 "Duplicate signature\n" . $herecurr);
2118 } else {
2119 $signatures{$sig_nospace} = 1;
2120 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002121 }
2122
Joe Perches9b3189e2014-06-04 16:12:10 -07002123# Check for old stable address
2124 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2125 ERROR("STABLE_ADDRESS",
2126 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2127 }
2128
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002129# Check for unwanted Gerrit info
2130 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2131 ERROR("GERRIT_CHANGE_ID",
2132 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2133 }
2134
Joe Perchesd311cd42014-08-06 16:10:57 -07002135# Check for improperly formed commit descriptions
2136 if ($in_commit_log &&
2137 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
Joe Perches66881732014-09-09 14:50:55 -07002138 !($line =~ /\b[Cc]ommit [0-9a-f]{12,40} \("/ ||
2139 ($line =~ /\b[Cc]ommit [0-9a-f]{12,40}\s*$/ &&
2140 defined $rawlines[$linenr] &&
2141 $rawlines[$linenr] =~ /^\s*\("/))) {
Joe Perchesd311cd42014-08-06 16:10:57 -07002142 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2143 my $init_char = $1;
2144 my $orig_commit = lc($2);
2145 my $id = '01234567890ab';
2146 my $desc = 'commit description';
2147 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2148 ERROR("GIT_COMMIT_ID",
Joe Perches3f6316b2014-08-29 15:18:26 -07002149 "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
Joe Perchesd311cd42014-08-06 16:10:57 -07002150 }
2151
Joe Perches13f19372014-08-06 16:10:59 -07002152# Check for added, moved or deleted files
2153 if (!$reported_maintainer_file && !$in_commit_log &&
2154 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2155 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2156 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2157 (defined($1) || defined($2))))) {
2158 $reported_maintainer_file = 1;
2159 WARN("FILE_PATH_CHANGES",
2160 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2161 }
2162
Andy Whitcroft00df3442007-06-08 13:47:06 -07002163# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002164 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002165 ERROR("CORRUPTED_PATCH",
2166 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002167 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002168 }
2169
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002170# Check for absolute kernel paths.
2171 if ($tree) {
2172 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2173 my $file = $1;
2174
2175 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2176 check_absolute_file($1, $herecurr)) {
2177 #
2178 } else {
2179 check_absolute_file($file, $herecurr);
2180 }
2181 }
2182 }
2183
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002184# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2185 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002186 $rawline !~ m/^$UTF8*$/) {
2187 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2188
2189 my $blank = copy_spacing($rawline);
2190 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2191 my $hereptr = "$hereline$ptr\n";
2192
Joe Perches34d99212011-07-25 17:13:26 -07002193 CHK("INVALID_UTF8",
2194 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002195 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002196
Joe Perches15662b32011-10-31 17:13:12 -07002197# Check if it's the start of a commit log
2198# (not a header line and we haven't seen the patch filename)
2199 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002200 !($rawline =~ /^\s+\S/ ||
2201 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002202 $in_header_lines = 0;
2203 $in_commit_log = 1;
2204 }
2205
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002206# Check if there is UTF-8 in a commit log when a mail header has explicitly
2207# declined it, i.e defined some charset where it is missing.
2208 if ($in_header_lines &&
2209 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2210 $1 !~ /utf-8/i) {
2211 $non_utf8_charset = 1;
2212 }
2213
2214 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002215 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002216 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002217 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2218 }
2219
Andy Whitcroft306708542008-10-15 22:02:28 -07002220# ignore non-hunk lines and lines being removed
2221 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002222
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002223#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002224 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002225 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002226 if (ERROR("DOS_LINE_ENDINGS",
2227 "DOS line endings\n" . $herevet) &&
2228 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002229 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002230 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002231 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2232 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002233 if (ERROR("TRAILING_WHITESPACE",
2234 "trailing whitespace\n" . $herevet) &&
2235 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002236 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002237 }
2238
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002239 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002240 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002241
Josh Triplett4783f892013-11-12 15:10:12 -08002242# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002243 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002244 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2245 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002246 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2247 my $msg_type = \&ERROR;
2248 $msg_type = \&CHK if ($file);
2249 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002250 "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 -08002251 }
2252
Andi Kleen33549572010-05-24 14:33:29 -07002253# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002254# Only applies when adding the entry originally, after that we do not have
2255# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002256 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002257 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002258 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002259 my $cnt = $realcnt;
2260 my $ln = $linenr + 1;
2261 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002262 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002263 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002264 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002265 $f = $lines[$ln - 1];
2266 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2267 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002268
2269 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002270 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002271
Joe Perches8d73e0e2014-08-06 16:10:46 -07002272 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002273 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002274 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002275 $length = -1;
2276 }
2277
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002278 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002279 $f =~ s/#.*//;
2280 $f =~ s/^\s+//;
2281 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002282 if ($f =~ /^\s*config\s/) {
2283 $is_end = 1;
2284 last;
2285 }
Andi Kleen33549572010-05-24 14:33:29 -07002286 $length++;
2287 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002288 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002289 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2290 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002291 }
2292
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002293# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2294 if ($realfile =~ /Kconfig/ &&
2295 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2296 WARN("CONFIG_EXPERIMENTAL",
2297 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2298 }
2299
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002300 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2301 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2302 my $flag = $1;
2303 my $replacement = {
2304 'EXTRA_AFLAGS' => 'asflags-y',
2305 'EXTRA_CFLAGS' => 'ccflags-y',
2306 'EXTRA_CPPFLAGS' => 'cppflags-y',
2307 'EXTRA_LDFLAGS' => 'ldflags-y',
2308 };
2309
2310 WARN("DEPRECATED_VARIABLE",
2311 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2312 }
2313
Rob Herringbff5da42014-01-23 15:54:51 -08002314# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002315 if (defined $root &&
2316 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2317 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2318
Rob Herringbff5da42014-01-23 15:54:51 -08002319 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2320
Florian Vaussardcc933192014-04-03 14:49:27 -07002321 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2322 my $vp_file = $dt_path . "vendor-prefixes.txt";
2323
Rob Herringbff5da42014-01-23 15:54:51 -08002324 foreach my $compat (@compats) {
2325 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002326 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2327 my $compat3 = $compat;
2328 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2329 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002330 if ( $? >> 8 ) {
2331 WARN("UNDOCUMENTED_DT_STRING",
2332 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2333 }
2334
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002335 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2336 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002337 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002338 if ( $? >> 8 ) {
2339 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002340 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002341 }
2342 }
2343 }
2344
Andy Whitcroft5368df22008-10-15 22:02:27 -07002345# check we are in a valid source file if not then ignore this hunk
2346 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2347
Joe Perches6cd7f382012-12-17 16:01:54 -08002348#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002349 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002350 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002351 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002352 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002353 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002354 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002355 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002356 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002357 }
2358
Josh Triplettca56dc02012-03-23 15:02:21 -07002359# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002360# to grep for the string. Make exceptions when the previous string ends in a
2361# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2362# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002363 if ($line =~ /^\+\s*"/ &&
2364 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002365 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002366 WARN("SPLIT_STRING",
2367 "quoted string split across lines\n" . $hereprev);
2368 }
2369
Dan Carpenterece96592014-08-06 16:11:29 -07002370# check for missing a space in a string concatination
2371 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
2372 WARN('MISSING_SPACE',
2373 "break quoted strings at a space character\n" . $hereprev);
2374 }
2375
Joe Perches5e79d962010-03-05 13:43:55 -08002376# check for spaces before a quoted newline
2377 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002378 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2379 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2380 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002381 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
Joe Perches3705ce52013-07-03 15:05:31 -07002382 }
2383
Joe Perches5e79d962010-03-05 13:43:55 -08002384 }
2385
Andy Whitcroft8905a672007-11-28 16:21:06 -08002386# check for adding lines without a newline.
2387 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002388 WARN("MISSING_EOF_NEWLINE",
2389 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002390 }
2391
Mike Frysinger42e41c52009-09-21 17:04:40 -07002392# Blackfin: use hi/lo macros
2393 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2394 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2395 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002396 ERROR("LO_MACRO",
2397 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002398 }
2399 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2400 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002401 ERROR("HI_MACRO",
2402 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002403 }
2404 }
2405
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002406# check we are in a valid source file C or perl if not then ignore this hunk
2407 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002408
2409# at the beginning of a line any tabs must come first and anything
2410# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002411 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2412 $rawline =~ /^\+\s* \s*/) {
2413 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002414 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002415 if (ERROR("CODE_INDENT",
2416 "code indent should use tabs where possible\n" . $herevet) &&
2417 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002418 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002419 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002420 }
2421
Alberto Panizzo08e44362010-03-05 13:43:54 -08002422# check for space before tabs.
2423 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2424 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002425 if (WARN("SPACE_BEFORE_TAB",
2426 "please, no space before tabs\n" . $herevet) &&
2427 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002428 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002429 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002430 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002431 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002432 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002433 }
2434
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002435# check for && or || at the start of a line
2436 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2437 CHK("LOGICAL_CONTINUATIONS",
2438 "Logical continuations should be on the previous line\n" . $hereprev);
2439 }
2440
2441# check multi-line statement indentation matches previous line
2442 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002443 $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 -07002444 $prevline =~ /^\+(\t*)(.*)$/;
2445 my $oldindent = $1;
2446 my $rest = $2;
2447
2448 my $pos = pos_last_openparen($rest);
2449 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002450 $line =~ /^(\+| )([ \t]*)/;
2451 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002452
2453 my $goodtabindent = $oldindent .
2454 "\t" x ($pos / 8) .
2455 " " x ($pos % 8);
2456 my $goodspaceindent = $oldindent . " " x $pos;
2457
2458 if ($newindent ne $goodtabindent &&
2459 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002460
2461 if (CHK("PARENTHESIS_ALIGNMENT",
2462 "Alignment should match open parenthesis\n" . $hereprev) &&
2463 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002464 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002465 s/^\+[ \t]*/\+$goodtabindent/;
2466 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002467 }
2468 }
2469 }
2470
Joe Perches308cc8d2014-08-06 16:11:27 -07002471 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|{)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002472 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002473 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002474 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002475 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002476 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002477 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002478 }
2479
Joe Perches05880602012-10-04 17:13:35 -07002480 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002481 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002482 $rawline =~ /^\+[ \t]*\*/ &&
2483 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002484 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2485 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2486 }
2487
2488 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002489 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2490 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002491 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002492 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2493 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2494 "networking block comments start with * on subsequent lines\n" . $hereprev);
2495 }
2496
2497 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002498 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2499 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2500 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2501 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002502 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2503 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2504 }
2505
Joe Perches7f619192014-08-06 16:10:39 -07002506# check for missing blank lines after struct/union declarations
2507# with exceptions for various attributes and macros
2508 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2509 $line =~ /^\+/ &&
2510 !($line =~ /^\+\s*$/ ||
2511 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2512 $line =~ /^\+\s*MODULE_/i ||
2513 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2514 $line =~ /^\+[a-z_]*init/ ||
2515 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2516 $line =~ /^\+\s*DECLARE/ ||
2517 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002518 if (CHK("LINE_SPACING",
2519 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2520 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002521 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002522 }
Joe Perches7f619192014-08-06 16:10:39 -07002523 }
2524
Joe Perches365dd4e2014-08-06 16:10:42 -07002525# check for multiple consecutive blank lines
2526 if ($prevline =~ /^[\+ ]\s*$/ &&
2527 $line =~ /^\+\s*$/ &&
2528 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002529 if (CHK("LINE_SPACING",
2530 "Please don't use multiple blank lines\n" . $hereprev) &&
2531 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002532 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002533 }
2534
Joe Perches365dd4e2014-08-06 16:10:42 -07002535 $last_blank_line = $linenr;
2536 }
2537
Joe Perches3b617e32014-04-03 14:49:28 -07002538# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002539 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2540 # actual declarations
2541 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002542 # function pointer declarations
2543 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002544 # foo bar; where foo is some local typedef or #define
2545 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2546 # known declaration macros
2547 $prevline =~ /^\+\s+$declaration_macros/) &&
2548 # for "else if" which can look like "$Ident $Ident"
2549 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2550 # other possible extensions of declaration lines
2551 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2552 # not starting a section or a macro "\" extended line
2553 $prevline =~ /(?:\{\s*|\\)$/) &&
2554 # looks like a declaration
2555 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002556 # function pointer declarations
2557 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002558 # foo bar; where foo is some local typedef or #define
2559 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2560 # known declaration macros
2561 $sline =~ /^\+\s+$declaration_macros/ ||
2562 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002563 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002564 # start or end of block or continuation of declaration
2565 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2566 # bitfield continuation
2567 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2568 # other possible extensions of declaration lines
2569 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2570 # indentation of previous and current line are the same
2571 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002572 if (WARN("LINE_SPACING",
2573 "Missing a blank line after declarations\n" . $hereprev) &&
2574 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002575 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002576 }
Joe Perches3b617e32014-04-03 14:49:28 -07002577 }
2578
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002579# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002580# Exceptions:
2581# 1) within comments
2582# 2) indented preprocessor commands
2583# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002584 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002585 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002586 if (WARN("LEADING_SPACE",
2587 "please, no spaces at the start of a line\n" . $herevet) &&
2588 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002589 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002590 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002591 }
2592
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002593# check we are in a valid C source file if not then ignore this hunk
2594 next if ($realfile !~ /\.(h|c)$/);
2595
Joe Perches032a4c02014-08-06 16:10:29 -07002596# check indentation of any line with a bare else
2597# if the previous line is a break or return and is indented 1 tab more...
2598 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2599 my $tabs = length($1) + 1;
2600 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2601 WARN("UNNECESSARY_ELSE",
2602 "else is not generally useful after a break or return\n" . $hereprev);
2603 }
2604 }
2605
Joe Perchesc00df192014-08-06 16:11:01 -07002606# check indentation of a line with a break;
2607# if the previous line is a goto or return and is indented the same # of tabs
2608 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2609 my $tabs = $1;
2610 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2611 WARN("UNNECESSARY_BREAK",
2612 "break is not useful after a goto or return\n" . $hereprev);
2613 }
2614 }
2615
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002616# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2617 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2618 WARN("CONFIG_EXPERIMENTAL",
2619 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2620 }
2621
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002622# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002623 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002624 WARN("CVS_KEYWORD",
2625 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002626 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002627
Mike Frysinger42e41c52009-09-21 17:04:40 -07002628# Blackfin: don't use __builtin_bfin_[cs]sync
2629 if ($line =~ /__builtin_bfin_csync/) {
2630 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002631 ERROR("CSYNC",
2632 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002633 }
2634 if ($line =~ /__builtin_bfin_ssync/) {
2635 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002636 ERROR("SSYNC",
2637 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002638 }
2639
Joe Perches56e77d72013-02-21 16:44:14 -08002640# check for old HOTPLUG __dev<foo> section markings
2641 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2642 WARN("HOTPLUG_SECTION",
2643 "Using $1 is unnecessary\n" . $herecurr);
2644 }
2645
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002646# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002647 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2648 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002649#print "LINE<$line>\n";
2650 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002651 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002652 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002653 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002654 $stat =~ s/\n./\n /g;
2655 $cond =~ s/\n./\n /g;
2656
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002657#print "linenr<$linenr> <$stat>\n";
2658 # If this statement has no statement boundaries within
2659 # it there is no point in retrying a statement scan
2660 # until we hit end of it.
2661 my $frag = $stat; $frag =~ s/;+\s*$//;
2662 if ($frag !~ /(?:{|;)/) {
2663#print "skip<$line_nr_next>\n";
2664 $suppress_statement = $line_nr_next;
2665 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002666
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002667 # Find the real next line.
2668 $realline_next = $line_nr_next;
2669 if (defined $realline_next &&
2670 (!defined $lines[$realline_next - 1] ||
2671 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2672 $realline_next++;
2673 }
2674
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002675 my $s = $stat;
2676 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002677
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002678 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002679 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002680
2681 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002682 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002683
Andy Whitcroft463f2862009-09-21 17:04:34 -07002684 } elsif ($s =~ /^.\s*else\b/s) {
2685
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002686 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002687 } 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 -07002688 my $type = $1;
2689 $type =~ s/\s+/ /g;
2690 possible($type, "A:" . $s);
2691
Andy Whitcroft8905a672007-11-28 16:21:06 -08002692 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002693 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002694 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002695 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002696
2697 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002698 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002699 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002700 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002701
2702 # Check for any sort of function declaration.
2703 # int foo(something bar, other baz);
2704 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002705 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 -08002706 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002707
Andy Whitcroftcf655042008-03-04 14:28:20 -08002708 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002709 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002710 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002711
Andy Whitcroft8905a672007-11-28 16:21:06 -08002712 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002713 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002714
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002715 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002716 }
2717 }
2718 }
2719
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002720 }
2721
Andy Whitcroft653d4872007-06-23 17:16:34 -07002722#
2723# Checks which may be anchored in the context.
2724#
2725
2726# Check for switch () and associated case and default
2727# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002728 if ($line=~/\bswitch\s*\(.*\)/) {
2729 my $err = '';
2730 my $sep = '';
2731 my @ctx = ctx_block_outer($linenr, $realcnt);
2732 shift(@ctx);
2733 for my $ctx (@ctx) {
2734 my ($clen, $cindent) = line_stats($ctx);
2735 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2736 $indent != $cindent) {
2737 $err .= "$sep$ctx\n";
2738 $sep = '';
2739 } else {
2740 $sep = "[...]\n";
2741 }
2742 }
2743 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002744 ERROR("SWITCH_CASE_INDENT_LEVEL",
2745 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002746 }
2747 }
2748
2749# if/while/etc brace do not go on next line, unless defining a do while loop,
2750# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07002751 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002752 my $pre_ctx = "$1$2";
2753
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002754 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002755
2756 if ($line =~ /^\+\t{6,}/) {
2757 WARN("DEEP_INDENTATION",
2758 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2759 }
2760
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002761 my $ctx_cnt = $realcnt - $#ctx - 1;
2762 my $ctx = join("\n", @ctx);
2763
Andy Whitcroft548596d2008-07-23 21:29:01 -07002764 my $ctx_ln = $linenr;
2765 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002766
Andy Whitcroft548596d2008-07-23 21:29:01 -07002767 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2768 defined $lines[$ctx_ln - 1] &&
2769 $lines[$ctx_ln - 1] =~ /^-/)) {
2770 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2771 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002772 $ctx_ln++;
2773 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002774
Andy Whitcroft53210162008-07-23 21:29:03 -07002775 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2776 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002777
Joe Perchesd752fcc2014-08-06 16:11:05 -07002778 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002779 ERROR("OPEN_BRACE",
2780 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002781 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002782 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002783 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2784 $ctx =~ /\)\s*\;\s*$/ &&
2785 defined $lines[$ctx_ln - 1])
2786 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002787 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2788 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002789 WARN("TRAILING_SEMICOLON",
2790 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002791 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002792 }
2793 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002794 }
2795
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002796# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07002797 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002798 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2799 ctx_statement_block($linenr, $realcnt, 0)
2800 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002801 my ($s, $c) = ($stat, $cond);
2802
2803 substr($s, 0, length($c), '');
2804
2805 # Make sure we remove the line prefixes as we have
2806 # none on the first line, and are going to readd them
2807 # where necessary.
2808 $s =~ s/\n./\n/gs;
2809
2810 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002811 my @newlines = ($c =~ /\n/gs);
2812 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002813
2814 # We want to check the first line inside the block
2815 # starting at the end of the conditional, so remove:
2816 # 1) any blank line termination
2817 # 2) any opening brace { on end of the line
2818 # 3) any do (...) {
2819 my $continuation = 0;
2820 my $check = 0;
2821 $s =~ s/^.*\bdo\b//;
2822 $s =~ s/^\s*{//;
2823 if ($s =~ s/^\s*\\//) {
2824 $continuation = 1;
2825 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002826 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002827 $check = 1;
2828 $cond_lines++;
2829 }
2830
2831 # Also ignore a loop construct at the end of a
2832 # preprocessor statement.
2833 if (($prevline =~ /^.\s*#\s*define\s/ ||
2834 $prevline =~ /\\\s*$/) && $continuation == 0) {
2835 $check = 0;
2836 }
2837
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002838 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002839 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002840 while ($cond_ptr != $cond_lines) {
2841 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002842
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002843 # If we see an #else/#elif then the code
2844 # is not linear.
2845 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2846 $check = 0;
2847 }
2848
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002849 # Ignore:
2850 # 1) blank lines, they should be at 0,
2851 # 2) preprocessor lines, and
2852 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002853 if ($continuation ||
2854 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002855 $s =~ /^\s*#\s*?/ ||
2856 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002857 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002858 if ($s =~ s/^.*?\n//) {
2859 $cond_lines++;
2860 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002861 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002862 }
2863
2864 my (undef, $sindent) = line_stats("+" . $s);
2865 my $stat_real = raw_line($linenr, $cond_lines);
2866
2867 # Check if either of these lines are modified, else
2868 # this is not this patch's fault.
2869 if (!defined($stat_real) ||
2870 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2871 $check = 0;
2872 }
2873 if (defined($stat_real) && $cond_lines > 1) {
2874 $stat_real = "[...]\n$stat_real";
2875 }
2876
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002877 #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 -07002878
2879 if ($check && (($sindent % 8) != 0 ||
2880 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002881 WARN("SUSPECT_CODE_INDENT",
2882 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002883 }
2884 }
2885
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002886 # Track the 'values' across context and added lines.
2887 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002888 my ($curr_values, $curr_vars) =
2889 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002890 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002891 if ($dbg_values) {
2892 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002893 print "$linenr > .$outline\n";
2894 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002895 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002896 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002897 $prev_values = substr($curr_values, -1);
2898
Andy Whitcroft00df3442007-06-08 13:47:06 -07002899#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002900 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002901
Andy Whitcroft653d4872007-06-23 17:16:34 -07002902# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002903 if ($dbg_type) {
2904 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002905 ERROR("TEST_TYPE",
2906 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002907 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002908 ERROR("TEST_NOT_TYPE",
2909 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002910 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002911 next;
2912 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002913# TEST: allow direct testing of the attribute matcher.
2914 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002915 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002916 ERROR("TEST_ATTR",
2917 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002918 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002919 ERROR("TEST_NOT_ATTR",
2920 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002921 }
2922 next;
2923 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002924
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002925# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002926 if ($line =~ /^.\s*{/ &&
2927 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002928 if (ERROR("OPEN_BRACE",
2929 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002930 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
2931 fix_delete_line($fixlinenr - 1, $prevrawline);
2932 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002933 my $fixedline = $prevrawline;
2934 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002935 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002936 $fixedline = $line;
2937 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002938 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002939 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002940 }
2941
Andy Whitcroft653d4872007-06-23 17:16:34 -07002942#
2943# Checks which are anchored on the added line.
2944#
2945
2946# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002947 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002948 my $path = $1;
2949 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002950 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002951 "malformed #include filename\n" . $herecurr);
2952 }
2953 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2954 ERROR("UAPI_INCLUDE",
2955 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002956 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002957 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002958
2959# no C99 // comments
2960 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002961 if (ERROR("C99_COMMENTS",
2962 "do not use C99 // comments\n" . $herecurr) &&
2963 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002964 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07002965 if ($line =~ /\/\/(.*)$/) {
2966 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07002967 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07002968 }
2969 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002970 }
2971 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002972 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002973 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002974
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002975# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2976# the whole statement.
2977#print "APW <$lines[$realline_next - 1]>\n";
2978 if (defined $realline_next &&
2979 exists $lines[$realline_next - 1] &&
2980 !defined $suppress_export{$realline_next} &&
2981 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2982 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002983 # Handle definitions which produce identifiers with
2984 # a prefix:
2985 # XXX(foo);
2986 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002987 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002988 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002989 $name =~ /^${Ident}_$2/) {
2990#print "FOO C name<$name>\n";
2991 $suppress_export{$realline_next} = 1;
2992
2993 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002994 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002995 ^.DEFINE_$Ident\(\Q$name\E\)|
2996 ^.DECLARE_$Ident\(\Q$name\E\)|
2997 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002998 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2999 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003000 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003001#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3002 $suppress_export{$realline_next} = 2;
3003 } else {
3004 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003005 }
3006 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003007 if (!defined $suppress_export{$linenr} &&
3008 $prevline =~ /^.\s*$/ &&
3009 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3010 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3011#print "FOO B <$lines[$linenr - 1]>\n";
3012 $suppress_export{$linenr} = 2;
3013 }
3014 if (defined $suppress_export{$linenr} &&
3015 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003016 WARN("EXPORT_SYMBOL",
3017 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003018 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003019
Joe Eloff5150bda2010-08-09 17:21:00 -07003020# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003021 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3022 if (ERROR("GLOBAL_INITIALISERS",
3023 "do not initialise globals to 0 or NULL\n" .
3024 $herecurr) &&
3025 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003026 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003027 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003028 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003029# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003030 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3031 if (ERROR("INITIALISED_STATIC",
3032 "do not initialise statics to 0 or NULL\n" .
3033 $herecurr) &&
3034 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003035 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003036 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003037 }
3038
Joe Perches18130872014-08-06 16:11:22 -07003039# check for misordered declarations of char/short/int/long with signed/unsigned
3040 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3041 my $tmp = trim($1);
3042 WARN("MISORDERED_TYPE",
3043 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3044 }
3045
Joe Perchescb710ec2010-10-26 14:23:20 -07003046# check for static const char * arrays.
3047 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003048 WARN("STATIC_CONST_CHAR_ARRAY",
3049 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003050 $herecurr);
3051 }
3052
3053# check for static char foo[] = "bar" declarations.
3054 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003055 WARN("STATIC_CONST_CHAR_ARRAY",
3056 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003057 $herecurr);
3058 }
3059
Joe Perches9b0fa602014-04-03 14:49:18 -07003060# check for non-global char *foo[] = {"bar", ...} declarations.
3061 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3062 WARN("STATIC_CONST_CHAR_ARRAY",
3063 "char * array declaration might be better as static const\n" .
3064 $herecurr);
3065 }
3066
Joe Perchesb36190c2014-01-27 17:07:18 -08003067# check for function declarations without arguments like "int foo()"
3068 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3069 if (ERROR("FUNCTION_WITHOUT_ARGS",
3070 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3071 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003072 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003073 }
3074 }
3075
Joe Perches92e112f2013-12-13 11:36:22 -07003076# check for uses of DEFINE_PCI_DEVICE_TABLE
3077 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3078 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3079 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3080 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003081 $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 -07003082 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003083 }
3084
Andy Whitcroft653d4872007-06-23 17:16:34 -07003085# check for new typedefs, only function parameters and sparse annotations
3086# make sense.
3087 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003088 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003089 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003090 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003091 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003092 WARN("NEW_TYPEDEFS",
3093 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003094 }
3095
3096# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003097 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003098 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3099 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003100 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003101
Andy Whitcroft65863862009-01-06 14:41:21 -08003102 # Should start with a space.
3103 $to =~ s/^(\S)/ $1/;
3104 # Should not end with a space.
3105 $to =~ s/\s+$//;
3106 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003107 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003108 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003109
Joe Perches3705ce52013-07-03 15:05:31 -07003110## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003111 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003112 if (ERROR("POINTER_LOCATION",
3113 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3114 $fix) {
3115 my $sub_from = $ident;
3116 my $sub_to = $ident;
3117 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003118 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003119 s@\Q$sub_from\E@$sub_to@;
3120 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003121 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003122 }
3123 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3124 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003125 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003126
Andy Whitcroft65863862009-01-06 14:41:21 -08003127 # Should start with a space.
3128 $to =~ s/^(\S)/ $1/;
3129 # Should not end with a space.
3130 $to =~ s/\s+$//;
3131 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003132 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003133 }
3134 # Modifiers should have spaces.
3135 $to =~ s/(\b$Modifier$)/$1 /;
3136
Joe Perches3705ce52013-07-03 15:05:31 -07003137## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003138 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003139 if (ERROR("POINTER_LOCATION",
3140 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3141 $fix) {
3142
3143 my $sub_from = $match;
3144 my $sub_to = $match;
3145 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003146 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003147 s@\Q$sub_from\E@$sub_to@;
3148 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003149 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003150 }
3151
3152# # no BUG() or BUG_ON()
3153# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3154# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3155# print "$herecurr";
3156# $clean = 0;
3157# }
3158
Andy Whitcroft8905a672007-11-28 16:21:06 -08003159 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003160 WARN("LINUX_VERSION_CODE",
3161 "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 -08003162 }
3163
Joe Perches17441222011-06-15 15:08:17 -07003164# check for uses of printk_ratelimit
3165 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003166 WARN("PRINTK_RATELIMITED",
3167"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003168 }
3169
Andy Whitcroft00df3442007-06-08 13:47:06 -07003170# printk should use KERN_* levels. Note that follow on printk's on the
3171# same line do not need a level, so we use the current block context
3172# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003173# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003174# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003175 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003176 my $ok = 0;
3177 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3178 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003179 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003180 # with "\n" ignore it, else it is to blame
3181 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3182 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3183 $ok = 1;
3184 }
3185 last;
3186 }
3187 }
3188 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003189 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3190 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003191 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003192 }
3193
Joe Perches243f3802012-05-31 16:26:09 -07003194 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3195 my $orig = $1;
3196 my $level = lc($orig);
3197 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003198 my $level2 = $level;
3199 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003200 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003201 "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 -07003202 }
3203
3204 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003205 if (WARN("PREFER_PR_LEVEL",
3206 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3207 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003208 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003209 s/\bpr_warning\b/pr_warn/;
3210 }
Joe Perches243f3802012-05-31 16:26:09 -07003211 }
3212
Joe Perchesdc139312013-02-21 16:44:13 -08003213 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3214 my $orig = $1;
3215 my $level = lc($orig);
3216 $level = "warn" if ($level eq "warning");
3217 $level = "dbg" if ($level eq "debug");
3218 WARN("PREFER_DEV_LEVEL",
3219 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3220 }
3221
Andy Whitcroft653d4872007-06-23 17:16:34 -07003222# function brace can't be on same line, except for #defines of do while,
3223# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003224 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003225 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003226 if (ERROR("OPEN_BRACE",
3227 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3228 $fix) {
3229 fix_delete_line($fixlinenr, $rawline);
3230 my $fixed_line = $rawline;
3231 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3232 my $line1 = $1;
3233 my $line2 = $2;
3234 fix_insert_line($fixlinenr, ltrim($line1));
3235 fix_insert_line($fixlinenr, "\+{");
3236 if ($line2 !~ /^\s*$/) {
3237 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3238 }
3239 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003240 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003241
Andy Whitcroft8905a672007-11-28 16:21:06 -08003242# open braces for enum, union and struct go on the same line.
3243 if ($line =~ /^.\s*{/ &&
3244 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003245 if (ERROR("OPEN_BRACE",
3246 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3247 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3248 fix_delete_line($fixlinenr - 1, $prevrawline);
3249 fix_delete_line($fixlinenr, $rawline);
3250 my $fixedline = rtrim($prevrawline) . " {";
3251 fix_insert_line($fixlinenr, $fixedline);
3252 $fixedline = $rawline;
3253 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3254 if ($fixedline !~ /^\+\s*$/) {
3255 fix_insert_line($fixlinenr, $fixedline);
3256 }
3257 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003258 }
3259
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003260# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003261 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3262 if (WARN("SPACING",
3263 "missing space after $1 definition\n" . $herecurr) &&
3264 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003265 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003266 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3267 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003268 }
3269
Joe Perches31070b52014-01-23 15:54:49 -08003270# Function pointer declarations
3271# check spacing between type, funcptr, and args
3272# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003273 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003274 my $declare = $1;
3275 my $pre_pointer_space = $2;
3276 my $post_pointer_space = $3;
3277 my $funcname = $4;
3278 my $post_funcname_space = $5;
3279 my $pre_args_space = $6;
3280
Joe Perches91f72e92014-04-03 14:49:12 -07003281# the $Declare variable will capture all spaces after the type
3282# so check it for a missing trailing missing space but pointer return types
3283# don't need a space so don't warn for those.
3284 my $post_declare_space = "";
3285 if ($declare =~ /(\s+)$/) {
3286 $post_declare_space = $1;
3287 $declare = rtrim($declare);
3288 }
3289 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003290 WARN("SPACING",
3291 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003292 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003293 }
3294
3295# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003296# This test is not currently implemented because these declarations are
3297# equivalent to
3298# int foo(int bar, ...)
3299# and this is form shouldn't/doesn't generate a checkpatch warning.
3300#
3301# elsif ($declare =~ /\s{2,}$/) {
3302# WARN("SPACING",
3303# "Multiple spaces after return type\n" . $herecurr);
3304# }
Joe Perches31070b52014-01-23 15:54:49 -08003305
3306# unnecessary space "type ( *funcptr)(args...)"
3307 if (defined $pre_pointer_space &&
3308 $pre_pointer_space =~ /^\s/) {
3309 WARN("SPACING",
3310 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3311 }
3312
3313# unnecessary space "type (* funcptr)(args...)"
3314 if (defined $post_pointer_space &&
3315 $post_pointer_space =~ /^\s/) {
3316 WARN("SPACING",
3317 "Unnecessary space before function pointer name\n" . $herecurr);
3318 }
3319
3320# unnecessary space "type (*funcptr )(args...)"
3321 if (defined $post_funcname_space &&
3322 $post_funcname_space =~ /^\s/) {
3323 WARN("SPACING",
3324 "Unnecessary space after function pointer name\n" . $herecurr);
3325 }
3326
3327# unnecessary space "type (*funcptr) (args...)"
3328 if (defined $pre_args_space &&
3329 $pre_args_space =~ /^\s/) {
3330 WARN("SPACING",
3331 "Unnecessary space before function pointer arguments\n" . $herecurr);
3332 }
3333
3334 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003335 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003336 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003337 }
3338 }
3339
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003340# check for spacing round square brackets; allowed:
3341# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003342# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3343# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003344 while ($line =~ /(.*?\s)\[/g) {
3345 my ($where, $prefix) = ($-[1], $1);
3346 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003347 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003348 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003349 if (ERROR("BRACKET_SPACE",
3350 "space prohibited before open square bracket '['\n" . $herecurr) &&
3351 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003352 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003353 s/^(\+.*?)\s+\[/$1\[/;
3354 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003355 }
3356 }
3357
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003358# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003359 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003360 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003361 my $ctx_before = substr($line, 0, $-[1]);
3362 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003363
3364 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003365 if ($name =~ /^(?:
3366 if|for|while|switch|return|case|
3367 volatile|__volatile__|
3368 __attribute__|format|__extension__|
3369 asm|__asm__)$/x)
3370 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003371 # cpp #define statements have non-optional spaces, ie
3372 # if there is a space between the name and the open
3373 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003374 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003375
3376 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003377 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003378
3379 # If this whole things ends with a type its most
3380 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003381 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003382
3383 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003384 if (WARN("SPACING",
3385 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3386 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003387 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003388 s/\b$name\s+\(/$name\(/;
3389 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003390 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003391 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003392
Andy Whitcroft653d4872007-06-23 17:16:34 -07003393# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003394 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003395 my $fixed_line = "";
3396 my $line_fixed = 0;
3397
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003398 my $ops = qr{
3399 <<=|>>=|<=|>=|==|!=|
3400 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3401 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003402 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003403 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003404 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003405 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003406
3407## print("element count: <" . $#elements . ">\n");
3408## foreach my $el (@elements) {
3409## print("el: <$el>\n");
3410## }
3411
3412 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003413 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003414
Joe Perches3705ce52013-07-03 15:05:31 -07003415 foreach my $el (@elements) {
3416 push(@fix_elements, substr($rawline, $off, length($el)));
3417 $off += length($el);
3418 }
3419
3420 $off = 0;
3421
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003422 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003423 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003424
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003425 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003426
3427 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3428
3429## print("n: <$n> good: <$good>\n");
3430
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003431 $off += length($elements[$n]);
3432
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003433 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003434 my $ca = substr($opline, 0, $off);
3435 my $cc = '';
3436 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3437 $cc = substr($opline, $off + length($elements[$n + 1]));
3438 }
3439 my $cb = "$ca$;$cc";
3440
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003441 my $a = '';
3442 $a = 'V' if ($elements[$n] ne '');
3443 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003444 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003445 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3446 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003447 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003448
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003449 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003450
3451 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003452 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003453 $c = 'V' if ($elements[$n + 2] ne '');
3454 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003455 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003456 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3457 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003458 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003459 } else {
3460 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003461 }
3462
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003463 my $ctx = "${a}x${c}";
3464
3465 my $at = "(ctx:$ctx)";
3466
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003467 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003468 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003469
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003470 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003471 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003472
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003473 # Get the full operator variant.
3474 my $opv = $op . substr($curr_vars, $off, 1);
3475
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003476 # Ignore operators passed as parameters.
3477 if ($op_type ne 'V' &&
3478 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3479
Andy Whitcroftcf655042008-03-04 14:28:20 -08003480# # Ignore comments
3481# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003482
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003483 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003484 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003485 if ($ctx !~ /.x[WEBC]/ &&
3486 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003487 if (ERROR("SPACING",
3488 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003489 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003490 $line_fixed = 1;
3491 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003492 }
3493
3494 # // is a comment
3495 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003496
Joe Perchesb00e4812014-04-03 14:49:33 -07003497 # : when part of a bitfield
3498 } elsif ($opv eq ':B') {
3499 # skip the bitfield test for now
3500
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003501 # No spaces for:
3502 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003503 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003504 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003505 if (ERROR("SPACING",
3506 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003507 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003508 if (defined $fix_elements[$n + 2]) {
3509 $fix_elements[$n + 2] =~ s/^\s+//;
3510 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003511 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003512 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003513 }
3514
3515 # , must have a space on the right.
3516 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003517 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003518 if (ERROR("SPACING",
3519 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003520 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003521 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003522 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003523 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003524 }
3525
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003526 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003527 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003528 #warn "'*' is part of type\n";
3529
3530 # unary operators should have a space before and
3531 # none after. May be left adjacent to another
3532 # unary operator, or a cast
3533 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003534 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003535 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003536 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003537 if (ERROR("SPACING",
3538 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003539 if ($n != $last_after + 2) {
3540 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3541 $line_fixed = 1;
3542 }
Joe Perches3705ce52013-07-03 15:05:31 -07003543 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003544 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003545 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003546 # A unary '*' may be const
3547
3548 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003549 if (ERROR("SPACING",
3550 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003551 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003552 if (defined $fix_elements[$n + 2]) {
3553 $fix_elements[$n + 2] =~ s/^\s+//;
3554 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003555 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003556 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003557 }
3558
3559 # unary ++ and unary -- are allowed no space on one side.
3560 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003561 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003562 if (ERROR("SPACING",
3563 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003564 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003565 $line_fixed = 1;
3566 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003567 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003568 if ($ctx =~ /Wx[BE]/ ||
3569 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003570 if (ERROR("SPACING",
3571 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003572 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003573 $line_fixed = 1;
3574 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003575 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003576 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003577 if (ERROR("SPACING",
3578 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003579 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003580 if (defined $fix_elements[$n + 2]) {
3581 $fix_elements[$n + 2] =~ s/^\s+//;
3582 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003583 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003584 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003585 }
3586
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003587 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003588 } elsif ($op eq '<<' or $op eq '>>' or
3589 $op eq '&' or $op eq '^' or $op eq '|' or
3590 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003591 $op eq '*' or $op eq '/' or
3592 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003593 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003594 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003595 if (ERROR("SPACING",
3596 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003597 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3598 if (defined $fix_elements[$n + 2]) {
3599 $fix_elements[$n + 2] =~ s/^\s+//;
3600 }
Joe Perches3705ce52013-07-03 15:05:31 -07003601 $line_fixed = 1;
3602 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003603 }
3604
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003605 # A colon needs no spaces before when it is
3606 # terminating a case value or a label.
3607 } elsif ($opv eq ':C' || $opv eq ':L') {
3608 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003609 if (ERROR("SPACING",
3610 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003611 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003612 $line_fixed = 1;
3613 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003614 }
3615
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003616 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003617 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003618 my $ok = 0;
3619
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003620 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003621 if (($op eq '<' &&
3622 $cc =~ /^\S+\@\S+>/) ||
3623 ($op eq '>' &&
3624 $ca =~ /<\S+\@\S+$/))
3625 {
3626 $ok = 1;
3627 }
3628
Joe Perches84731622013-11-12 15:10:05 -08003629 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003630 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003631 my $msg_type = \&ERROR;
3632 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3633
3634 if (&{$msg_type}("SPACING",
3635 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003636 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3637 if (defined $fix_elements[$n + 2]) {
3638 $fix_elements[$n + 2] =~ s/^\s+//;
3639 }
Joe Perches3705ce52013-07-03 15:05:31 -07003640 $line_fixed = 1;
3641 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003642 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003643 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003644 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003645
3646## print("n: <$n> GOOD: <$good>\n");
3647
3648 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003649 }
Joe Perches3705ce52013-07-03 15:05:31 -07003650
3651 if (($#elements % 2) == 0) {
3652 $fixed_line = $fixed_line . $fix_elements[$#elements];
3653 }
3654
Joe Perches194f66f2014-08-06 16:11:03 -07003655 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3656 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003657 }
3658
3659
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003660 }
3661
Joe Perches786b6322013-07-03 15:05:32 -07003662# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003663 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003664 if (WARN("SPACING",
3665 "space prohibited before semicolon\n" . $herecurr) &&
3666 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003667 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003668 s/^(\+.*\S)\s+;/$1;/;
3669 }
3670 }
3671
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003672# check for multiple assignments
3673 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003674 CHK("MULTIPLE_ASSIGNMENTS",
3675 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003676 }
3677
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003678## # check for multiple declarations, allowing for a function declaration
3679## # continuation.
3680## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3681## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3682##
3683## # Remove any bracketed sections to ensure we do not
3684## # falsly report the parameters of functions.
3685## my $ln = $line;
3686## while ($ln =~ s/\([^\(\)]*\)//g) {
3687## }
3688## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003689## WARN("MULTIPLE_DECLARATION",
3690## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003691## }
3692## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003693
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003694#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003695 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3696 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003697 if (ERROR("SPACING",
3698 "space required before the open brace '{'\n" . $herecurr) &&
3699 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003700 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003701 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003702 }
3703
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003704## # check for blank lines before declarations
3705## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3706## $prevrawline =~ /^.\s*$/) {
3707## WARN("SPACING",
3708## "No blank lines before declarations\n" . $hereprev);
3709## }
3710##
3711
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003712# closing brace should have a space following it when it has anything
3713# on the line
3714 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003715 if (ERROR("SPACING",
3716 "space required after that close brace '}'\n" . $herecurr) &&
3717 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003718 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003719 s/}((?!(?:,|;|\)))\S)/} $1/;
3720 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003721 }
3722
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003723# check spacing on square brackets
3724 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003725 if (ERROR("SPACING",
3726 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3727 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003728 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003729 s/\[\s+/\[/;
3730 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003731 }
3732 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003733 if (ERROR("SPACING",
3734 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3735 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003736 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003737 s/\s+\]/\]/;
3738 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003739 }
3740
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003741# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003742 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3743 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003744 if (ERROR("SPACING",
3745 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3746 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003747 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003748 s/\(\s+/\(/;
3749 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003750 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003751 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003752 $line !~ /for\s*\(.*;\s+\)/ &&
3753 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003754 if (ERROR("SPACING",
3755 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3756 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003757 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003758 s/\s+\)/\)/;
3759 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003760 }
3761
Joe Perchese2826fd2014-08-06 16:10:48 -07003762# check unnecessary parentheses around addressof/dereference single $Lvals
3763# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3764
3765 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3766 CHK("UNNECESSARY_PARENTHESES",
3767 "Unnecessary parentheses around $1\n" . $herecurr);
3768 }
3769
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003770#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003771 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003772 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003773 if (WARN("INDENTED_LABEL",
3774 "labels should not be indented\n" . $herecurr) &&
3775 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003776 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003777 s/^(.)\s+/$1/;
3778 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003779 }
3780
Joe Perches5b9553a2014-04-03 14:49:21 -07003781# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003782 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003783 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003784 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003785 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3786 my $value = $1;
3787 $value = deparenthesize($value);
3788 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3789 ERROR("RETURN_PARENTHESES",
3790 "return is not a function, parentheses are not required\n" . $herecurr);
3791 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003792 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003793 ERROR("SPACING",
3794 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003795 }
3796 }
Joe Perches507e5142013-11-12 15:10:13 -08003797
Joe Perchesb43ae212014-06-23 13:22:07 -07003798# unnecessary return in a void function
3799# at end-of-function, with the previous line a single leading tab, then return;
3800# and the line before that not a goto label target like "out:"
3801 if ($sline =~ /^[ \+]}\s*$/ &&
3802 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3803 $linenr >= 3 &&
3804 $lines[$linenr - 3] =~ /^[ +]/ &&
3805 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003806 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003807 "void function return statements are not generally useful\n" . $hereprev);
3808 }
Joe Perches9819cf22014-06-04 16:12:09 -07003809
Joe Perches189248d2014-01-23 15:54:47 -08003810# if statements using unnecessary parentheses - ie: if ((foo == bar))
3811 if ($^V && $^V ge 5.10.0 &&
3812 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3813 my $openparens = $1;
3814 my $count = $openparens =~ tr@\(@\(@;
3815 my $msg = "";
3816 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3817 my $comp = $4; #Not $1 because of $LvalOrFunc
3818 $msg = " - maybe == should be = ?" if ($comp eq "==");
3819 WARN("UNNECESSARY_PARENTHESES",
3820 "Unnecessary parentheses$msg\n" . $herecurr);
3821 }
3822 }
3823
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003824# Return of what appears to be an errno should normally be -'ve
3825 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3826 my $name = $1;
3827 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003828 WARN("USE_NEGATIVE_ERRNO",
3829 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003830 }
3831 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003832
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003833# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003834 if ($line =~ /\b(if|while|for|switch)\(/) {
3835 if (ERROR("SPACING",
3836 "space required before the open parenthesis '('\n" . $herecurr) &&
3837 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003838 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003839 s/\b(if|while|for|switch)\(/$1 \(/;
3840 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003841 }
3842
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003843# Check for illegal assignment in if conditional -- and check for trailing
3844# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003845 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003846 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3847 ctx_statement_block($linenr, $realcnt, 0)
3848 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003849 my ($stat_next) = ctx_statement_block($line_nr_next,
3850 $remain_next, $off_next);
3851 $stat_next =~ s/\n./\n /g;
3852 ##print "stat<$stat> stat_next<$stat_next>\n";
3853
3854 if ($stat_next =~ /^\s*while\b/) {
3855 # If the statement carries leading newlines,
3856 # then count those as offsets.
3857 my ($whitespace) =
3858 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3859 my $offset =
3860 statement_rawlines($whitespace) - 1;
3861
3862 $suppress_whiletrailers{$line_nr_next +
3863 $offset} = 1;
3864 }
3865 }
3866 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003867 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003868 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003869 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003870
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003871 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003872 ERROR("ASSIGN_IN_IF",
3873 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003874 }
3875
3876 # Find out what is on the end of the line after the
3877 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003878 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003879 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003880 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003881 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3882 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003883 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003884 # Find out how long the conditional actually is.
3885 my @newlines = ($c =~ /\n/gs);
3886 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003887 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003888
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003889 $stat_real = raw_line($linenr, $cond_lines)
3890 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003891 if (defined($stat_real) && $cond_lines > 1) {
3892 $stat_real = "[...]\n$stat_real";
3893 }
3894
Joe Perches000d1cc12011-07-25 17:13:25 -07003895 ERROR("TRAILING_STATEMENTS",
3896 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003897 }
3898 }
3899
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003900# Check for bitwise tests written as boolean
3901 if ($line =~ /
3902 (?:
3903 (?:\[|\(|\&\&|\|\|)
3904 \s*0[xX][0-9]+\s*
3905 (?:\&\&|\|\|)
3906 |
3907 (?:\&\&|\|\|)
3908 \s*0[xX][0-9]+\s*
3909 (?:\&\&|\|\||\)|\])
3910 )/x)
3911 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003912 WARN("HEXADECIMAL_BOOLEAN_TEST",
3913 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003914 }
3915
Andy Whitcroft8905a672007-11-28 16:21:06 -08003916# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003917 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3918 my $s = $1;
3919 $s =~ s/$;//g; # Remove any comments
3920 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003921 ERROR("TRAILING_STATEMENTS",
3922 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003923 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003924 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003925# if should not continue a brace
3926 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003927 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07003928 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003929 $herecurr);
3930 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003931# case and default should not have general statements after them
3932 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3933 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003934 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003935 \s*return\s+
3936 )/xg)
3937 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003938 ERROR("TRAILING_STATEMENTS",
3939 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003940 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003941
3942 # Check for }<nl>else {, these must be at the same
3943 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07003944 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
3945 $previndent == $indent) {
3946 if (ERROR("ELSE_AFTER_BRACE",
3947 "else should follow close brace '}'\n" . $hereprev) &&
3948 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3949 fix_delete_line($fixlinenr - 1, $prevrawline);
3950 fix_delete_line($fixlinenr, $rawline);
3951 my $fixedline = $prevrawline;
3952 $fixedline =~ s/}\s*$//;
3953 if ($fixedline !~ /^\+\s*$/) {
3954 fix_insert_line($fixlinenr, $fixedline);
3955 }
3956 $fixedline = $rawline;
3957 $fixedline =~ s/^(.\s*)else/$1} else/;
3958 fix_insert_line($fixlinenr, $fixedline);
3959 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003960 }
3961
Joe Perches8b8856f2014-08-06 16:11:14 -07003962 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
3963 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003964 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3965
3966 # Find out what is on the end of the line after the
3967 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003968 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003969 $s =~ s/\n.*//g;
3970
3971 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07003972 if (ERROR("WHILE_AFTER_BRACE",
3973 "while should follow close brace '}'\n" . $hereprev) &&
3974 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3975 fix_delete_line($fixlinenr - 1, $prevrawline);
3976 fix_delete_line($fixlinenr, $rawline);
3977 my $fixedline = $prevrawline;
3978 my $trailing = $rawline;
3979 $trailing =~ s/^\+//;
3980 $trailing = trim($trailing);
3981 $fixedline =~ s/}\s*$/} $trailing/;
3982 fix_insert_line($fixlinenr, $fixedline);
3983 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003984 }
3985 }
3986
Joe Perches95e2c602013-07-03 15:05:20 -07003987#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003988 while ($line =~ m{($Constant|$Lval)}g) {
3989 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003990
3991#gcc binary extension
3992 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003993 if (WARN("GCC_BINARY_CONSTANT",
3994 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3995 $fix) {
3996 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07003997 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003998 s/\b$var\b/$hexval/;
3999 }
Joe Perches95e2c602013-07-03 15:05:20 -07004000 }
4001
4002#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004003 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004004 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004005#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004006 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004007#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07004008 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004009 while ($var =~ m{($Ident)}g) {
4010 my $word = $1;
4011 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004012 if ($check) {
4013 seed_camelcase_includes();
4014 if (!$file && !$camelcase_file_seeded) {
4015 seed_camelcase_file($realfile);
4016 $camelcase_file_seeded = 1;
4017 }
4018 }
Joe Perches7e781f62013-09-11 14:23:55 -07004019 if (!defined $camelcase{$word}) {
4020 $camelcase{$word} = 1;
4021 CHK("CAMELCASE",
4022 "Avoid CamelCase: <$word>\n" . $herecurr);
4023 }
Joe Perches34456862013-07-03 15:05:34 -07004024 }
Joe Perches323c1262012-12-17 16:02:07 -08004025 }
4026 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004027
4028#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004029 if ($line =~ /\#\s*define.*\\\s+$/) {
4030 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4031 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4032 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004033 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004034 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004035 }
4036
Andy Whitcroft653d4872007-06-23 17:16:34 -07004037#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004038 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004039 my $file = "$1.h";
4040 my $checkfile = "include/linux/$file";
4041 if (-f "$root/$checkfile" &&
4042 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004043 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004044 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004045 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004046 CHK("ARCH_INCLUDE_LINUX",
4047 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004048 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004049 WARN("INCLUDE_LINUX",
4050 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004051 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004052 }
4053 }
4054
Andy Whitcroft653d4872007-06-23 17:16:34 -07004055# multi-statement macros should be enclosed in a do while loop, grab the
4056# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004057# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004058 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4059 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004060 my $ln = $linenr;
4061 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004062 my ($off, $dstat, $dcond, $rest);
4063 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004064 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004065 ctx_statement_block($linenr, $realcnt, 0);
4066 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004067 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004068 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004069
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004070 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004071 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004072 $dstat =~ s/\\\n.//g;
4073 $dstat =~ s/^\s*//s;
4074 $dstat =~ s/\s*$//s;
4075
4076 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004077 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4078 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004079 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004080 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004081 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004082
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004083 # Flatten any obvious string concatentation.
4084 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4085 $dstat =~ s/$Ident\s*("X*")/$1/)
4086 {
4087 }
4088
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004089 my $exceptions = qr{
4090 $Declare|
4091 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004092 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004093 DECLARE_PER_CPU|
4094 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004095 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004096 union|
4097 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004098 \.$Ident\s*=\s*|
4099 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004100 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004101 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004102 if ($dstat ne '' &&
4103 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4104 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004105 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004106 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004107 $dstat !~ /$exceptions/ &&
4108 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004109 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004110 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004111 $dstat !~ /^for\s*$Constant$/ && # for (...)
4112 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4113 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004114 $dstat !~ /^\({/ && # ({...
4115 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004116 {
4117 $ctx =~ s/\n*$//;
4118 my $herectx = $here . "\n";
4119 my $cnt = statement_rawlines($ctx);
4120
4121 for (my $n = 0; $n < $cnt; $n++) {
4122 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004123 }
4124
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004125 if ($dstat =~ /;/) {
4126 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4127 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4128 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004129 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004130 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004131 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004132 }
Joe Perches5023d342012-12-17 16:01:47 -08004133
Joe Perches481eb482012-12-17 16:01:56 -08004134# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004135
4136 } else {
4137 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004138 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4139 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004140 $line =~ /^\+.*\\$/) {
4141 WARN("LINE_CONTINUATIONS",
4142 "Avoid unnecessary line continuations\n" . $herecurr);
4143 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004144 }
4145
Joe Perchesb13edf72012-07-30 14:41:24 -07004146# do {} while (0) macro tests:
4147# single-statement macros do not need to be enclosed in do while (0) loop,
4148# macro should not end with a semicolon
4149 if ($^V && $^V ge 5.10.0 &&
4150 $realfile !~ m@/vmlinux.lds.h$@ &&
4151 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4152 my $ln = $linenr;
4153 my $cnt = $realcnt;
4154 my ($off, $dstat, $dcond, $rest);
4155 my $ctx = '';
4156 ($dstat, $dcond, $ln, $cnt, $off) =
4157 ctx_statement_block($linenr, $realcnt, 0);
4158 $ctx = $dstat;
4159
4160 $dstat =~ s/\\\n.//g;
4161
4162 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4163 my $stmts = $2;
4164 my $semis = $3;
4165
4166 $ctx =~ s/\n*$//;
4167 my $cnt = statement_rawlines($ctx);
4168 my $herectx = $here . "\n";
4169
4170 for (my $n = 0; $n < $cnt; $n++) {
4171 $herectx .= raw_line($linenr, $n) . "\n";
4172 }
4173
Joe Perchesac8e97f2012-08-21 16:15:53 -07004174 if (($stmts =~ tr/;/;/) == 1 &&
4175 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004176 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4177 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4178 }
4179 if (defined $semis && $semis ne "") {
4180 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4181 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4182 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004183 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4184 $ctx =~ s/\n*$//;
4185 my $cnt = statement_rawlines($ctx);
4186 my $herectx = $here . "\n";
4187
4188 for (my $n = 0; $n < $cnt; $n++) {
4189 $herectx .= raw_line($linenr, $n) . "\n";
4190 }
4191
4192 WARN("TRAILING_SEMICOLON",
4193 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004194 }
4195 }
4196
Mike Frysinger080ba922009-01-06 14:41:25 -08004197# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4198# all assignments may have only one of the following with an assignment:
4199# .
4200# ALIGN(...)
4201# VMLINUX_SYMBOL(...)
4202 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004203 WARN("MISSING_VMLINUX_SYMBOL",
4204 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004205 }
4206
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004207# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004208 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4209 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004210 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004211 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004212 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4213 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004214 my @allowed = ();
4215 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004216 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004217 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004218 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004219 for my $chunk (@chunks) {
4220 my ($cond, $block) = @{$chunk};
4221
Andy Whitcroft773647a2008-03-28 14:15:58 -07004222 # If the condition carries leading newlines, then count those as offsets.
4223 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4224 my $offset = statement_rawlines($whitespace) - 1;
4225
Joe Perchesaad4f612012-03-23 15:02:19 -07004226 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004227 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4228
4229 # We have looked at and allowed this specific line.
4230 $suppress_ifbraces{$ln + $offset} = 1;
4231
4232 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004233 $ln += statement_rawlines($block) - 1;
4234
Andy Whitcroft773647a2008-03-28 14:15:58 -07004235 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004236
4237 $seen++ if ($block =~ /^\s*{/);
4238
Joe Perchesaad4f612012-03-23 15:02:19 -07004239 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004240 if (statement_lines($cond) > 1) {
4241 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004242 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004243 }
4244 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004245 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004246 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004247 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004248 if (statement_block_size($block) > 1) {
4249 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004250 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004251 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004252 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004253 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004254 if ($seen) {
4255 my $sum_allowed = 0;
4256 foreach (@allowed) {
4257 $sum_allowed += $_;
4258 }
4259 if ($sum_allowed == 0) {
4260 WARN("BRACES",
4261 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4262 } elsif ($sum_allowed != $allow &&
4263 $seen != $allow) {
4264 CHK("BRACES",
4265 "braces {} should be used on all arms of this statement\n" . $herectx);
4266 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004267 }
4268 }
4269 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004270 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004271 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004272 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004273
Andy Whitcroftcf655042008-03-04 14:28:20 -08004274 # Check the pre-context.
4275 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4276 #print "APW: ALLOWED: pre<$1>\n";
4277 $allowed = 1;
4278 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004279
4280 my ($level, $endln, @chunks) =
4281 ctx_statement_full($linenr, $realcnt, $-[0]);
4282
Andy Whitcroftcf655042008-03-04 14:28:20 -08004283 # Check the condition.
4284 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004285 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004286 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004287 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004288 }
4289 if (statement_lines($cond) > 1) {
4290 #print "APW: ALLOWED: cond<$cond>\n";
4291 $allowed = 1;
4292 }
4293 if ($block =~/\b(?:if|for|while)\b/) {
4294 #print "APW: ALLOWED: block<$block>\n";
4295 $allowed = 1;
4296 }
4297 if (statement_block_size($block) > 1) {
4298 #print "APW: ALLOWED: lines block<$block>\n";
4299 $allowed = 1;
4300 }
4301 # Check the post-context.
4302 if (defined $chunks[1]) {
4303 my ($cond, $block) = @{$chunks[1]};
4304 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004305 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004306 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004307 if ($block =~ /^\s*\{/) {
4308 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4309 $allowed = 1;
4310 }
4311 }
4312 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004313 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004314 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004315
Andy Whitcroftf0556632008-10-15 22:02:23 -07004316 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004317 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004318 }
4319
Joe Perches000d1cc12011-07-25 17:13:25 -07004320 WARN("BRACES",
4321 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004322 }
4323 }
4324
Joe Perches0979ae62012-12-17 16:01:59 -08004325# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004326 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004327 CHK("BRACES",
4328 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4329 }
Joe Perches77b9a532013-07-03 15:05:29 -07004330 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004331 CHK("BRACES",
4332 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4333 }
4334
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004335# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004336 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4337 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004338 WARN("VOLATILE",
4339 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004340 }
4341
Andy Whitcroft00df3442007-06-08 13:47:06 -07004342# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004343 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004344 CHK("REDUNDANT_CODE",
4345 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004346 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004347 }
4348
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004349# check for needless "if (<foo>) fn(<foo>)" uses
4350 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4351 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4352 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4353 WARN('NEEDLESS_IF',
4354 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004355 }
4356 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004357
Joe Perchesebfdc402014-08-06 16:10:27 -07004358# check for unnecessary "Out of Memory" messages
4359 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4360 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4361 (defined $1 || defined $3) &&
4362 $linenr > 3) {
4363 my $testval = $2;
4364 my $testline = $lines[$linenr - 3];
4365
4366 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4367# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4368
4369 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4370 WARN("OOM_MESSAGE",
4371 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4372 }
4373 }
4374
Joe Perches8716de32013-09-11 14:24:05 -07004375# check for bad placement of section $InitAttribute (e.g.: __initdata)
4376 if ($line =~ /(\b$InitAttribute\b)/) {
4377 my $attr = $1;
4378 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4379 my $ptr = $1;
4380 my $var = $2;
4381 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4382 ERROR("MISPLACED_INIT",
4383 "$attr should be placed after $var\n" . $herecurr)) ||
4384 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4385 WARN("MISPLACED_INIT",
4386 "$attr should be placed after $var\n" . $herecurr))) &&
4387 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004388 $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 -07004389 }
4390 }
4391 }
4392
Joe Perchese970b882013-11-12 15:10:10 -08004393# check for $InitAttributeData (ie: __initdata) with const
4394 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4395 my $attr = $1;
4396 $attr =~ /($InitAttributePrefix)(.*)/;
4397 my $attr_prefix = $1;
4398 my $attr_type = $2;
4399 if (ERROR("INIT_ATTRIBUTE",
4400 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4401 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004402 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004403 s/$InitAttributeData/${attr_prefix}initconst/;
4404 }
4405 }
4406
4407# check for $InitAttributeConst (ie: __initconst) without const
4408 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4409 my $attr = $1;
4410 if (ERROR("INIT_ATTRIBUTE",
4411 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4412 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004413 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004414 /(^\+\s*(?:static\s+))/;
4415 $lead = rtrim($1);
4416 $lead = "$lead " if ($lead !~ /^\+$/);
4417 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004418 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08004419 }
4420 }
4421
Joe Perchesfbdb8132014-04-03 14:49:14 -07004422# don't use __constant_<foo> functions outside of include/uapi/
4423 if ($realfile !~ m@^include/uapi/@ &&
4424 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4425 my $constant_func = $1;
4426 my $func = $constant_func;
4427 $func =~ s/^__constant_//;
4428 if (WARN("CONSTANT_CONVERSION",
4429 "$constant_func should be $func\n" . $herecurr) &&
4430 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004431 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004432 }
4433 }
4434
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004435# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004436 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004437 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004438 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004439 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004440 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004441 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4442 }
4443 if ($delay > 2000) {
4444 WARN("LONG_UDELAY",
4445 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004446 }
4447 }
4448
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004449# warn about unexpectedly long msleep's
4450 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4451 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004452 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004453 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004454 }
4455 }
4456
Joe Perches36ec1932013-07-03 15:05:25 -07004457# check for comparisons of jiffies
4458 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4459 WARN("JIFFIES_COMPARISON",
4460 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4461 }
4462
Joe Perches9d7a34a2013-07-03 15:05:26 -07004463# check for comparisons of get_jiffies_64()
4464 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4465 WARN("JIFFIES_COMPARISON",
4466 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4467 }
4468
Andy Whitcroft00df3442007-06-08 13:47:06 -07004469# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004470# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004471# print "#ifdef in C files should be avoided\n";
4472# print "$herecurr";
4473# $clean = 0;
4474# }
4475
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004476# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004477 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004478 if (ERROR("SPACING",
4479 "exactly one space required after that #$1\n" . $herecurr) &&
4480 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004481 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004482 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4483 }
4484
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004485 }
4486
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004487# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004488 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4489 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004490 my $which = $1;
4491 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004492 CHK("UNCOMMENTED_DEFINITION",
4493 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004494 }
4495 }
4496# check for memory barriers without a comment.
4497 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4498 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004499 WARN("MEMORY_BARRIER",
4500 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004501 }
4502 }
4503# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004504 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004505 CHK("ARCH_DEFINES",
4506 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004507 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004508
Tobias Klauserd4977c72010-05-24 14:33:30 -07004509# Check that the storage class is at the beginning of a declaration
4510 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004511 WARN("STORAGE_CLASS",
4512 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004513 }
4514
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004515# check the location of the inline attribute, that it is between
4516# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004517 if ($line =~ /\b$Type\s+$Inline\b/ ||
4518 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004519 ERROR("INLINE_LOCATION",
4520 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004521 }
4522
Andy Whitcroft8905a672007-11-28 16:21:06 -08004523# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004524 if ($realfile !~ m@\binclude/uapi/@ &&
4525 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004526 if (WARN("INLINE",
4527 "plain inline is preferred over $1\n" . $herecurr) &&
4528 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004529 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004530
4531 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004532 }
4533
Joe Perches3d130fd2011-01-12 17:00:00 -08004534# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004535 if ($realfile !~ m@\binclude/uapi/@ &&
4536 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004537 WARN("PREFER_PACKED",
4538 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004539 }
4540
Joe Perches39b7e282011-07-25 17:13:24 -07004541# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004542 if ($realfile !~ m@\binclude/uapi/@ &&
4543 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004544 WARN("PREFER_ALIGNED",
4545 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004546 }
4547
Joe Perches5f14d3b2012-01-10 15:09:52 -08004548# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004549 if ($realfile !~ m@\binclude/uapi/@ &&
4550 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004551 if (WARN("PREFER_PRINTF",
4552 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4553 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004554 $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 -07004555
4556 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004557 }
4558
Joe Perches6061d942012-03-23 15:02:16 -07004559# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004560 if ($realfile !~ m@\binclude/uapi/@ &&
4561 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004562 if (WARN("PREFER_SCANF",
4563 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4564 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004565 $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 -07004566 }
Joe Perches6061d942012-03-23 15:02:16 -07004567 }
4568
Joe Perches8f53a9b2010-03-05 13:43:48 -08004569# check for sizeof(&)
4570 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004571 WARN("SIZEOF_ADDRESS",
4572 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004573 }
4574
Joe Perches66c80b62012-07-30 14:41:22 -07004575# check for sizeof without parenthesis
4576 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004577 if (WARN("SIZEOF_PARENTHESIS",
4578 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4579 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004580 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004581 }
Joe Perches66c80b62012-07-30 14:41:22 -07004582 }
4583
Joe Perches428e2fd2011-05-24 17:13:39 -07004584# check for line continuations in quoted strings with odd counts of "
4585 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004586 WARN("LINE_CONTINUATIONS",
4587 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004588 }
4589
Joe Perches88982fe2012-12-17 16:02:00 -08004590# check for struct spinlock declarations
4591 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4592 WARN("USE_SPINLOCK_T",
4593 "struct spinlock should be spinlock_t\n" . $herecurr);
4594 }
4595
Joe Perchesa6962d72013-04-29 16:18:13 -07004596# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004597 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004598 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004599 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004600 if (WARN("PREFER_SEQ_PUTS",
4601 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4602 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004603 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004604 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004605 }
4606 }
4607
Andy Whitcroft554e1652012-01-10 15:09:57 -08004608# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004609 if ($^V && $^V ge 5.10.0 &&
4610 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004611 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004612
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004613 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004614 my $ms_val = $7;
4615 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004616
Andy Whitcroft554e1652012-01-10 15:09:57 -08004617 if ($ms_size =~ /^(0x|)0$/i) {
4618 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004619 "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 -08004620 } elsif ($ms_size =~ /^(0x|)1$/i) {
4621 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004622 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4623 }
4624 }
4625
Joe Perches98a9bba2014-01-23 15:54:52 -08004626# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4627 if ($^V && $^V ge 5.10.0 &&
4628 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4629 if (WARN("PREFER_ETHER_ADDR_COPY",
4630 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4631 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004632 $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 -08004633 }
4634 }
4635
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004636# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004637 if ($^V && $^V ge 5.10.0 &&
4638 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004639 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004640 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004641 my $call = $1;
4642 my $cast1 = deparenthesize($2);
4643 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004644 my $cast2 = deparenthesize($7);
4645 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004646 my $cast;
4647
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004648 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004649 $cast = "$cast1 or $cast2";
4650 } elsif ($cast1 ne "") {
4651 $cast = $cast1;
4652 } else {
4653 $cast = $cast2;
4654 }
4655 WARN("MINMAX",
4656 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004657 }
4658 }
4659
Joe Perches4a273192012-07-30 14:41:20 -07004660# check usleep_range arguments
4661 if ($^V && $^V ge 5.10.0 &&
4662 defined $stat &&
4663 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4664 my $min = $1;
4665 my $max = $7;
4666 if ($min eq $max) {
4667 WARN("USLEEP_RANGE",
4668 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4669 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4670 $min > $max) {
4671 WARN("USLEEP_RANGE",
4672 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4673 }
4674 }
4675
Joe Perches823b7942013-11-12 15:10:15 -08004676# check for naked sscanf
4677 if ($^V && $^V ge 5.10.0 &&
4678 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004679 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004680 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4681 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4682 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4683 my $lc = $stat =~ tr@\n@@;
4684 $lc = $lc + $linenr;
4685 my $stat_real = raw_line($linenr, 0);
4686 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4687 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4688 }
4689 WARN("NAKED_SSCANF",
4690 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4691 }
4692
Joe Perchesafc819a2014-06-04 16:12:08 -07004693# check for simple sscanf that should be kstrto<foo>
4694 if ($^V && $^V ge 5.10.0 &&
4695 defined $stat &&
4696 $line =~ /\bsscanf\b/) {
4697 my $lc = $stat =~ tr@\n@@;
4698 $lc = $lc + $linenr;
4699 my $stat_real = raw_line($linenr, 0);
4700 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4701 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4702 }
4703 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4704 my $format = $6;
4705 my $count = $format =~ tr@%@%@;
4706 if ($count == 1 &&
4707 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4708 WARN("SSCANF_TO_KSTRTO",
4709 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4710 }
4711 }
4712 }
4713
Joe Perches70dc8a42013-09-11 14:23:58 -07004714# check for new externs in .h files.
4715 if ($realfile =~ /\.h$/ &&
4716 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004717 if (CHK("AVOID_EXTERNS",
4718 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004719 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004720 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07004721 }
4722 }
4723
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004724# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004725 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004726 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004727 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004728 my $function_name = $1;
4729 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004730
4731 my $s = $stat;
4732 if (defined $cond) {
4733 substr($s, 0, length($cond), '');
4734 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004735 if ($s =~ /^\s*;/ &&
4736 $function_name ne 'uninitialized_var')
4737 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004738 WARN("AVOID_EXTERNS",
4739 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004740 }
4741
4742 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004743 WARN("FUNCTION_ARGUMENTS",
4744 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004745 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004746
4747 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4748 $stat =~ /^.\s*extern\s+/)
4749 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004750 WARN("AVOID_EXTERNS",
4751 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004752 }
4753
4754# checks for new __setup's
4755 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4756 my $name = $1;
4757
4758 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004759 CHK("UNDOCUMENTED_SETUP",
4760 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004761 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004762 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004763
4764# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004765 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004766 WARN("UNNECESSARY_CASTS",
4767 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004768 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004769
Joe Perchesa640d252013-07-03 15:05:21 -07004770# alloc style
4771# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4772 if ($^V && $^V ge 5.10.0 &&
4773 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4774 CHK("ALLOC_SIZEOF_STRUCT",
4775 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4776 }
4777
Joe Perches60a55362014-06-04 16:12:07 -07004778# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4779 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07004780 $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 -07004781 my $oldfunc = $3;
4782 my $a1 = $4;
4783 my $a2 = $10;
4784 my $newfunc = "kmalloc_array";
4785 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07004786 my $r1 = $a1;
4787 my $r2 = $a2;
4788 if ($a1 =~ /^sizeof\s*\S/) {
4789 $r1 = $a2;
4790 $r2 = $a1;
4791 }
4792 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4793 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07004794 if (WARN("ALLOC_WITH_MULTIPLY",
4795 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4796 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004797 $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 -07004798
4799 }
4800 }
4801 }
4802
Joe Perches972fdea2013-04-29 16:18:12 -07004803# check for krealloc arg reuse
4804 if ($^V && $^V ge 5.10.0 &&
4805 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4806 WARN("KREALLOC_ARG_REUSE",
4807 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4808 }
4809
Joe Perches5ce59ae2013-02-21 16:44:18 -08004810# check for alloc argument mismatch
4811 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4812 WARN("ALLOC_ARRAY_ARGS",
4813 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4814 }
4815
Joe Perchescaf2a542011-01-12 16:59:56 -08004816# check for multiple semicolons
4817 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004818 if (WARN("ONE_SEMICOLON",
4819 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4820 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004821 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004822 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004823 }
4824
Joe Perchese81f2392014-08-06 16:11:25 -07004825# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08004826 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4827 my $has_break = 0;
4828 my $has_statement = 0;
4829 my $count = 0;
4830 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07004831 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08004832 $prevline--;
4833 my $rline = $rawlines[$prevline - 1];
4834 my $fline = $lines[$prevline - 1];
4835 last if ($fline =~ /^\@\@/);
4836 next if ($fline =~ /^\-/);
4837 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4838 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4839 next if ($fline =~ /^.[\s$;]*$/);
4840 $has_statement = 1;
4841 $count++;
4842 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4843 }
4844 if (!$has_break && $has_statement) {
4845 WARN("MISSING_BREAK",
4846 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4847 }
4848 }
4849
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004850# check for switch/default statements without a break;
4851 if ($^V && $^V ge 5.10.0 &&
4852 defined $stat &&
4853 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4854 my $ctx = '';
4855 my $herectx = $here . "\n";
4856 my $cnt = statement_rawlines($stat);
4857 for (my $n = 0; $n < $cnt; $n++) {
4858 $herectx .= raw_line($linenr, $n) . "\n";
4859 }
4860 WARN("DEFAULT_NO_BREAK",
4861 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004862 }
4863
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004864# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004865 if ($line =~ /\b__FUNCTION__\b/) {
4866 if (WARN("USE_FUNC",
4867 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4868 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004869 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004870 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004871 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004872
Joe Perches2c924882012-03-23 15:02:20 -07004873# check for use of yield()
4874 if ($line =~ /\byield\s*\(\s*\)/) {
4875 WARN("YIELD",
4876 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4877 }
4878
Joe Perches179f8f42013-07-03 15:05:30 -07004879# check for comparisons against true and false
4880 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4881 my $lead = $1;
4882 my $arg = $2;
4883 my $test = $3;
4884 my $otype = $4;
4885 my $trail = $5;
4886 my $op = "!";
4887
4888 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4889
4890 my $type = lc($otype);
4891 if ($type =~ /^(?:true|false)$/) {
4892 if (("$test" eq "==" && "$type" eq "true") ||
4893 ("$test" eq "!=" && "$type" eq "false")) {
4894 $op = "";
4895 }
4896
4897 CHK("BOOL_COMPARISON",
4898 "Using comparison to $otype is error prone\n" . $herecurr);
4899
4900## maybe suggesting a correct construct would better
4901## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4902
4903 }
4904 }
4905
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004906# check for semaphores initialized locked
4907 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004908 WARN("CONSIDER_COMPLETION",
4909 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004910 }
Joe Perches6712d852012-03-23 15:02:20 -07004911
Joe Perches67d0a072011-10-31 17:13:10 -07004912# recommend kstrto* over simple_strto* and strict_strto*
4913 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004914 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004915 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004916 }
Joe Perches6712d852012-03-23 15:02:20 -07004917
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004918# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07004919 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004920 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004921 "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 -07004922 }
Joe Perches6712d852012-03-23 15:02:20 -07004923
Emese Revfy79404842010-03-05 13:43:53 -08004924# check for various ops structs, ensure they are const.
4925 my $struct_ops = qr{acpi_dock_ops|
4926 address_space_operations|
4927 backlight_ops|
4928 block_device_operations|
4929 dentry_operations|
4930 dev_pm_ops|
4931 dma_map_ops|
4932 extent_io_ops|
4933 file_lock_operations|
4934 file_operations|
4935 hv_ops|
4936 ide_dma_ops|
4937 intel_dvo_dev_ops|
4938 item_operations|
4939 iwl_ops|
4940 kgdb_arch|
4941 kgdb_io|
4942 kset_uevent_ops|
4943 lock_manager_operations|
4944 microcode_ops|
4945 mtrr_ops|
4946 neigh_ops|
4947 nlmsvc_binding|
4948 pci_raw_ops|
4949 pipe_buf_operations|
4950 platform_hibernation_ops|
4951 platform_suspend_ops|
4952 proto_ops|
4953 rpc_pipe_ops|
4954 seq_operations|
4955 snd_ac97_build_ops|
4956 soc_pcmcia_socket_ops|
4957 stacktrace_ops|
4958 sysfs_ops|
4959 tty_operations|
4960 usb_mon_operations|
4961 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004962 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004963 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004964 WARN("CONST_STRUCT",
4965 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004966 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004967 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004968
4969# use of NR_CPUS is usually wrong
4970# ignore definitions of NR_CPUS and usage to define arrays as likely right
4971 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004972 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4973 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004974 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4975 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4976 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004977 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004978 WARN("NR_CPUS",
4979 "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 -07004980 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004981
Joe Perches52ea8502013-11-12 15:10:09 -08004982# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4983 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4984 ERROR("DEFINE_ARCH_HAS",
4985 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4986 }
4987
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004988# check for %L{u,d,i} in strings
4989 my $string;
4990 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4991 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004992 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004993 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004994 WARN("PRINTF_L",
4995 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004996 last;
4997 }
4998 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004999
5000# whine mightly about in_atomic
5001 if ($line =~ /\bin_atomic\s*\(/) {
5002 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005003 ERROR("IN_ATOMIC",
5004 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005005 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005006 WARN("IN_ATOMIC",
5007 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005008 }
5009 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005010
5011# check for lockdep_set_novalidate_class
5012 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5013 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5014 if ($realfile !~ m@^kernel/lockdep@ &&
5015 $realfile !~ m@^include/linux/lockdep@ &&
5016 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005017 ERROR("LOCKDEP",
5018 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005019 }
5020 }
Dave Jones88f88312011-01-12 16:59:59 -08005021
5022 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5023 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005024 WARN("EXPORTED_WORLD_WRITABLE",
5025 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005026 }
Joe Perches24358802014-04-03 14:49:13 -07005027
Joe Perches515a2352014-04-03 14:49:24 -07005028# Mode permission misuses where it seems decimal should be octal
5029# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5030 if ($^V && $^V ge 5.10.0 &&
5031 $line =~ /$mode_perms_search/) {
5032 foreach my $entry (@mode_permission_funcs) {
5033 my $func = $entry->[0];
5034 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005035
Joe Perches515a2352014-04-03 14:49:24 -07005036 my $skip_args = "";
5037 if ($arg_pos > 1) {
5038 $arg_pos--;
5039 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5040 }
5041 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5042 if ($line =~ /$test/) {
5043 my $val = $1;
5044 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005045
Joe Perches515a2352014-04-03 14:49:24 -07005046 if ($val !~ /^0$/ &&
5047 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5048 length($val) ne 4)) {
5049 ERROR("NON_OCTAL_PERMISSIONS",
5050 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5051 }
Joe Perches24358802014-04-03 14:49:13 -07005052 }
5053 }
5054 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005055 }
5056
5057 # If we have no input at all, then there is nothing to report on
5058 # so just keep quiet.
5059 if ($#rawlines == -1) {
5060 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005061 }
5062
Andy Whitcroft8905a672007-11-28 16:21:06 -08005063 # In mailback mode only produce a report in the negative, for
5064 # things that appear to be patches.
5065 if ($mailback && ($clean == 1 || !$is_patch)) {
5066 exit(0);
5067 }
5068
5069 # This is not a patch, and we are are in 'no-patch' mode so
5070 # just keep quiet.
5071 if (!$chk_patch && !$is_patch) {
5072 exit(0);
5073 }
5074
5075 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005076 ERROR("NOT_UNIFIED_DIFF",
5077 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005078 }
5079 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005080 ERROR("MISSING_SIGN_OFF",
5081 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005082 }
5083
Andy Whitcroft8905a672007-11-28 16:21:06 -08005084 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005085 if ($summary && !($clean == 1 && $quiet == 1)) {
5086 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005087 print "total: $cnt_error errors, $cnt_warn warnings, " .
5088 (($check)? "$cnt_chk checks, " : "") .
5089 "$cnt_lines lines checked\n";
5090 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005091 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005092
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005093 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005094
5095 if ($^V lt 5.10.0) {
5096 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5097 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5098 }
5099
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005100 # If there were whitespace errors which cleanpatch can fix
5101 # then suggest that.
5102 if ($rpt_cleaners) {
5103 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5104 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005105 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005106 }
5107 }
5108
Joe Perches91bfe482013-09-11 14:23:59 -07005109 hash_show_words(\%use_type, "Used");
5110 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005111
Joe Perchesd752fcc2014-08-06 16:11:05 -07005112 if ($clean == 0 && $fix &&
5113 ("@rawlines" ne "@fixed" ||
5114 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005115 my $newfile = $filename;
5116 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005117 my $linecount = 0;
5118 my $f;
5119
Joe Perchesd752fcc2014-08-06 16:11:05 -07005120 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5121
Joe Perches3705ce52013-07-03 15:05:31 -07005122 open($f, '>', $newfile)
5123 or die "$P: Can't open $newfile for write\n";
5124 foreach my $fixed_line (@fixed) {
5125 $linecount++;
5126 if ($file) {
5127 if ($linecount > 3) {
5128 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005129 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005130 }
5131 } else {
5132 print $f $fixed_line . "\n";
5133 }
5134 }
5135 close($f);
5136
5137 if (!$quiet) {
5138 print << "EOM";
5139Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5140
5141Do _NOT_ trust the results written to this file.
5142Do _NOT_ submit these changes without inspecting them for correctness.
5143
5144This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5145No warranties, expressed or implied...
5146
5147EOM
5148 }
5149 }
5150
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005151 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005152 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005153 }
5154 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005155 print << "EOM";
5156$vname has style problems, please review.
5157
5158If any of these errors are false positives, please report
5159them to the maintainer, see CHECKPATCH in MAINTAINERS.
5160EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005161 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005162
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005163 return $clean;
5164}