blob: f3d9a883f8be08ed9457eeb4944848a25418e9e0 [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 Perches2ac73b42014-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 Perches2ac73b42014-06-04 16:12:05 -0700150$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800151
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700152my $exit = 0;
153
Dave Hansend62a2012013-09-11 14:23:56 -0700154if ($^V && $^V lt $minimum_perl_version) {
155 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
156 if (!$ignore_perl_version) {
157 exit(1);
158 }
159}
160
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700161if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700162 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700163 exit(1);
164}
165
Joe Perches91bfe482013-09-11 14:23:59 -0700166sub hash_save_array_words {
167 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700168
Joe Perches91bfe482013-09-11 14:23:59 -0700169 my @array = split(/,/, join(',', @$arrayRef));
170 foreach my $word (@array) {
171 $word =~ s/\s*\n?$//g;
172 $word =~ s/^\s*//g;
173 $word =~ s/\s+/ /g;
174 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700175
Joe Perches91bfe482013-09-11 14:23:59 -0700176 next if ($word =~ m/^\s*#/);
177 next if ($word =~ m/^\s*$/);
178
179 $hashRef->{$word}++;
180 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700181}
182
Joe Perches91bfe482013-09-11 14:23:59 -0700183sub hash_show_words {
184 my ($hashRef, $prefix) = @_;
185
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700188 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700189 print " $word";
190 }
191 print "\n\n";
192 }
193}
194
195hash_save_array_words(\%ignore_type, \@ignore);
196hash_save_array_words(\%use_type, \@use);
197
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800198my $dbg_values = 0;
199my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700200my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700201my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800202for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800203 ## no critic
204 eval "\${dbg_$key} = '$debug{$key}';";
205 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800206}
207
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700208my $rpt_cleaners = 0;
209
Andy Whitcroft8905a672007-11-28 16:21:06 -0800210if ($terse) {
211 $emacs = 1;
212 $quiet++;
213}
214
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700215if ($tree) {
216 if (defined $root) {
217 if (!top_of_kernel_tree($root)) {
218 die "$P: $root: --root does not point at a valid tree\n";
219 }
220 } else {
221 if (top_of_kernel_tree('.')) {
222 $root = '.';
223 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
224 top_of_kernel_tree($1)) {
225 $root = $1;
226 }
227 }
228
229 if (!defined $root) {
230 print "Must be run from the top-level dir. of a kernel tree\n";
231 exit(2);
232 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700233}
234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235my $emitted_corrupt = 0;
236
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700237our $Ident = qr{
238 [A-Za-z_][A-Za-z\d_]*
239 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
240 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700241our $Storage = qr{extern|static|asmlinkage};
242our $Sparse = qr{
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800249 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700250 __ref|
251 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700252 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800253our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
254our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
255our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
256our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
257our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700258
Wolfram Sang52131292010-03-05 13:43:51 -0800259# Notes to $Attribute:
260# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261our $Attribute = qr{
262 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700277 __read_mostly|
278 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700279 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800282 ____cacheline_internodealigned_in_smp|
283 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700285our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700286our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700287our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
288our $Lval = qr{$Ident(?:$Member)*};
289
Joe Perches95e2c602013-07-03 15:05:20 -0700290our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
291our $Binary = qr{(?i)0b[01]+$Int_type?};
292our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
293our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700294our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800295our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
296our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
297our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800298our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700299our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800300our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700301our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700302our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303our $Operators = qr{
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700306 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700307 }x;
308
Joe Perches91cb5192014-04-03 14:49:32 -0700309our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
310
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700312our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800313our $Type;
314our $Declare;
315
Joe Perches15662b32011-10-31 17:13:12 -0700316our $NON_ASCII_UTF8 = qr{
317 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700318 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
319 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
320 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
321 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
322 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
323 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
324}x;
325
Joe Perches15662b32011-10-31 17:13:12 -0700326our $UTF8 = qr{
327 [\x09\x0A\x0D\x20-\x7E] # ASCII
328 | $NON_ASCII_UTF8
329}x;
330
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700331our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700332 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700333 atomic_t
334)};
335
Joe Perches691e6692010-03-05 13:43:51 -0800336our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700337 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700338 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700339 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700340 panic|
Joe Perches06668722013-11-12 15:10:07 -0800341 MODULE_[A-Z_]+|
342 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800343)};
344
Joe Perches20112472011-07-25 17:13:23 -0700345our $signature_tags = qr{(?xi:
346 Signed-off-by:|
347 Acked-by:|
348 Tested-by:|
349 Reviewed-by:|
350 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700351 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700352 To:|
353 Cc:
354)};
355
Andy Whitcroft8905a672007-11-28 16:21:06 -0800356our @typeList = (
357 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700358 qr{(?:unsigned\s+)?char},
359 qr{(?:unsigned\s+)?short},
360 qr{(?:unsigned\s+)?int},
361 qr{(?:unsigned\s+)?long},
362 qr{(?:unsigned\s+)?long\s+int},
363 qr{(?:unsigned\s+)?long\s+long},
364 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800365 qr{unsigned},
366 qr{float},
367 qr{double},
368 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800369 qr{struct\s+$Ident},
370 qr{union\s+$Ident},
371 qr{enum\s+$Ident},
372 qr{${Ident}_t},
373 qr{${Ident}_handler},
374 qr{${Ident}_handler_fn},
375);
Joe Perches8716de32013-09-11 14:24:05 -0700376our @typeListWithAttr = (
377 @typeList,
378 qr{struct\s+$InitAttribute\s+$Ident},
379 qr{union\s+$InitAttribute\s+$Ident},
380);
381
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700382our @modifierList = (
383 qr{fastcall},
384);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385
Joe Perches24358802014-04-03 14:49:13 -0700386our @mode_permission_funcs = (
387 ["module_param", 3],
388 ["module_param_(?:array|named|string)", 4],
389 ["module_param_array_named", 5],
390 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
391 ["proc_create(?:_data|)", 2],
392 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
393);
394
Joe Perches515a2352014-04-03 14:49:24 -0700395#Create a search pattern for all these functions to speed up a loop below
396our $mode_perms_search = "";
397foreach my $entry (@mode_permission_funcs) {
398 $mode_perms_search .= '|' if ($mode_perms_search ne "");
399 $mode_perms_search .= $entry->[0];
400}
401
Joe Perches3f7bac02014-06-04 16:12:04 -0700402our $declaration_macros = qr{(?x:
403 (?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(|
404 (?:$Storage\s+)?LIST_HEAD\s*\(
405)};
406
Wolfram Sang7840a942010-08-09 17:20:57 -0700407our $allowed_asm_includes = qr{(?x:
408 irq|
409 memory
410)};
411# memory.h: ARM has a custom one
412
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700414 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
415 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700416 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700417 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800418 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700419 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800420 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800421 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700423 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800424 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700425 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700427 $NonptrTypeWithAttr = qr{
428 (?:$Modifier\s+|const\s+)*
429 (?:
430 (?:typeof|__typeof__)\s*\([^\)]*\)|
431 (?:$typeTypedefs\b)|
432 (?:${allWithAttr}\b)
433 )
434 (?:\s+$Modifier|\s+const)*
435 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800436 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700437 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700438 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700439 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700441 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800442}
443build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700444
Joe Perches7d2367a2011-07-25 17:13:22 -0700445our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700446
447# Using $balanced_parens, $LvalOrFunc, or $FuncArg
448# requires at least perl version v5.10.0
449# Any use must be runtime checked with $^V
450
451our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700452our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800453our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700454
455sub deparenthesize {
456 my ($string) = @_;
457 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700458
459 while ($string =~ /^\s*\(.*\)\s*$/) {
460 $string =~ s@^\s*\(\s*@@;
461 $string =~ s@\s*\)\s*$@@;
462 }
463
Joe Perches7d2367a2011-07-25 17:13:22 -0700464 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700465
Joe Perches7d2367a2011-07-25 17:13:22 -0700466 return $string;
467}
468
Joe Perches34456862013-07-03 15:05:34 -0700469sub seed_camelcase_file {
470 my ($file) = @_;
471
472 return if (!(-f $file));
473
474 local $/;
475
476 open(my $include_file, '<', "$file")
477 or warn "$P: Can't read '$file' $!\n";
478 my $text = <$include_file>;
479 close($include_file);
480
481 my @lines = split('\n', $text);
482
483 foreach my $line (@lines) {
484 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
485 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
486 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800487 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
488 $camelcase{$1} = 1;
489 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700490 $camelcase{$1} = 1;
491 }
492 }
493}
494
495my $camelcase_seeded = 0;
496sub seed_camelcase_includes {
497 return if ($camelcase_seeded);
498
499 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700500 my $camelcase_cache = "";
501 my @include_files = ();
502
503 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700504
Richard Genoud3645e322014-02-10 14:25:32 -0800505 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700506 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
507 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700508 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700509 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700510 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700511 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700512 @include_files = split('\n', $files);
513 foreach my $file (@include_files) {
514 my $date = POSIX::strftime("%Y%m%d%H%M",
515 localtime((stat $file)[9]));
516 $last_mod_date = $date if ($last_mod_date < $date);
517 }
518 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700519 }
Joe Perchesc707a812013-07-08 16:00:43 -0700520
521 if ($camelcase_cache ne "" && -f $camelcase_cache) {
522 open(my $camelcase_file, '<', "$camelcase_cache")
523 or warn "$P: Can't read '$camelcase_cache' $!\n";
524 while (<$camelcase_file>) {
525 chomp;
526 $camelcase{$_} = 1;
527 }
528 close($camelcase_file);
529
530 return;
531 }
532
Richard Genoud3645e322014-02-10 14:25:32 -0800533 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700534 $files = `git ls-files "include/*.h"`;
535 @include_files = split('\n', $files);
536 }
537
Joe Perches34456862013-07-03 15:05:34 -0700538 foreach my $file (@include_files) {
539 seed_camelcase_file($file);
540 }
Joe Perches351b2a12013-07-03 15:05:36 -0700541
Joe Perchesc707a812013-07-08 16:00:43 -0700542 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700543 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700544 open(my $camelcase_file, '>', "$camelcase_cache")
545 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700546 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
547 print $camelcase_file ("$_\n");
548 }
549 close($camelcase_file);
550 }
Joe Perches34456862013-07-03 15:05:34 -0700551}
552
Joe Perchesd311cd42014-08-06 16:10:57 -0700553sub git_commit_info {
554 my ($commit, $id, $desc) = @_;
555
556 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
557
558 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
559 $output =~ s/^\s*//gm;
560 my @lines = split("\n", $output);
561
562 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
563# Maybe one day convert this block of bash into something that returns
564# all matching commit ids, but it's very slow...
565#
566# echo "checking commits $1..."
567# git rev-list --remotes | grep -i "^$1" |
568# while read line ; do
569# git log --format='%H %s' -1 $line |
570# echo "commit $(cut -c 1-12,41-)"
571# done
572 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
573 } else {
574 $id = substr($lines[0], 0, 12);
575 $desc = substr($lines[0], 41);
576 }
577
578 return ($id, $desc);
579}
580
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700581$chk_signoff = 0 if ($file);
582
Andy Whitcroft00df3442007-06-08 13:47:06 -0700583my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800584my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700585my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700586my @fixed_inserted = ();
587my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700588my $fixlinenr = -1;
589
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800590my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700591for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800592 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700593 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800594 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700595 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800596 } elsif ($filename eq '-') {
597 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700598 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800599 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700600 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700601 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800602 if ($filename eq '-') {
603 $vname = 'Your patch';
604 } else {
605 $vname = $filename;
606 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800607 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700608 chomp;
609 push(@rawlines, $_);
610 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800611 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800612 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700613 $exit = 1;
614 }
615 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800616 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700617 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700618 @fixed_inserted = ();
619 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700620 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700621}
622
623exit($exit);
624
625sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700626 my ($root) = @_;
627
628 my @tree_check = (
629 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
630 "README", "Documentation", "arch", "include", "drivers",
631 "fs", "init", "ipc", "kernel", "lib", "scripts",
632 );
633
634 foreach my $check (@tree_check) {
635 if (! -e $root . '/' . $check) {
636 return 0;
637 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700638 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700639 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700640}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700641
Joe Perches20112472011-07-25 17:13:23 -0700642sub parse_email {
643 my ($formatted_email) = @_;
644
645 my $name = "";
646 my $address = "";
647 my $comment = "";
648
649 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
650 $name = $1;
651 $address = $2;
652 $comment = $3 if defined $3;
653 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
654 $address = $1;
655 $comment = $2 if defined $2;
656 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
657 $address = $1;
658 $comment = $2 if defined $2;
659 $formatted_email =~ s/$address.*$//;
660 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700661 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700662 $name =~ s/^\"|\"$//g;
663 # If there's a name left after stripping spaces and
664 # leading quotes, and the address doesn't have both
665 # leading and trailing angle brackets, the address
666 # is invalid. ie:
667 # "joe smith joe@smith.com" bad
668 # "joe smith <joe@smith.com" bad
669 if ($name ne "" && $address !~ /^<[^>]+>$/) {
670 $name = "";
671 $address = "";
672 $comment = "";
673 }
674 }
675
Joe Perches3705ce52013-07-03 15:05:31 -0700676 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700677 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700678 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700679 $address =~ s/^\<|\>$//g;
680
681 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
682 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
683 $name = "\"$name\"";
684 }
685
686 return ($name, $address, $comment);
687}
688
689sub format_email {
690 my ($name, $address) = @_;
691
692 my $formatted_email;
693
Joe Perches3705ce52013-07-03 15:05:31 -0700694 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700695 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700696 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700697
698 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
699 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
700 $name = "\"$name\"";
701 }
702
703 if ("$name" eq "") {
704 $formatted_email = "$address";
705 } else {
706 $formatted_email = "$name <$address>";
707 }
708
709 return $formatted_email;
710}
711
Joe Perchesd311cd42014-08-06 16:10:57 -0700712sub which {
713 my ($bin) = @_;
714
715 foreach my $path (split(/:/, $ENV{PATH})) {
716 if (-e "$path/$bin") {
717 return "$path/$bin";
718 }
719 }
720
721 return "";
722}
723
Joe Perches000d1cc12011-07-25 17:13:25 -0700724sub which_conf {
725 my ($conf) = @_;
726
727 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
728 if (-e "$path/$conf") {
729 return "$path/$conf";
730 }
731 }
732
733 return "";
734}
735
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700736sub expand_tabs {
737 my ($str) = @_;
738
739 my $res = '';
740 my $n = 0;
741 for my $c (split(//, $str)) {
742 if ($c eq "\t") {
743 $res .= ' ';
744 $n++;
745 for (; ($n % 8) != 0; $n++) {
746 $res .= ' ';
747 }
748 next;
749 }
750 $res .= $c;
751 $n++;
752 }
753
754 return $res;
755}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700756sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700757 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700758 return $res;
759}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700760
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700761sub line_stats {
762 my ($line) = @_;
763
764 # Drop the diff line leader and expand tabs
765 $line =~ s/^.//;
766 $line = expand_tabs($line);
767
768 # Pick the indent from the front of the line.
769 my ($white) = ($line =~ /^(\s*)/);
770
771 return (length($line), length($white));
772}
773
Andy Whitcroft773647a2008-03-28 14:15:58 -0700774my $sanitise_quote = '';
775
776sub sanitise_line_reset {
777 my ($in_comment) = @_;
778
779 if ($in_comment) {
780 $sanitise_quote = '*/';
781 } else {
782 $sanitise_quote = '';
783 }
784}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700785sub sanitise_line {
786 my ($line) = @_;
787
788 my $res = '';
789 my $l = '';
790
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800791 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700792 my $off = 0;
793 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700794
Andy Whitcroft773647a2008-03-28 14:15:58 -0700795 # Always copy over the diff marker.
796 $res = substr($line, 0, 1);
797
798 for ($off = 1; $off < length($line); $off++) {
799 $c = substr($line, $off, 1);
800
801 # Comments we are wacking completly including the begin
802 # and end, all to $;.
803 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
804 $sanitise_quote = '*/';
805
806 substr($res, $off, 2, "$;$;");
807 $off++;
808 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800809 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700810 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700811 $sanitise_quote = '';
812 substr($res, $off, 2, "$;$;");
813 $off++;
814 next;
815 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700816 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
817 $sanitise_quote = '//';
818
819 substr($res, $off, 2, $sanitise_quote);
820 $off++;
821 next;
822 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700823
824 # A \ in a string means ignore the next character.
825 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
826 $c eq "\\") {
827 substr($res, $off, 2, 'XX');
828 $off++;
829 next;
830 }
831 # Regular quotes.
832 if ($c eq "'" || $c eq '"') {
833 if ($sanitise_quote eq '') {
834 $sanitise_quote = $c;
835
836 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700837 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700838 } elsif ($sanitise_quote eq $c) {
839 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700840 }
841 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700842
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800843 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700844 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
845 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700846 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
847 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700848 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
849 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700850 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700851 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700852 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800853 }
854
Daniel Walker113f04a2009-09-21 17:04:35 -0700855 if ($sanitise_quote eq '//') {
856 $sanitise_quote = '';
857 }
858
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700860 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800861 my $clean = 'X' x length($1);
862 $res =~ s@\<.*\>@<$clean>@;
863
864 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700865 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800866 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700867 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800868 }
869
Andy Whitcroft00df3442007-06-08 13:47:06 -0700870 return $res;
871}
872
Joe Perchesa6962d72013-04-29 16:18:13 -0700873sub get_quoted_string {
874 my ($line, $rawline) = @_;
875
876 return "" if ($line !~ m/(\"[X]+\")/g);
877 return substr($rawline, $-[0], $+[0] - $-[0]);
878}
879
Andy Whitcroft8905a672007-11-28 16:21:06 -0800880sub ctx_statement_block {
881 my ($linenr, $remain, $off) = @_;
882 my $line = $linenr - 1;
883 my $blk = '';
884 my $soff = $off;
885 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700886 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800887
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800888 my $loff = 0;
889
Andy Whitcroft8905a672007-11-28 16:21:06 -0800890 my $type = '';
891 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800892 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800893 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800894 my $c;
895 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800896
897 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800898 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800899 @stack = (['', 0]) if ($#stack == -1);
900
Andy Whitcroft773647a2008-03-28 14:15:58 -0700901 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800902 # If we are about to drop off the end, pull in more
903 # context.
904 if ($off >= $len) {
905 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700906 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800908 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800909 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800910 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800911 $len = length($blk);
912 $line++;
913 last;
914 }
915 # Bail if there is no further context.
916 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800917 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800918 last;
919 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800920 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
921 $level++;
922 $type = '#';
923 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800924 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800925 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800926 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800927 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800928
Andy Whitcroft773647a2008-03-28 14:15:58 -0700929 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800930
931 # Handle nested #if/#else.
932 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
933 push(@stack, [ $type, $level ]);
934 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
935 ($type, $level) = @{$stack[$#stack - 1]};
936 } elsif ($remainder =~ /^#\s*endif\b/) {
937 ($type, $level) = @{pop(@stack)};
938 }
939
Andy Whitcroft8905a672007-11-28 16:21:06 -0800940 # Statement ends at the ';' or a close '}' at the
941 # outermost level.
942 if ($level == 0 && $c eq ';') {
943 last;
944 }
945
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800946 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700947 if ($level == 0 && $coff_set == 0 &&
948 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
949 $remainder =~ /^(else)(?:\s|{)/ &&
950 $remainder !~ /^else\s+if\b/) {
951 $coff = $off + length($1) - 1;
952 $coff_set = 1;
953 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
954 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800955 }
956
Andy Whitcroft8905a672007-11-28 16:21:06 -0800957 if (($type eq '' || $type eq '(') && $c eq '(') {
958 $level++;
959 $type = '(';
960 }
961 if ($type eq '(' && $c eq ')') {
962 $level--;
963 $type = ($level != 0)? '(' : '';
964
965 if ($level == 0 && $coff < $soff) {
966 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700967 $coff_set = 1;
968 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800969 }
970 }
971 if (($type eq '' || $type eq '{') && $c eq '{') {
972 $level++;
973 $type = '{';
974 }
975 if ($type eq '{' && $c eq '}') {
976 $level--;
977 $type = ($level != 0)? '{' : '';
978
979 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700980 if (substr($blk, $off + 1, 1) eq ';') {
981 $off++;
982 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800983 last;
984 }
985 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800986 # Preprocessor commands end at the newline unless escaped.
987 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
988 $level--;
989 $type = '';
990 $off++;
991 last;
992 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800993 $off++;
994 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700995 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800996 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700997 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800998 $line++;
999 $remain--;
1000 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001001
1002 my $statement = substr($blk, $soff, $off - $soff + 1);
1003 my $condition = substr($blk, $soff, $coff - $soff + 1);
1004
1005 #warn "STATEMENT<$statement>\n";
1006 #warn "CONDITION<$condition>\n";
1007
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001009
1010 return ($statement, $condition,
1011 $line, $remain + 1, $off - $loff + 1, $level);
1012}
1013
Andy Whitcroftcf655042008-03-04 14:28:20 -08001014sub statement_lines {
1015 my ($stmt) = @_;
1016
1017 # Strip the diff line prefixes and rip blank lines at start and end.
1018 $stmt =~ s/(^|\n)./$1/g;
1019 $stmt =~ s/^\s*//;
1020 $stmt =~ s/\s*$//;
1021
1022 my @stmt_lines = ($stmt =~ /\n/g);
1023
1024 return $#stmt_lines + 2;
1025}
1026
1027sub statement_rawlines {
1028 my ($stmt) = @_;
1029
1030 my @stmt_lines = ($stmt =~ /\n/g);
1031
1032 return $#stmt_lines + 2;
1033}
1034
1035sub statement_block_size {
1036 my ($stmt) = @_;
1037
1038 $stmt =~ s/(^|\n)./$1/g;
1039 $stmt =~ s/^\s*{//;
1040 $stmt =~ s/}\s*$//;
1041 $stmt =~ s/^\s*//;
1042 $stmt =~ s/\s*$//;
1043
1044 my @stmt_lines = ($stmt =~ /\n/g);
1045 my @stmt_statements = ($stmt =~ /;/g);
1046
1047 my $stmt_lines = $#stmt_lines + 2;
1048 my $stmt_statements = $#stmt_statements + 1;
1049
1050 if ($stmt_lines > $stmt_statements) {
1051 return $stmt_lines;
1052 } else {
1053 return $stmt_statements;
1054 }
1055}
1056
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001057sub ctx_statement_full {
1058 my ($linenr, $remain, $off) = @_;
1059 my ($statement, $condition, $level);
1060
1061 my (@chunks);
1062
Andy Whitcroftcf655042008-03-04 14:28:20 -08001063 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001064 ($statement, $condition, $linenr, $remain, $off, $level) =
1065 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001066 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001067 push(@chunks, [ $condition, $statement ]);
1068 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1069 return ($level, $linenr, @chunks);
1070 }
1071
1072 # Pull in the following conditional/block pairs and see if they
1073 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001074 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001075 ($statement, $condition, $linenr, $remain, $off, $level) =
1076 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001077 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001078 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001079 #print "C: push\n";
1080 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001081 }
1082
1083 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001084}
1085
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001086sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001087 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001088 my $line;
1089 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001090 my $blk = '';
1091 my @o;
1092 my @c;
1093 my @res = ();
1094
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001095 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001096 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001097 for ($line = $start; $remain > 0; $line++) {
1098 next if ($rawlines[$line] =~ /^-/);
1099 $remain--;
1100
1101 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001102
1103 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001104 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001105 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001106 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001107 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001108 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001109 $level = pop(@stack);
1110 }
1111
Andy Whitcroft01464f32010-10-26 14:23:19 -07001112 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001113 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1114 if ($off > 0) {
1115 $off--;
1116 next;
1117 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001118
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001119 if ($c eq $close && $level > 0) {
1120 $level--;
1121 last if ($level == 0);
1122 } elsif ($c eq $open) {
1123 $level++;
1124 }
1125 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001126
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001127 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001128 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001129 }
1130
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001131 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001132 }
1133
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001134 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001135}
1136sub ctx_block_outer {
1137 my ($linenr, $remain) = @_;
1138
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001139 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1140 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001141}
1142sub ctx_block {
1143 my ($linenr, $remain) = @_;
1144
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001145 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1146 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001147}
1148sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001149 my ($linenr, $remain, $off) = @_;
1150
1151 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1152 return @r;
1153}
1154sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001155 my ($linenr, $remain) = @_;
1156
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001157 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001158}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001159sub ctx_statement_level {
1160 my ($linenr, $remain, $off) = @_;
1161
1162 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1163}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001164
1165sub ctx_locate_comment {
1166 my ($first_line, $end_line) = @_;
1167
1168 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001169 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001170 return $current_comment if (defined $current_comment);
1171
1172 # Look through the context and try and figure out if there is a
1173 # comment.
1174 my $in_comment = 0;
1175 $current_comment = '';
1176 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001177 my $line = $rawlines[$linenr - 1];
1178 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001179 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1180 $in_comment = 1;
1181 }
1182 if ($line =~ m@/\*@) {
1183 $in_comment = 1;
1184 }
1185 if (!$in_comment && $current_comment ne '') {
1186 $current_comment = '';
1187 }
1188 $current_comment .= $line . "\n" if ($in_comment);
1189 if ($line =~ m@\*/@) {
1190 $in_comment = 0;
1191 }
1192 }
1193
1194 chomp($current_comment);
1195 return($current_comment);
1196}
1197sub ctx_has_comment {
1198 my ($first_line, $end_line) = @_;
1199 my $cmt = ctx_locate_comment($first_line, $end_line);
1200
Andy Whitcroft00df3442007-06-08 13:47:06 -07001201 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001202 ##print "CMMT: $cmt\n";
1203
1204 return ($cmt ne '');
1205}
1206
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001207sub raw_line {
1208 my ($linenr, $cnt) = @_;
1209
1210 my $offset = $linenr - 1;
1211 $cnt++;
1212
1213 my $line;
1214 while ($cnt) {
1215 $line = $rawlines[$offset++];
1216 next if (defined($line) && $line =~ /^-/);
1217 $cnt--;
1218 }
1219
1220 return $line;
1221}
1222
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001223sub cat_vet {
1224 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001225 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001226
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001227 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001228 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1229 $res .= $1;
1230 if ($2 ne '') {
1231 $coded = sprintf("^%c", unpack('C', $2) + 64);
1232 $res .= $coded;
1233 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001234 }
1235 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001236
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001237 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001238}
1239
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001240my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001241my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001242my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001243my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001244
1245sub annotate_reset {
1246 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001247 $av_pending = '_';
1248 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001249 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001250}
1251
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001252sub annotate_values {
1253 my ($stream, $type) = @_;
1254
1255 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001256 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001257 my $cur = $stream;
1258
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001259 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001260
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001261 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001262 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001263 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001264 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001265 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001266 print "WS($1)\n" if ($dbg_values > 1);
1267 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001268 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001269 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001270 }
1271
Florian Micklerc023e4732011-01-12 16:59:58 -08001272 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001273 print "CAST($1)\n" if ($dbg_values > 1);
1274 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001275 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001276
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001277 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001278 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001279 $type = 'T';
1280
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001281 } elsif ($cur =~ /^($Modifier)\s*/) {
1282 print "MODIFIER($1)\n" if ($dbg_values > 1);
1283 $type = 'T';
1284
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001285 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001286 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001287 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001288 push(@av_paren_type, $type);
1289 if ($2 ne '') {
1290 $av_pending = 'N';
1291 }
1292 $type = 'E';
1293
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001294 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001295 print "UNDEF($1)\n" if ($dbg_values > 1);
1296 $av_preprocessor = 1;
1297 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001298
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001299 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001300 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001301 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001302
1303 push(@av_paren_type, $type);
1304 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001305 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001306
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001307 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001308 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1309 $av_preprocessor = 1;
1310
1311 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1312
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001313 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001314
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001315 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001316 print "PRE_END($1)\n" if ($dbg_values > 1);
1317
1318 $av_preprocessor = 1;
1319
1320 # Assume all arms of the conditional end as this
1321 # one does, and continue as if the #endif was not here.
1322 pop(@av_paren_type);
1323 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001324 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001325
1326 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001327 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001328
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001329 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1330 print "ATTR($1)\n" if ($dbg_values > 1);
1331 $av_pending = $type;
1332 $type = 'N';
1333
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001334 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001335 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001336 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001337 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001338 }
1339 $type = 'N';
1340
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001341 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001342 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001343 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001344 $type = 'N';
1345
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001346 } elsif ($cur =~/^(case)/o) {
1347 print "CASE($1)\n" if ($dbg_values > 1);
1348 $av_pend_colon = 'C';
1349 $type = 'N';
1350
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001351 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001352 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001353 $type = 'N';
1354
1355 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001356 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001357 push(@av_paren_type, $av_pending);
1358 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001359 $type = 'N';
1360
1361 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001362 my $new_type = pop(@av_paren_type);
1363 if ($new_type ne '_') {
1364 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001365 print "PAREN('$1') -> $type\n"
1366 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001367 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001368 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001369 }
1370
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001371 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001372 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001373 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001374 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001375
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001376 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1377 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001378 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001379 } elsif ($type eq 'E') {
1380 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001381 }
1382 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1383 $type = 'V';
1384
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001385 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001386 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001387 $type = 'V';
1388
1389 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001390 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001391 $type = 'N';
1392
Andy Whitcroftcf655042008-03-04 14:28:20 -08001393 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001394 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001395 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001396 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001397
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001398 } elsif ($cur =~/^(,)/) {
1399 print "COMMA($1)\n" if ($dbg_values > 1);
1400 $type = 'C';
1401
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001402 } elsif ($cur =~ /^(\?)/o) {
1403 print "QUESTION($1)\n" if ($dbg_values > 1);
1404 $type = 'N';
1405
1406 } elsif ($cur =~ /^(:)/o) {
1407 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1408
1409 substr($var, length($res), 1, $av_pend_colon);
1410 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1411 $type = 'E';
1412 } else {
1413 $type = 'N';
1414 }
1415 $av_pend_colon = 'O';
1416
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001417 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001418 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001419 $type = 'N';
1420
Andy Whitcroft0d413862008-10-15 22:02:16 -07001421 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001422 my $variant;
1423
1424 print "OPV($1)\n" if ($dbg_values > 1);
1425 if ($type eq 'V') {
1426 $variant = 'B';
1427 } else {
1428 $variant = 'U';
1429 }
1430
1431 substr($var, length($res), 1, $variant);
1432 $type = 'N';
1433
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001434 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001435 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001436 if ($1 ne '++' && $1 ne '--') {
1437 $type = 'N';
1438 }
1439
1440 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001441 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001442 }
1443 if (defined $1) {
1444 $cur = substr($cur, length($1));
1445 $res .= $type x length($1);
1446 }
1447 }
1448
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001449 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001450}
1451
Andy Whitcroft8905a672007-11-28 16:21:06 -08001452sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001453 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001454 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001455 ^(?:
1456 $Modifier|
1457 $Storage|
1458 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001459 DEFINE_\S+
1460 )$|
1461 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001462 goto|
1463 return|
1464 case|
1465 else|
1466 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001467 do|
1468 \#|
1469 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001470 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001471 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001472 )}x;
1473 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1474 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001475 # Check for modifiers.
1476 $possible =~ s/\s*$Storage\s*//g;
1477 $possible =~ s/\s*$Sparse\s*//g;
1478 if ($possible =~ /^\s*$/) {
1479
1480 } elsif ($possible =~ /\s/) {
1481 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001482 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001483 if ($modifier !~ $notPermitted) {
1484 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1485 push(@modifierList, $modifier);
1486 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001487 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001488
1489 } else {
1490 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1491 push(@typeList, $possible);
1492 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001493 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001494 } else {
1495 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001496 }
1497}
1498
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001499my $prefix = '';
1500
Joe Perches000d1cc12011-07-25 17:13:25 -07001501sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001502 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001503
Joe Perchescbec18a2014-04-03 14:49:19 -07001504 return defined $use_type{$type} if (scalar keys %use_type > 0);
1505
1506 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001507}
1508
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001509sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001510 my ($level, $type, $msg) = @_;
1511
1512 if (!show_type($type) ||
1513 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001514 return 0;
1515 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001516 my $line;
1517 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001518 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001519 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001520 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001521 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001522 $line = (split('\n', $line))[0] . "\n" if ($terse);
1523
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001524 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001525
1526 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001527}
Joe Perchescbec18a2014-04-03 14:49:19 -07001528
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001529sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001530 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001531}
Joe Perches000d1cc12011-07-25 17:13:25 -07001532
Joe Perchesd752fcc2014-08-06 16:11:05 -07001533sub fixup_current_range {
1534 my ($lineRef, $offset, $length) = @_;
1535
1536 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1537 my $o = $1;
1538 my $l = $2;
1539 my $no = $o + $offset;
1540 my $nl = $l + $length;
1541 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1542 }
1543}
1544
1545sub fix_inserted_deleted_lines {
1546 my ($linesRef, $insertedRef, $deletedRef) = @_;
1547
1548 my $range_last_linenr = 0;
1549 my $delta_offset = 0;
1550
1551 my $old_linenr = 0;
1552 my $new_linenr = 0;
1553
1554 my $next_insert = 0;
1555 my $next_delete = 0;
1556
1557 my @lines = ();
1558
1559 my $inserted = @{$insertedRef}[$next_insert++];
1560 my $deleted = @{$deletedRef}[$next_delete++];
1561
1562 foreach my $old_line (@{$linesRef}) {
1563 my $save_line = 1;
1564 my $line = $old_line; #don't modify the array
1565 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1566 $delta_offset = 0;
1567 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1568 $range_last_linenr = $new_linenr;
1569 fixup_current_range(\$line, $delta_offset, 0);
1570 }
1571
1572 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1573 $deleted = @{$deletedRef}[$next_delete++];
1574 $save_line = 0;
1575 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1576 }
1577
1578 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1579 push(@lines, ${$inserted}{'LINE'});
1580 $inserted = @{$insertedRef}[$next_insert++];
1581 $new_linenr++;
1582 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1583 }
1584
1585 if ($save_line) {
1586 push(@lines, $line);
1587 $new_linenr++;
1588 }
1589
1590 $old_linenr++;
1591 }
1592
1593 return @lines;
1594}
1595
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001596sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001597 my ($type, $msg) = @_;
1598
1599 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001600 our $clean = 0;
1601 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001602 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001603 }
Joe Perches3705ce52013-07-03 15:05:31 -07001604 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001605}
1606sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001607 my ($type, $msg) = @_;
1608
1609 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001610 our $clean = 0;
1611 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001612 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001613 }
Joe Perches3705ce52013-07-03 15:05:31 -07001614 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001615}
1616sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001617 my ($type, $msg) = @_;
1618
1619 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001620 our $clean = 0;
1621 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001622 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001623 }
Joe Perches3705ce52013-07-03 15:05:31 -07001624 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001625}
1626
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001627sub check_absolute_file {
1628 my ($absolute, $herecurr) = @_;
1629 my $file = $absolute;
1630
1631 ##print "absolute<$absolute>\n";
1632
1633 # See if any suffix of this path is a path within the tree.
1634 while ($file =~ s@^[^/]*/@@) {
1635 if (-f "$root/$file") {
1636 ##print "file<$file>\n";
1637 last;
1638 }
1639 }
1640 if (! -f _) {
1641 return 0;
1642 }
1643
1644 # It is, so see if the prefix is acceptable.
1645 my $prefix = $absolute;
1646 substr($prefix, -length($file)) = '';
1647
1648 ##print "prefix<$prefix>\n";
1649 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001650 WARN("USE_RELATIVE_PATH",
1651 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001652 }
1653}
1654
Joe Perches3705ce52013-07-03 15:05:31 -07001655sub trim {
1656 my ($string) = @_;
1657
Joe Perchesb34c6482013-09-11 14:24:01 -07001658 $string =~ s/^\s+|\s+$//g;
1659
1660 return $string;
1661}
1662
1663sub ltrim {
1664 my ($string) = @_;
1665
1666 $string =~ s/^\s+//;
1667
1668 return $string;
1669}
1670
1671sub rtrim {
1672 my ($string) = @_;
1673
1674 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001675
1676 return $string;
1677}
1678
Joe Perches52ea8502013-11-12 15:10:09 -08001679sub string_find_replace {
1680 my ($string, $find, $replace) = @_;
1681
1682 $string =~ s/$find/$replace/g;
1683
1684 return $string;
1685}
1686
Joe Perches3705ce52013-07-03 15:05:31 -07001687sub tabify {
1688 my ($leading) = @_;
1689
1690 my $source_indent = 8;
1691 my $max_spaces_before_tab = $source_indent - 1;
1692 my $spaces_to_tab = " " x $source_indent;
1693
1694 #convert leading spaces to tabs
1695 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1696 #Remove spaces before a tab
1697 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1698
1699 return "$leading";
1700}
1701
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001702sub pos_last_openparen {
1703 my ($line) = @_;
1704
1705 my $pos = 0;
1706
1707 my $opens = $line =~ tr/\(/\(/;
1708 my $closes = $line =~ tr/\)/\)/;
1709
1710 my $last_openparen = 0;
1711
1712 if (($opens == 0) || ($closes >= $opens)) {
1713 return -1;
1714 }
1715
1716 my $len = length($line);
1717
1718 for ($pos = 0; $pos < $len; $pos++) {
1719 my $string = substr($line, $pos);
1720 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1721 $pos += length($1) - 1;
1722 } elsif (substr($line, $pos, 1) eq '(') {
1723 $last_openparen = $pos;
1724 } elsif (index($string, '(') == -1) {
1725 last;
1726 }
1727 }
1728
Joe Perches91cb5192014-04-03 14:49:32 -07001729 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001730}
1731
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001732sub process {
1733 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001734
1735 my $linenr=0;
1736 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001737 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001738 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001739 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001740
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001741 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001742 my $indent;
1743 my $previndent=0;
1744 my $stashindent=0;
1745
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001746 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001747 my $signoff = 0;
1748 my $is_patch = 0;
1749
Joe Perches29ee1b02014-08-06 16:10:35 -07001750 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001751 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001752 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001753 my $non_utf8_charset = 0;
1754
Joe Perches365dd4e2014-08-06 16:10:42 -07001755 my $last_blank_line = 0;
1756
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001757 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001758 our $cnt_lines = 0;
1759 our $cnt_error = 0;
1760 our $cnt_warn = 0;
1761 our $cnt_chk = 0;
1762
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001763 # Trace the real file/line as we go.
1764 my $realfile = '';
1765 my $realline = 0;
1766 my $realcnt = 0;
1767 my $here = '';
1768 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001769 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001770 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001771 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001772
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001773 my $prev_values = 'E';
1774
1775 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001776 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001777 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001778 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001779 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001780
Joe Perches7e51f192013-09-11 14:23:57 -07001781 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001782
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001783 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001784 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001785 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001786 my @setup_docs = ();
1787 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001788
Joe Perchesd8b07712013-11-12 15:10:06 -08001789 my $camelcase_file_seeded = 0;
1790
Andy Whitcroft773647a2008-03-28 14:15:58 -07001791 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001792 my $line;
1793 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001794 $linenr++;
1795 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001796
Joe Perches3705ce52013-07-03 15:05:31 -07001797 push(@fixed, $rawline) if ($fix);
1798
Andy Whitcroft773647a2008-03-28 14:15:58 -07001799 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001800 $setup_docs = 0;
1801 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1802 $setup_docs = 1;
1803 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001804 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001805 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001806 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1807 $realline=$1-1;
1808 if (defined $2) {
1809 $realcnt=$3+1;
1810 } else {
1811 $realcnt=1+1;
1812 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001813 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001814
1815 # Guestimate if this is a continuing comment. Run
1816 # the context looking for a comment "edge". If this
1817 # edge is a close comment then we must be in a comment
1818 # at context start.
1819 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001820 my $cnt = $realcnt;
1821 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1822 next if (defined $rawlines[$ln - 1] &&
1823 $rawlines[$ln - 1] =~ /^-/);
1824 $cnt--;
1825 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001826 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001827 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1828 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1829 ($edge) = $1;
1830 last;
1831 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001832 }
1833 if (defined $edge && $edge eq '*/') {
1834 $in_comment = 1;
1835 }
1836
1837 # Guestimate if this is a continuing comment. If this
1838 # is the start of a diff block and this line starts
1839 # ' *' then it is very likely a comment.
1840 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001841 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001842 {
1843 $in_comment = 1;
1844 }
1845
1846 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1847 sanitise_line_reset($in_comment);
1848
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001849 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001850 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001851 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001852 $line = sanitise_line($rawline);
1853 }
1854 push(@lines, $line);
1855
1856 if ($realcnt > 1) {
1857 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1858 } else {
1859 $realcnt = 0;
1860 }
1861
1862 #print "==>$rawline\n";
1863 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001864
1865 if ($setup_docs && $line =~ /^\+/) {
1866 push(@setup_docs, $line);
1867 }
1868 }
1869
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001870 $prefix = '';
1871
Andy Whitcroft773647a2008-03-28 14:15:58 -07001872 $realcnt = 0;
1873 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001874 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001875 foreach my $line (@lines) {
1876 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001877 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001878 my $sline = $line; #copy of $line
1879 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001880
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001881 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001882
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001883#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001884 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001885 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001886 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001887 $realline=$1-1;
1888 if (defined $2) {
1889 $realcnt=$3+1;
1890 } else {
1891 $realcnt=1+1;
1892 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001893 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001894 $prev_values = 'E';
1895
Andy Whitcroft773647a2008-03-28 14:15:58 -07001896 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001897 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001898 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001899 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001900 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001901
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001902# track the line number as we move through the hunk, note that
1903# new versions of GNU diff omit the leading space on completely
1904# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001905 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001906 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001907 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001908
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001909 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001910 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001911
1912 # Track the previous line.
1913 ($prevline, $stashline) = ($stashline, $line);
1914 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001915 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1916
Andy Whitcroft773647a2008-03-28 14:15:58 -07001917 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001918
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001919 } elsif ($realcnt == 1) {
1920 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001921 }
1922
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001923 my $hunk_line = ($realcnt != 0);
1924
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001925#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001926 $prefix = "$filename:$realline: " if ($emacs && $file);
1927 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1928
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001929 $here = "#$linenr: " if (!$file);
1930 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001931
Joe Perches2ac73b42014-06-04 16:12:05 -07001932 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001933 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001934 if ($line =~ /^diff --git.*?(\S+)$/) {
1935 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001936 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001937 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07001938 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001939 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001940 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001941 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001942 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001943
1944 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001945 if (!$file && $tree && $p1_prefix ne '' &&
1946 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001947 WARN("PATCH_PREFIX",
1948 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001949 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001950
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001951 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001952 ERROR("MODIFIED_INCLUDE_ASM",
1953 "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 -07001954 }
Joe Perches2ac73b42014-06-04 16:12:05 -07001955 $found_file = 1;
1956 }
1957
1958 if ($found_file) {
1959 if ($realfile =~ m@^(drivers/net/|net/)@) {
1960 $check = 1;
1961 } else {
1962 $check = $check_orig;
1963 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001964 next;
1965 }
1966
Randy Dunlap389834b2007-06-08 13:47:03 -07001967 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001968
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001969 my $hereline = "$here\n$rawline\n";
1970 my $herecurr = "$here\n$rawline\n";
1971 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001972
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001973 $cnt_lines++ if ($realcnt != 0);
1974
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001975# Check for incorrect file permissions
1976 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1977 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001978 if ($realfile !~ m@scripts/@ &&
1979 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001980 ERROR("EXECUTE_PERMISSIONS",
1981 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001982 }
1983 }
1984
Joe Perches20112472011-07-25 17:13:23 -07001985# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001986 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001987 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001988 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001989 }
1990
1991# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001992 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001993 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001994 my $space_before = $1;
1995 my $sign_off = $2;
1996 my $space_after = $3;
1997 my $email = $4;
1998 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1999
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002000 if ($sign_off !~ /$signature_tags/) {
2001 WARN("BAD_SIGN_OFF",
2002 "Non-standard signature: $sign_off\n" . $herecurr);
2003 }
Joe Perches20112472011-07-25 17:13:23 -07002004 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002005 if (WARN("BAD_SIGN_OFF",
2006 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2007 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002008 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002009 "$ucfirst_sign_off $email";
2010 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002011 }
Joe Perches20112472011-07-25 17:13:23 -07002012 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002013 if (WARN("BAD_SIGN_OFF",
2014 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2015 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002016 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002017 "$ucfirst_sign_off $email";
2018 }
2019
Joe Perches20112472011-07-25 17:13:23 -07002020 }
2021 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002022 if (WARN("BAD_SIGN_OFF",
2023 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2024 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002025 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002026 "$ucfirst_sign_off $email";
2027 }
Joe Perches20112472011-07-25 17:13:23 -07002028 }
2029
2030 my ($email_name, $email_address, $comment) = parse_email($email);
2031 my $suggested_email = format_email(($email_name, $email_address));
2032 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002033 ERROR("BAD_SIGN_OFF",
2034 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002035 } else {
2036 my $dequoted = $suggested_email;
2037 $dequoted =~ s/^"//;
2038 $dequoted =~ s/" </ </;
2039 # Don't force email to have quotes
2040 # Allow just an angle bracketed address
2041 if ("$dequoted$comment" ne $email &&
2042 "<$email_address>$comment" ne $email &&
2043 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002044 WARN("BAD_SIGN_OFF",
2045 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002046 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002047 }
Joe Perches7e51f192013-09-11 14:23:57 -07002048
2049# Check for duplicate signatures
2050 my $sig_nospace = $line;
2051 $sig_nospace =~ s/\s//g;
2052 $sig_nospace = lc($sig_nospace);
2053 if (defined $signatures{$sig_nospace}) {
2054 WARN("BAD_SIGN_OFF",
2055 "Duplicate signature\n" . $herecurr);
2056 } else {
2057 $signatures{$sig_nospace} = 1;
2058 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002059 }
2060
Joe Perches9b3189e2014-06-04 16:12:10 -07002061# Check for old stable address
2062 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2063 ERROR("STABLE_ADDRESS",
2064 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2065 }
2066
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002067# Check for unwanted Gerrit info
2068 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2069 ERROR("GERRIT_CHANGE_ID",
2070 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2071 }
2072
Joe Perchesd311cd42014-08-06 16:10:57 -07002073# Check for improperly formed commit descriptions
2074 if ($in_commit_log &&
2075 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
2076 $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) {
2077 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2078 my $init_char = $1;
2079 my $orig_commit = lc($2);
2080 my $id = '01234567890ab';
2081 my $desc = 'commit description';
2082 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2083 ERROR("GIT_COMMIT_ID",
2084 "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2085 }
2086
Joe Perches13f19372014-08-06 16:10:59 -07002087# Check for added, moved or deleted files
2088 if (!$reported_maintainer_file && !$in_commit_log &&
2089 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2090 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2091 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2092 (defined($1) || defined($2))))) {
2093 $reported_maintainer_file = 1;
2094 WARN("FILE_PATH_CHANGES",
2095 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2096 }
2097
Andy Whitcroft00df3442007-06-08 13:47:06 -07002098# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002099 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002100 ERROR("CORRUPTED_PATCH",
2101 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002102 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002103 }
2104
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002105# Check for absolute kernel paths.
2106 if ($tree) {
2107 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2108 my $file = $1;
2109
2110 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2111 check_absolute_file($1, $herecurr)) {
2112 #
2113 } else {
2114 check_absolute_file($file, $herecurr);
2115 }
2116 }
2117 }
2118
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002119# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2120 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002121 $rawline !~ m/^$UTF8*$/) {
2122 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2123
2124 my $blank = copy_spacing($rawline);
2125 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2126 my $hereptr = "$hereline$ptr\n";
2127
Joe Perches34d99212011-07-25 17:13:26 -07002128 CHK("INVALID_UTF8",
2129 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002130 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002131
Joe Perches15662b32011-10-31 17:13:12 -07002132# Check if it's the start of a commit log
2133# (not a header line and we haven't seen the patch filename)
2134 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002135 !($rawline =~ /^\s+\S/ ||
2136 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002137 $in_header_lines = 0;
2138 $in_commit_log = 1;
2139 }
2140
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002141# Check if there is UTF-8 in a commit log when a mail header has explicitly
2142# declined it, i.e defined some charset where it is missing.
2143 if ($in_header_lines &&
2144 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2145 $1 !~ /utf-8/i) {
2146 $non_utf8_charset = 1;
2147 }
2148
2149 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002150 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002151 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002152 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2153 }
2154
Andy Whitcroft306708542008-10-15 22:02:28 -07002155# ignore non-hunk lines and lines being removed
2156 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002157
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002158#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002159 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002160 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002161 if (ERROR("DOS_LINE_ENDINGS",
2162 "DOS line endings\n" . $herevet) &&
2163 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002164 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002165 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002166 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2167 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002168 if (ERROR("TRAILING_WHITESPACE",
2169 "trailing whitespace\n" . $herevet) &&
2170 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002171 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002172 }
2173
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002174 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002175 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002176
Josh Triplett4783f892013-11-12 15:10:12 -08002177# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002178 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002179 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2180 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002181 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2182 my $msg_type = \&ERROR;
2183 $msg_type = \&CHK if ($file);
2184 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002185 "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 -08002186 }
2187
Andi Kleen33549572010-05-24 14:33:29 -07002188# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002189# Only applies when adding the entry originally, after that we do not have
2190# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002191 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002192 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002193 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002194 my $cnt = $realcnt;
2195 my $ln = $linenr + 1;
2196 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002197 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002198 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002199 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002200 $f = $lines[$ln - 1];
2201 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2202 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002203
2204 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002205 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002206
Joe Perches8d73e0e2014-08-06 16:10:46 -07002207 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002208 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002209 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002210 $length = -1;
2211 }
2212
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002213 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002214 $f =~ s/#.*//;
2215 $f =~ s/^\s+//;
2216 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002217 if ($f =~ /^\s*config\s/) {
2218 $is_end = 1;
2219 last;
2220 }
Andi Kleen33549572010-05-24 14:33:29 -07002221 $length++;
2222 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002223 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002224 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2225 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002226 }
2227
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002228# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2229 if ($realfile =~ /Kconfig/ &&
2230 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2231 WARN("CONFIG_EXPERIMENTAL",
2232 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2233 }
2234
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002235 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2236 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2237 my $flag = $1;
2238 my $replacement = {
2239 'EXTRA_AFLAGS' => 'asflags-y',
2240 'EXTRA_CFLAGS' => 'ccflags-y',
2241 'EXTRA_CPPFLAGS' => 'cppflags-y',
2242 'EXTRA_LDFLAGS' => 'ldflags-y',
2243 };
2244
2245 WARN("DEPRECATED_VARIABLE",
2246 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2247 }
2248
Rob Herringbff5da42014-01-23 15:54:51 -08002249# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002250 if (defined $root &&
2251 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2252 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2253
Rob Herringbff5da42014-01-23 15:54:51 -08002254 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2255
Florian Vaussardcc933192014-04-03 14:49:27 -07002256 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2257 my $vp_file = $dt_path . "vendor-prefixes.txt";
2258
Rob Herringbff5da42014-01-23 15:54:51 -08002259 foreach my $compat (@compats) {
2260 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002261 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2262 my $compat3 = $compat;
2263 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2264 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002265 if ( $? >> 8 ) {
2266 WARN("UNDOCUMENTED_DT_STRING",
2267 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2268 }
2269
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002270 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2271 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002272 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002273 if ( $? >> 8 ) {
2274 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002275 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002276 }
2277 }
2278 }
2279
Andy Whitcroft5368df22008-10-15 22:02:27 -07002280# check we are in a valid source file if not then ignore this hunk
2281 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2282
Joe Perches6cd7f382012-12-17 16:01:54 -08002283#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002284 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002285 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002286 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002287 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002288 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002289 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002290 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002291 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002292 }
2293
Josh Triplettca56dc02012-03-23 15:02:21 -07002294# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002295# to grep for the string. Make exceptions when the previous string ends in a
2296# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2297# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002298 if ($line =~ /^\+\s*"/ &&
2299 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002300 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002301 WARN("SPLIT_STRING",
2302 "quoted string split across lines\n" . $hereprev);
2303 }
2304
Joe Perches5e79d962010-03-05 13:43:55 -08002305# check for spaces before a quoted newline
2306 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002307 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2308 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2309 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002310 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
Joe Perches3705ce52013-07-03 15:05:31 -07002311 }
2312
Joe Perches5e79d962010-03-05 13:43:55 -08002313 }
2314
Andy Whitcroft8905a672007-11-28 16:21:06 -08002315# check for adding lines without a newline.
2316 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002317 WARN("MISSING_EOF_NEWLINE",
2318 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002319 }
2320
Mike Frysinger42e41c52009-09-21 17:04:40 -07002321# Blackfin: use hi/lo macros
2322 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2323 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2324 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002325 ERROR("LO_MACRO",
2326 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002327 }
2328 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2329 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002330 ERROR("HI_MACRO",
2331 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002332 }
2333 }
2334
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002335# check we are in a valid source file C or perl if not then ignore this hunk
2336 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002337
2338# at the beginning of a line any tabs must come first and anything
2339# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002340 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2341 $rawline =~ /^\+\s* \s*/) {
2342 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002343 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002344 if (ERROR("CODE_INDENT",
2345 "code indent should use tabs where possible\n" . $herevet) &&
2346 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002347 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002348 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002349 }
2350
Alberto Panizzo08e44362010-03-05 13:43:54 -08002351# check for space before tabs.
2352 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2353 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002354 if (WARN("SPACE_BEFORE_TAB",
2355 "please, no space before tabs\n" . $herevet) &&
2356 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002357 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002358 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002359 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002360 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002361 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002362 }
2363
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002364# check for && or || at the start of a line
2365 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2366 CHK("LOGICAL_CONTINUATIONS",
2367 "Logical continuations should be on the previous line\n" . $hereprev);
2368 }
2369
2370# check multi-line statement indentation matches previous line
2371 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002372 $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 -07002373 $prevline =~ /^\+(\t*)(.*)$/;
2374 my $oldindent = $1;
2375 my $rest = $2;
2376
2377 my $pos = pos_last_openparen($rest);
2378 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002379 $line =~ /^(\+| )([ \t]*)/;
2380 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002381
2382 my $goodtabindent = $oldindent .
2383 "\t" x ($pos / 8) .
2384 " " x ($pos % 8);
2385 my $goodspaceindent = $oldindent . " " x $pos;
2386
2387 if ($newindent ne $goodtabindent &&
2388 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002389
2390 if (CHK("PARENTHESIS_ALIGNMENT",
2391 "Alignment should match open parenthesis\n" . $hereprev) &&
2392 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002393 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002394 s/^\+[ \t]*/\+$goodtabindent/;
2395 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002396 }
2397 }
2398 }
2399
Joe Perchesf27c95d2014-08-06 16:10:52 -07002400 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002401 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002402 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002403 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002404 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002405 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002406 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002407 }
2408
Joe Perches05880602012-10-04 17:13:35 -07002409 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002410 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002411 $rawline =~ /^\+[ \t]*\*/ &&
2412 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002413 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2414 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2415 }
2416
2417 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002418 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2419 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002420 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002421 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2422 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2423 "networking block comments start with * on subsequent lines\n" . $hereprev);
2424 }
2425
2426 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002427 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2428 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2429 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2430 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002431 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2432 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2433 }
2434
Joe Perches7f619192014-08-06 16:10:39 -07002435# check for missing blank lines after struct/union declarations
2436# with exceptions for various attributes and macros
2437 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2438 $line =~ /^\+/ &&
2439 !($line =~ /^\+\s*$/ ||
2440 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2441 $line =~ /^\+\s*MODULE_/i ||
2442 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2443 $line =~ /^\+[a-z_]*init/ ||
2444 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2445 $line =~ /^\+\s*DECLARE/ ||
2446 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002447 if (CHK("LINE_SPACING",
2448 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2449 $fix) {
2450 my $inserted = {
2451 LINENR => $fixlinenr,
2452 LINE => "\+",
2453 };
2454 push(@fixed_inserted, $inserted);
2455 }
Joe Perches7f619192014-08-06 16:10:39 -07002456 }
2457
Joe Perches365dd4e2014-08-06 16:10:42 -07002458# check for multiple consecutive blank lines
2459 if ($prevline =~ /^[\+ ]\s*$/ &&
2460 $line =~ /^\+\s*$/ &&
2461 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002462 if (CHK("LINE_SPACING",
2463 "Please don't use multiple blank lines\n" . $hereprev) &&
2464 $fix) {
2465 my $deleted = {
2466 LINENR => $fixlinenr,
2467 LINE => $rawline,
2468 };
2469 push(@fixed_deleted, $deleted);
2470 }
2471
Joe Perches365dd4e2014-08-06 16:10:42 -07002472 $last_blank_line = $linenr;
2473 }
2474
Joe Perches3b617e3b2014-04-03 14:49:28 -07002475# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002476 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2477 # actual declarations
2478 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002479 # function pointer declarations
2480 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002481 # foo bar; where foo is some local typedef or #define
2482 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2483 # known declaration macros
2484 $prevline =~ /^\+\s+$declaration_macros/) &&
2485 # for "else if" which can look like "$Ident $Ident"
2486 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2487 # other possible extensions of declaration lines
2488 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2489 # not starting a section or a macro "\" extended line
2490 $prevline =~ /(?:\{\s*|\\)$/) &&
2491 # looks like a declaration
2492 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002493 # function pointer declarations
2494 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002495 # foo bar; where foo is some local typedef or #define
2496 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2497 # known declaration macros
2498 $sline =~ /^\+\s+$declaration_macros/ ||
2499 # start of struct or union or enum
Joe Perches3b617e3b2014-04-03 14:49:28 -07002500 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002501 # start or end of block or continuation of declaration
2502 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2503 # bitfield continuation
2504 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2505 # other possible extensions of declaration lines
2506 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2507 # indentation of previous and current line are the same
2508 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002509 if (WARN("LINE_SPACING",
2510 "Missing a blank line after declarations\n" . $hereprev) &&
2511 $fix) {
2512 my $inserted = {
2513 LINENR => $fixlinenr,
2514 LINE => "\+",
2515 };
2516 push(@fixed_inserted, $inserted);
2517 }
Joe Perches3b617e3b2014-04-03 14:49:28 -07002518 }
2519
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002520# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002521# Exceptions:
2522# 1) within comments
2523# 2) indented preprocessor commands
2524# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002525 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002526 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002527 if (WARN("LEADING_SPACE",
2528 "please, no spaces at the start of a line\n" . $herevet) &&
2529 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002530 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002531 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002532 }
2533
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002534# check we are in a valid C source file if not then ignore this hunk
2535 next if ($realfile !~ /\.(h|c)$/);
2536
Joe Perches032a4c02014-08-06 16:10:29 -07002537# check indentation of any line with a bare else
2538# if the previous line is a break or return and is indented 1 tab more...
2539 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2540 my $tabs = length($1) + 1;
2541 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2542 WARN("UNNECESSARY_ELSE",
2543 "else is not generally useful after a break or return\n" . $hereprev);
2544 }
2545 }
2546
Joe Perchesc00df192014-08-06 16:11:01 -07002547# check indentation of a line with a break;
2548# if the previous line is a goto or return and is indented the same # of tabs
2549 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2550 my $tabs = $1;
2551 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2552 WARN("UNNECESSARY_BREAK",
2553 "break is not useful after a goto or return\n" . $hereprev);
2554 }
2555 }
2556
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002557# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2558 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2559 WARN("CONFIG_EXPERIMENTAL",
2560 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2561 }
2562
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002563# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002564 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002565 WARN("CVS_KEYWORD",
2566 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002567 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002568
Mike Frysinger42e41c52009-09-21 17:04:40 -07002569# Blackfin: don't use __builtin_bfin_[cs]sync
2570 if ($line =~ /__builtin_bfin_csync/) {
2571 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002572 ERROR("CSYNC",
2573 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002574 }
2575 if ($line =~ /__builtin_bfin_ssync/) {
2576 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002577 ERROR("SSYNC",
2578 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002579 }
2580
Joe Perches56e77d72013-02-21 16:44:14 -08002581# check for old HOTPLUG __dev<foo> section markings
2582 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2583 WARN("HOTPLUG_SECTION",
2584 "Using $1 is unnecessary\n" . $herecurr);
2585 }
2586
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002587# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002588 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2589 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002590#print "LINE<$line>\n";
2591 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002592 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002593 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002594 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002595 $stat =~ s/\n./\n /g;
2596 $cond =~ s/\n./\n /g;
2597
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002598#print "linenr<$linenr> <$stat>\n";
2599 # If this statement has no statement boundaries within
2600 # it there is no point in retrying a statement scan
2601 # until we hit end of it.
2602 my $frag = $stat; $frag =~ s/;+\s*$//;
2603 if ($frag !~ /(?:{|;)/) {
2604#print "skip<$line_nr_next>\n";
2605 $suppress_statement = $line_nr_next;
2606 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002607
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002608 # Find the real next line.
2609 $realline_next = $line_nr_next;
2610 if (defined $realline_next &&
2611 (!defined $lines[$realline_next - 1] ||
2612 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2613 $realline_next++;
2614 }
2615
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002616 my $s = $stat;
2617 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002618
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002619 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002620 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002621
2622 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002623 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002624
Andy Whitcroft463f2862009-09-21 17:04:34 -07002625 } elsif ($s =~ /^.\s*else\b/s) {
2626
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002627 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002628 } 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 -07002629 my $type = $1;
2630 $type =~ s/\s+/ /g;
2631 possible($type, "A:" . $s);
2632
Andy Whitcroft8905a672007-11-28 16:21:06 -08002633 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002634 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002635 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002636 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002637
2638 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002639 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002640 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002641 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002642
2643 # Check for any sort of function declaration.
2644 # int foo(something bar, other baz);
2645 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002646 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 -08002647 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002648
Andy Whitcroftcf655042008-03-04 14:28:20 -08002649 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002650 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002651 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002652
Andy Whitcroft8905a672007-11-28 16:21:06 -08002653 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002654 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002655
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002656 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002657 }
2658 }
2659 }
2660
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002661 }
2662
Andy Whitcroft653d4872007-06-23 17:16:34 -07002663#
2664# Checks which may be anchored in the context.
2665#
2666
2667# Check for switch () and associated case and default
2668# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002669 if ($line=~/\bswitch\s*\(.*\)/) {
2670 my $err = '';
2671 my $sep = '';
2672 my @ctx = ctx_block_outer($linenr, $realcnt);
2673 shift(@ctx);
2674 for my $ctx (@ctx) {
2675 my ($clen, $cindent) = line_stats($ctx);
2676 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2677 $indent != $cindent) {
2678 $err .= "$sep$ctx\n";
2679 $sep = '';
2680 } else {
2681 $sep = "[...]\n";
2682 }
2683 }
2684 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002685 ERROR("SWITCH_CASE_INDENT_LEVEL",
2686 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002687 }
2688 }
2689
2690# if/while/etc brace do not go on next line, unless defining a do while loop,
2691# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002692 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002693 my $pre_ctx = "$1$2";
2694
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002695 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002696
2697 if ($line =~ /^\+\t{6,}/) {
2698 WARN("DEEP_INDENTATION",
2699 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2700 }
2701
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002702 my $ctx_cnt = $realcnt - $#ctx - 1;
2703 my $ctx = join("\n", @ctx);
2704
Andy Whitcroft548596d2008-07-23 21:29:01 -07002705 my $ctx_ln = $linenr;
2706 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002707
Andy Whitcroft548596d2008-07-23 21:29:01 -07002708 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2709 defined $lines[$ctx_ln - 1] &&
2710 $lines[$ctx_ln - 1] =~ /^-/)) {
2711 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2712 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002713 $ctx_ln++;
2714 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002715
Andy Whitcroft53210162008-07-23 21:29:03 -07002716 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2717 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002718
Joe Perchesd752fcc2014-08-06 16:11:05 -07002719 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002720 ERROR("OPEN_BRACE",
2721 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002722 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002723 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002724 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2725 $ctx =~ /\)\s*\;\s*$/ &&
2726 defined $lines[$ctx_ln - 1])
2727 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002728 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2729 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002730 WARN("TRAILING_SEMICOLON",
2731 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002732 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002733 }
2734 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002735 }
2736
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002737# Check relative indent for conditionals and blocks.
2738 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002739 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2740 ctx_statement_block($linenr, $realcnt, 0)
2741 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002742 my ($s, $c) = ($stat, $cond);
2743
2744 substr($s, 0, length($c), '');
2745
2746 # Make sure we remove the line prefixes as we have
2747 # none on the first line, and are going to readd them
2748 # where necessary.
2749 $s =~ s/\n./\n/gs;
2750
2751 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002752 my @newlines = ($c =~ /\n/gs);
2753 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002754
2755 # We want to check the first line inside the block
2756 # starting at the end of the conditional, so remove:
2757 # 1) any blank line termination
2758 # 2) any opening brace { on end of the line
2759 # 3) any do (...) {
2760 my $continuation = 0;
2761 my $check = 0;
2762 $s =~ s/^.*\bdo\b//;
2763 $s =~ s/^\s*{//;
2764 if ($s =~ s/^\s*\\//) {
2765 $continuation = 1;
2766 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002767 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002768 $check = 1;
2769 $cond_lines++;
2770 }
2771
2772 # Also ignore a loop construct at the end of a
2773 # preprocessor statement.
2774 if (($prevline =~ /^.\s*#\s*define\s/ ||
2775 $prevline =~ /\\\s*$/) && $continuation == 0) {
2776 $check = 0;
2777 }
2778
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002779 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002780 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002781 while ($cond_ptr != $cond_lines) {
2782 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002783
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002784 # If we see an #else/#elif then the code
2785 # is not linear.
2786 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2787 $check = 0;
2788 }
2789
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002790 # Ignore:
2791 # 1) blank lines, they should be at 0,
2792 # 2) preprocessor lines, and
2793 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002794 if ($continuation ||
2795 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002796 $s =~ /^\s*#\s*?/ ||
2797 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002798 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002799 if ($s =~ s/^.*?\n//) {
2800 $cond_lines++;
2801 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002802 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002803 }
2804
2805 my (undef, $sindent) = line_stats("+" . $s);
2806 my $stat_real = raw_line($linenr, $cond_lines);
2807
2808 # Check if either of these lines are modified, else
2809 # this is not this patch's fault.
2810 if (!defined($stat_real) ||
2811 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2812 $check = 0;
2813 }
2814 if (defined($stat_real) && $cond_lines > 1) {
2815 $stat_real = "[...]\n$stat_real";
2816 }
2817
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002818 #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 -07002819
2820 if ($check && (($sindent % 8) != 0 ||
2821 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002822 WARN("SUSPECT_CODE_INDENT",
2823 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002824 }
2825 }
2826
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002827 # Track the 'values' across context and added lines.
2828 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002829 my ($curr_values, $curr_vars) =
2830 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002831 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002832 if ($dbg_values) {
2833 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002834 print "$linenr > .$outline\n";
2835 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002836 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002837 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002838 $prev_values = substr($curr_values, -1);
2839
Andy Whitcroft00df3442007-06-08 13:47:06 -07002840#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002841 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002842
Andy Whitcroft653d4872007-06-23 17:16:34 -07002843# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002844 if ($dbg_type) {
2845 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002846 ERROR("TEST_TYPE",
2847 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002848 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002849 ERROR("TEST_NOT_TYPE",
2850 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002851 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002852 next;
2853 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002854# TEST: allow direct testing of the attribute matcher.
2855 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002856 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002857 ERROR("TEST_ATTR",
2858 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002859 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002860 ERROR("TEST_NOT_ATTR",
2861 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002862 }
2863 next;
2864 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002865
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002866# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002867 if ($line =~ /^.\s*{/ &&
2868 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002869 if (ERROR("OPEN_BRACE",
2870 "that open brace { should be on the previous line\n" . $hereprev) &&
2871 $fix && $prevline =~ /^\+/) {
2872 my $deleted = {
2873 LINENR => $fixlinenr - 1,
2874 LINE => $prevrawline,
2875 };
2876 push(@fixed_deleted, $deleted);
2877 $deleted = {
2878 LINENR => $fixlinenr,
2879 LINE => $rawline,
2880 };
2881 push(@fixed_deleted, $deleted);
2882 my $fixedline = $prevrawline;
2883 $fixedline =~ s/\s*=\s*$/ = {/;
2884 my $inserted = {
2885 LINENR => $fixlinenr,
2886 LINE => $fixedline,
2887 };
2888 push(@fixed_inserted, $inserted);
2889 $fixedline = $line;
2890 $fixedline =~ s/^(.\s*){\s*/$1/;
2891 $inserted = {
2892 LINENR => $fixlinenr,
2893 LINE => $fixedline,
2894 };
2895 push(@fixed_inserted, $inserted);
2896 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002897 }
2898
Andy Whitcroft653d4872007-06-23 17:16:34 -07002899#
2900# Checks which are anchored on the added line.
2901#
2902
2903# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002904 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002905 my $path = $1;
2906 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002907 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002908 "malformed #include filename\n" . $herecurr);
2909 }
2910 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2911 ERROR("UAPI_INCLUDE",
2912 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002913 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002914 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002915
2916# no C99 // comments
2917 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002918 if (ERROR("C99_COMMENTS",
2919 "do not use C99 // comments\n" . $herecurr) &&
2920 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002921 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07002922 if ($line =~ /\/\/(.*)$/) {
2923 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07002924 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07002925 }
2926 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002927 }
2928 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002929 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002930 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002931
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002932# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2933# the whole statement.
2934#print "APW <$lines[$realline_next - 1]>\n";
2935 if (defined $realline_next &&
2936 exists $lines[$realline_next - 1] &&
2937 !defined $suppress_export{$realline_next} &&
2938 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2939 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002940 # Handle definitions which produce identifiers with
2941 # a prefix:
2942 # XXX(foo);
2943 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002944 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002945 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002946 $name =~ /^${Ident}_$2/) {
2947#print "FOO C name<$name>\n";
2948 $suppress_export{$realline_next} = 1;
2949
2950 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002951 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002952 ^.DEFINE_$Ident\(\Q$name\E\)|
2953 ^.DECLARE_$Ident\(\Q$name\E\)|
2954 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002955 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2956 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002957 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002958#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2959 $suppress_export{$realline_next} = 2;
2960 } else {
2961 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002962 }
2963 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002964 if (!defined $suppress_export{$linenr} &&
2965 $prevline =~ /^.\s*$/ &&
2966 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2967 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2968#print "FOO B <$lines[$linenr - 1]>\n";
2969 $suppress_export{$linenr} = 2;
2970 }
2971 if (defined $suppress_export{$linenr} &&
2972 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002973 WARN("EXPORT_SYMBOL",
2974 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002975 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002976
Joe Eloff5150bda2010-08-09 17:21:00 -07002977# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002978 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2979 if (ERROR("GLOBAL_INITIALISERS",
2980 "do not initialise globals to 0 or NULL\n" .
2981 $herecurr) &&
2982 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002983 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002984 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002985 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002986# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002987 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2988 if (ERROR("INITIALISED_STATIC",
2989 "do not initialise statics to 0 or NULL\n" .
2990 $herecurr) &&
2991 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002992 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002993 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002994 }
2995
Joe Perchescb710ec2010-10-26 14:23:20 -07002996# check for static const char * arrays.
2997 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002998 WARN("STATIC_CONST_CHAR_ARRAY",
2999 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003000 $herecurr);
3001 }
3002
3003# check for static char foo[] = "bar" declarations.
3004 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003005 WARN("STATIC_CONST_CHAR_ARRAY",
3006 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003007 $herecurr);
3008 }
3009
Joe Perches9b0fa602014-04-03 14:49:18 -07003010# check for non-global char *foo[] = {"bar", ...} declarations.
3011 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3012 WARN("STATIC_CONST_CHAR_ARRAY",
3013 "char * array declaration might be better as static const\n" .
3014 $herecurr);
3015 }
3016
Joe Perchesb36190c2014-01-27 17:07:18 -08003017# check for function declarations without arguments like "int foo()"
3018 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3019 if (ERROR("FUNCTION_WITHOUT_ARGS",
3020 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3021 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003022 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003023 }
3024 }
3025
Joe Perches92e112f2013-12-13 11:36:22 -07003026# check for uses of DEFINE_PCI_DEVICE_TABLE
3027 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3028 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3029 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3030 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003031 $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 -07003032 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003033 }
3034
Andy Whitcroft653d4872007-06-23 17:16:34 -07003035# check for new typedefs, only function parameters and sparse annotations
3036# make sense.
3037 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003038 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003039 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003040 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003041 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003042 WARN("NEW_TYPEDEFS",
3043 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003044 }
3045
3046# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003047 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003048 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3049 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003050 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003051
Andy Whitcroft65863862009-01-06 14:41:21 -08003052 # Should start with a space.
3053 $to =~ s/^(\S)/ $1/;
3054 # Should not end with a space.
3055 $to =~ s/\s+$//;
3056 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003057 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003058 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003059
Joe Perches3705ce52013-07-03 15:05:31 -07003060## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003061 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003062 if (ERROR("POINTER_LOCATION",
3063 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3064 $fix) {
3065 my $sub_from = $ident;
3066 my $sub_to = $ident;
3067 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003068 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003069 s@\Q$sub_from\E@$sub_to@;
3070 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003071 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003072 }
3073 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3074 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003075 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003076
Andy Whitcroft65863862009-01-06 14:41:21 -08003077 # Should start with a space.
3078 $to =~ s/^(\S)/ $1/;
3079 # Should not end with a space.
3080 $to =~ s/\s+$//;
3081 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003082 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003083 }
3084 # Modifiers should have spaces.
3085 $to =~ s/(\b$Modifier$)/$1 /;
3086
Joe Perches3705ce52013-07-03 15:05:31 -07003087## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003088 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003089 if (ERROR("POINTER_LOCATION",
3090 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3091 $fix) {
3092
3093 my $sub_from = $match;
3094 my $sub_to = $match;
3095 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003096 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003097 s@\Q$sub_from\E@$sub_to@;
3098 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003099 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003100 }
3101
3102# # no BUG() or BUG_ON()
3103# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3104# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3105# print "$herecurr";
3106# $clean = 0;
3107# }
3108
Andy Whitcroft8905a672007-11-28 16:21:06 -08003109 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003110 WARN("LINUX_VERSION_CODE",
3111 "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 -08003112 }
3113
Joe Perches17441222011-06-15 15:08:17 -07003114# check for uses of printk_ratelimit
3115 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003116 WARN("PRINTK_RATELIMITED",
3117"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003118 }
3119
Andy Whitcroft00df3442007-06-08 13:47:06 -07003120# printk should use KERN_* levels. Note that follow on printk's on the
3121# same line do not need a level, so we use the current block context
3122# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003123# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003124# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003125 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003126 my $ok = 0;
3127 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3128 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003129 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003130 # with "\n" ignore it, else it is to blame
3131 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3132 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3133 $ok = 1;
3134 }
3135 last;
3136 }
3137 }
3138 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003139 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3140 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003141 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003142 }
3143
Joe Perches243f3802012-05-31 16:26:09 -07003144 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3145 my $orig = $1;
3146 my $level = lc($orig);
3147 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003148 my $level2 = $level;
3149 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003150 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003151 "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 -07003152 }
3153
3154 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003155 if (WARN("PREFER_PR_LEVEL",
3156 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3157 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003158 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003159 s/\bpr_warning\b/pr_warn/;
3160 }
Joe Perches243f3802012-05-31 16:26:09 -07003161 }
3162
Joe Perchesdc139312013-02-21 16:44:13 -08003163 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3164 my $orig = $1;
3165 my $level = lc($orig);
3166 $level = "warn" if ($level eq "warning");
3167 $level = "dbg" if ($level eq "debug");
3168 WARN("PREFER_DEV_LEVEL",
3169 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3170 }
3171
Andy Whitcroft653d4872007-06-23 17:16:34 -07003172# function brace can't be on same line, except for #defines of do while,
3173# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003174 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
3175 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003176 ERROR("OPEN_BRACE",
3177 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003178 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003179
Andy Whitcroft8905a672007-11-28 16:21:06 -08003180# open braces for enum, union and struct go on the same line.
3181 if ($line =~ /^.\s*{/ &&
3182 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003183 ERROR("OPEN_BRACE",
3184 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003185 }
3186
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003187# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003188 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3189 if (WARN("SPACING",
3190 "missing space after $1 definition\n" . $herecurr) &&
3191 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003192 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003193 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3194 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003195 }
3196
Joe Perches31070b52014-01-23 15:54:49 -08003197# Function pointer declarations
3198# check spacing between type, funcptr, and args
3199# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003200 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003201 my $declare = $1;
3202 my $pre_pointer_space = $2;
3203 my $post_pointer_space = $3;
3204 my $funcname = $4;
3205 my $post_funcname_space = $5;
3206 my $pre_args_space = $6;
3207
Joe Perches91f72e92014-04-03 14:49:12 -07003208# the $Declare variable will capture all spaces after the type
3209# so check it for a missing trailing missing space but pointer return types
3210# don't need a space so don't warn for those.
3211 my $post_declare_space = "";
3212 if ($declare =~ /(\s+)$/) {
3213 $post_declare_space = $1;
3214 $declare = rtrim($declare);
3215 }
3216 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003217 WARN("SPACING",
3218 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003219 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003220 }
3221
3222# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003223# This test is not currently implemented because these declarations are
3224# equivalent to
3225# int foo(int bar, ...)
3226# and this is form shouldn't/doesn't generate a checkpatch warning.
3227#
3228# elsif ($declare =~ /\s{2,}$/) {
3229# WARN("SPACING",
3230# "Multiple spaces after return type\n" . $herecurr);
3231# }
Joe Perches31070b52014-01-23 15:54:49 -08003232
3233# unnecessary space "type ( *funcptr)(args...)"
3234 if (defined $pre_pointer_space &&
3235 $pre_pointer_space =~ /^\s/) {
3236 WARN("SPACING",
3237 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3238 }
3239
3240# unnecessary space "type (* funcptr)(args...)"
3241 if (defined $post_pointer_space &&
3242 $post_pointer_space =~ /^\s/) {
3243 WARN("SPACING",
3244 "Unnecessary space before function pointer name\n" . $herecurr);
3245 }
3246
3247# unnecessary space "type (*funcptr )(args...)"
3248 if (defined $post_funcname_space &&
3249 $post_funcname_space =~ /^\s/) {
3250 WARN("SPACING",
3251 "Unnecessary space after function pointer name\n" . $herecurr);
3252 }
3253
3254# unnecessary space "type (*funcptr) (args...)"
3255 if (defined $pre_args_space &&
3256 $pre_args_space =~ /^\s/) {
3257 WARN("SPACING",
3258 "Unnecessary space before function pointer arguments\n" . $herecurr);
3259 }
3260
3261 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003262 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003263 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003264 }
3265 }
3266
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003267# check for spacing round square brackets; allowed:
3268# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003269# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3270# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003271 while ($line =~ /(.*?\s)\[/g) {
3272 my ($where, $prefix) = ($-[1], $1);
3273 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003274 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003275 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003276 if (ERROR("BRACKET_SPACE",
3277 "space prohibited before open square bracket '['\n" . $herecurr) &&
3278 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003279 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003280 s/^(\+.*?)\s+\[/$1\[/;
3281 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003282 }
3283 }
3284
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003285# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003286 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003287 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003288 my $ctx_before = substr($line, 0, $-[1]);
3289 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003290
3291 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003292 if ($name =~ /^(?:
3293 if|for|while|switch|return|case|
3294 volatile|__volatile__|
3295 __attribute__|format|__extension__|
3296 asm|__asm__)$/x)
3297 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003298 # cpp #define statements have non-optional spaces, ie
3299 # if there is a space between the name and the open
3300 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003301 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003302
3303 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003304 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003305
3306 # If this whole things ends with a type its most
3307 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003308 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003309
3310 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003311 if (WARN("SPACING",
3312 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3313 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003314 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003315 s/\b$name\s+\(/$name\(/;
3316 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003317 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003318 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003319
Andy Whitcroft653d4872007-06-23 17:16:34 -07003320# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003321 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003322 my $fixed_line = "";
3323 my $line_fixed = 0;
3324
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003325 my $ops = qr{
3326 <<=|>>=|<=|>=|==|!=|
3327 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3328 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003329 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003330 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003331 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003332 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003333
3334## print("element count: <" . $#elements . ">\n");
3335## foreach my $el (@elements) {
3336## print("el: <$el>\n");
3337## }
3338
3339 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003340 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003341
Joe Perches3705ce52013-07-03 15:05:31 -07003342 foreach my $el (@elements) {
3343 push(@fix_elements, substr($rawline, $off, length($el)));
3344 $off += length($el);
3345 }
3346
3347 $off = 0;
3348
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003349 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003350 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003351
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003352 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003353
3354 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3355
3356## print("n: <$n> good: <$good>\n");
3357
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003358 $off += length($elements[$n]);
3359
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003360 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003361 my $ca = substr($opline, 0, $off);
3362 my $cc = '';
3363 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3364 $cc = substr($opline, $off + length($elements[$n + 1]));
3365 }
3366 my $cb = "$ca$;$cc";
3367
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003368 my $a = '';
3369 $a = 'V' if ($elements[$n] ne '');
3370 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003371 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003372 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3373 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003374 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003375
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003376 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003377
3378 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003379 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003380 $c = 'V' if ($elements[$n + 2] ne '');
3381 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003382 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003383 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3384 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003385 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003386 } else {
3387 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003388 }
3389
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003390 my $ctx = "${a}x${c}";
3391
3392 my $at = "(ctx:$ctx)";
3393
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003394 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003395 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003396
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003397 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003398 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003399
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003400 # Get the full operator variant.
3401 my $opv = $op . substr($curr_vars, $off, 1);
3402
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003403 # Ignore operators passed as parameters.
3404 if ($op_type ne 'V' &&
3405 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3406
Andy Whitcroftcf655042008-03-04 14:28:20 -08003407# # Ignore comments
3408# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003409
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003410 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003411 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003412 if ($ctx !~ /.x[WEBC]/ &&
3413 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003414 if (ERROR("SPACING",
3415 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003416 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003417 $line_fixed = 1;
3418 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003419 }
3420
3421 # // is a comment
3422 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003423
Joe Perchesb00e4812014-04-03 14:49:33 -07003424 # : when part of a bitfield
3425 } elsif ($opv eq ':B') {
3426 # skip the bitfield test for now
3427
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003428 # No spaces for:
3429 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003430 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003431 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003432 if (ERROR("SPACING",
3433 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003434 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003435 if (defined $fix_elements[$n + 2]) {
3436 $fix_elements[$n + 2] =~ s/^\s+//;
3437 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003438 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003439 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003440 }
3441
3442 # , must have a space on the right.
3443 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003444 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003445 if (ERROR("SPACING",
3446 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003447 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003448 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003449 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003450 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003451 }
3452
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003453 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003454 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003455 #warn "'*' is part of type\n";
3456
3457 # unary operators should have a space before and
3458 # none after. May be left adjacent to another
3459 # unary operator, or a cast
3460 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003461 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003462 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003463 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003464 if (ERROR("SPACING",
3465 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003466 if ($n != $last_after + 2) {
3467 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3468 $line_fixed = 1;
3469 }
Joe Perches3705ce52013-07-03 15:05:31 -07003470 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003471 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003472 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003473 # A unary '*' may be const
3474
3475 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003476 if (ERROR("SPACING",
3477 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003478 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003479 if (defined $fix_elements[$n + 2]) {
3480 $fix_elements[$n + 2] =~ s/^\s+//;
3481 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003482 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003483 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003484 }
3485
3486 # unary ++ and unary -- are allowed no space on one side.
3487 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003488 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003489 if (ERROR("SPACING",
3490 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003491 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003492 $line_fixed = 1;
3493 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003494 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003495 if ($ctx =~ /Wx[BE]/ ||
3496 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003497 if (ERROR("SPACING",
3498 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003499 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003500 $line_fixed = 1;
3501 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003502 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003503 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003504 if (ERROR("SPACING",
3505 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003506 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003507 if (defined $fix_elements[$n + 2]) {
3508 $fix_elements[$n + 2] =~ s/^\s+//;
3509 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003510 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003511 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003512 }
3513
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003514 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003515 } elsif ($op eq '<<' or $op eq '>>' or
3516 $op eq '&' or $op eq '^' or $op eq '|' or
3517 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003518 $op eq '*' or $op eq '/' or
3519 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003520 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003521 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003522 if (ERROR("SPACING",
3523 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003524 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3525 if (defined $fix_elements[$n + 2]) {
3526 $fix_elements[$n + 2] =~ s/^\s+//;
3527 }
Joe Perches3705ce52013-07-03 15:05:31 -07003528 $line_fixed = 1;
3529 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003530 }
3531
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003532 # A colon needs no spaces before when it is
3533 # terminating a case value or a label.
3534 } elsif ($opv eq ':C' || $opv eq ':L') {
3535 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003536 if (ERROR("SPACING",
3537 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003538 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003539 $line_fixed = 1;
3540 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003541 }
3542
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003543 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003544 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003545 my $ok = 0;
3546
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003547 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003548 if (($op eq '<' &&
3549 $cc =~ /^\S+\@\S+>/) ||
3550 ($op eq '>' &&
3551 $ca =~ /<\S+\@\S+$/))
3552 {
3553 $ok = 1;
3554 }
3555
Joe Perches84731622013-11-12 15:10:05 -08003556 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003557 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003558 my $msg_type = \&ERROR;
3559 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3560
3561 if (&{$msg_type}("SPACING",
3562 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003563 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3564 if (defined $fix_elements[$n + 2]) {
3565 $fix_elements[$n + 2] =~ s/^\s+//;
3566 }
Joe Perches3705ce52013-07-03 15:05:31 -07003567 $line_fixed = 1;
3568 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003569 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003570 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003571 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003572
3573## print("n: <$n> GOOD: <$good>\n");
3574
3575 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003576 }
Joe Perches3705ce52013-07-03 15:05:31 -07003577
3578 if (($#elements % 2) == 0) {
3579 $fixed_line = $fixed_line . $fix_elements[$#elements];
3580 }
3581
Joe Perches194f66f2014-08-06 16:11:03 -07003582 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3583 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003584 }
3585
3586
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003587 }
3588
Joe Perches786b6322013-07-03 15:05:32 -07003589# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003590 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003591 if (WARN("SPACING",
3592 "space prohibited before semicolon\n" . $herecurr) &&
3593 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003594 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003595 s/^(\+.*\S)\s+;/$1;/;
3596 }
3597 }
3598
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003599# check for multiple assignments
3600 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003601 CHK("MULTIPLE_ASSIGNMENTS",
3602 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003603 }
3604
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003605## # check for multiple declarations, allowing for a function declaration
3606## # continuation.
3607## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3608## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3609##
3610## # Remove any bracketed sections to ensure we do not
3611## # falsly report the parameters of functions.
3612## my $ln = $line;
3613## while ($ln =~ s/\([^\(\)]*\)//g) {
3614## }
3615## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003616## WARN("MULTIPLE_DECLARATION",
3617## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003618## }
3619## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003620
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003621#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003622 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3623 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003624 if (ERROR("SPACING",
3625 "space required before the open brace '{'\n" . $herecurr) &&
3626 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003627 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003628 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003629 }
3630
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003631## # check for blank lines before declarations
3632## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3633## $prevrawline =~ /^.\s*$/) {
3634## WARN("SPACING",
3635## "No blank lines before declarations\n" . $hereprev);
3636## }
3637##
3638
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003639# closing brace should have a space following it when it has anything
3640# on the line
3641 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003642 if (ERROR("SPACING",
3643 "space required after that close brace '}'\n" . $herecurr) &&
3644 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003645 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003646 s/}((?!(?:,|;|\)))\S)/} $1/;
3647 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003648 }
3649
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003650# check spacing on square brackets
3651 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003652 if (ERROR("SPACING",
3653 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3654 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003655 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003656 s/\[\s+/\[/;
3657 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003658 }
3659 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003660 if (ERROR("SPACING",
3661 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3662 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003663 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003664 s/\s+\]/\]/;
3665 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003666 }
3667
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003668# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003669 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3670 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003671 if (ERROR("SPACING",
3672 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3673 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003674 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003675 s/\(\s+/\(/;
3676 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003677 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003678 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003679 $line !~ /for\s*\(.*;\s+\)/ &&
3680 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003681 if (ERROR("SPACING",
3682 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3683 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003684 print("fixlinenr: <$fixlinenr> fixed[fixlinenr]: <$fixed[$fixlinenr]>\n");
3685 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003686 s/\s+\)/\)/;
3687 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003688 }
3689
Joe Perchese2826fd2014-08-06 16:10:48 -07003690# check unnecessary parentheses around addressof/dereference single $Lvals
3691# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3692
3693 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3694 CHK("UNNECESSARY_PARENTHESES",
3695 "Unnecessary parentheses around $1\n" . $herecurr);
3696 }
3697
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003698#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003699 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003700 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003701 if (WARN("INDENTED_LABEL",
3702 "labels should not be indented\n" . $herecurr) &&
3703 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003704 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003705 s/^(.)\s+/$1/;
3706 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003707 }
3708
Joe Perches5b9553a2014-04-03 14:49:21 -07003709# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003710 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003711 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003712 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003713 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3714 my $value = $1;
3715 $value = deparenthesize($value);
3716 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3717 ERROR("RETURN_PARENTHESES",
3718 "return is not a function, parentheses are not required\n" . $herecurr);
3719 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003720 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003721 ERROR("SPACING",
3722 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003723 }
3724 }
Joe Perches507e5142013-11-12 15:10:13 -08003725
Joe Perchesb43ae212014-06-23 13:22:07 -07003726# unnecessary return in a void function
3727# at end-of-function, with the previous line a single leading tab, then return;
3728# and the line before that not a goto label target like "out:"
3729 if ($sline =~ /^[ \+]}\s*$/ &&
3730 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3731 $linenr >= 3 &&
3732 $lines[$linenr - 3] =~ /^[ +]/ &&
3733 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003734 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003735 "void function return statements are not generally useful\n" . $hereprev);
3736 }
Joe Perches9819cf22014-06-04 16:12:09 -07003737
Joe Perches189248d2014-01-23 15:54:47 -08003738# if statements using unnecessary parentheses - ie: if ((foo == bar))
3739 if ($^V && $^V ge 5.10.0 &&
3740 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3741 my $openparens = $1;
3742 my $count = $openparens =~ tr@\(@\(@;
3743 my $msg = "";
3744 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3745 my $comp = $4; #Not $1 because of $LvalOrFunc
3746 $msg = " - maybe == should be = ?" if ($comp eq "==");
3747 WARN("UNNECESSARY_PARENTHESES",
3748 "Unnecessary parentheses$msg\n" . $herecurr);
3749 }
3750 }
3751
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003752# Return of what appears to be an errno should normally be -'ve
3753 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3754 my $name = $1;
3755 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003756 WARN("USE_NEGATIVE_ERRNO",
3757 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003758 }
3759 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003760
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003761# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003762 if ($line =~ /\b(if|while|for|switch)\(/) {
3763 if (ERROR("SPACING",
3764 "space required before the open parenthesis '('\n" . $herecurr) &&
3765 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003766 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003767 s/\b(if|while|for|switch)\(/$1 \(/;
3768 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003769 }
3770
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003771# Check for illegal assignment in if conditional -- and check for trailing
3772# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003773 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003774 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3775 ctx_statement_block($linenr, $realcnt, 0)
3776 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003777 my ($stat_next) = ctx_statement_block($line_nr_next,
3778 $remain_next, $off_next);
3779 $stat_next =~ s/\n./\n /g;
3780 ##print "stat<$stat> stat_next<$stat_next>\n";
3781
3782 if ($stat_next =~ /^\s*while\b/) {
3783 # If the statement carries leading newlines,
3784 # then count those as offsets.
3785 my ($whitespace) =
3786 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3787 my $offset =
3788 statement_rawlines($whitespace) - 1;
3789
3790 $suppress_whiletrailers{$line_nr_next +
3791 $offset} = 1;
3792 }
3793 }
3794 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003795 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003796 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003797 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003798
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003799 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003800 ERROR("ASSIGN_IN_IF",
3801 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003802 }
3803
3804 # Find out what is on the end of the line after the
3805 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003806 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003807 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003808 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003809 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3810 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003811 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003812 # Find out how long the conditional actually is.
3813 my @newlines = ($c =~ /\n/gs);
3814 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003815 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003816
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003817 $stat_real = raw_line($linenr, $cond_lines)
3818 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003819 if (defined($stat_real) && $cond_lines > 1) {
3820 $stat_real = "[...]\n$stat_real";
3821 }
3822
Joe Perches000d1cc12011-07-25 17:13:25 -07003823 ERROR("TRAILING_STATEMENTS",
3824 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003825 }
3826 }
3827
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003828# Check for bitwise tests written as boolean
3829 if ($line =~ /
3830 (?:
3831 (?:\[|\(|\&\&|\|\|)
3832 \s*0[xX][0-9]+\s*
3833 (?:\&\&|\|\|)
3834 |
3835 (?:\&\&|\|\|)
3836 \s*0[xX][0-9]+\s*
3837 (?:\&\&|\|\||\)|\])
3838 )/x)
3839 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003840 WARN("HEXADECIMAL_BOOLEAN_TEST",
3841 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003842 }
3843
Andy Whitcroft8905a672007-11-28 16:21:06 -08003844# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003845 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3846 my $s = $1;
3847 $s =~ s/$;//g; # Remove any comments
3848 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003849 ERROR("TRAILING_STATEMENTS",
3850 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003851 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003852 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003853# if should not continue a brace
3854 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003855 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07003856 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003857 $herecurr);
3858 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003859# case and default should not have general statements after them
3860 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3861 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003862 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003863 \s*return\s+
3864 )/xg)
3865 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003866 ERROR("TRAILING_STATEMENTS",
3867 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003868 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003869
3870 # Check for }<nl>else {, these must be at the same
3871 # indent level to be relevant to each other.
3872 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3873 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003874 ERROR("ELSE_AFTER_BRACE",
3875 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003876 }
3877
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003878 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3879 $previndent == $indent) {
3880 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3881
3882 # Find out what is on the end of the line after the
3883 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003884 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003885 $s =~ s/\n.*//g;
3886
3887 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003888 ERROR("WHILE_AFTER_BRACE",
3889 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003890 }
3891 }
3892
Joe Perches95e2c602013-07-03 15:05:20 -07003893#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003894 while ($line =~ m{($Constant|$Lval)}g) {
3895 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003896
3897#gcc binary extension
3898 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003899 if (WARN("GCC_BINARY_CONSTANT",
3900 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3901 $fix) {
3902 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07003903 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003904 s/\b$var\b/$hexval/;
3905 }
Joe Perches95e2c602013-07-03 15:05:20 -07003906 }
3907
3908#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003909 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003910 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003911#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003912 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003913#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003914 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003915 while ($var =~ m{($Ident)}g) {
3916 my $word = $1;
3917 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003918 if ($check) {
3919 seed_camelcase_includes();
3920 if (!$file && !$camelcase_file_seeded) {
3921 seed_camelcase_file($realfile);
3922 $camelcase_file_seeded = 1;
3923 }
3924 }
Joe Perches7e781f62013-09-11 14:23:55 -07003925 if (!defined $camelcase{$word}) {
3926 $camelcase{$word} = 1;
3927 CHK("CAMELCASE",
3928 "Avoid CamelCase: <$word>\n" . $herecurr);
3929 }
Joe Perches34456862013-07-03 15:05:34 -07003930 }
Joe Perches323c1262012-12-17 16:02:07 -08003931 }
3932 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003933
3934#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003935 if ($line =~ /\#\s*define.*\\\s+$/) {
3936 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3937 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3938 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003939 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003940 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003941 }
3942
Andy Whitcroft653d4872007-06-23 17:16:34 -07003943#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003944 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003945 my $file = "$1.h";
3946 my $checkfile = "include/linux/$file";
3947 if (-f "$root/$checkfile" &&
3948 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003949 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003950 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003951 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003952 CHK("ARCH_INCLUDE_LINUX",
3953 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003954 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003955 WARN("INCLUDE_LINUX",
3956 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003957 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003958 }
3959 }
3960
Andy Whitcroft653d4872007-06-23 17:16:34 -07003961# multi-statement macros should be enclosed in a do while loop, grab the
3962# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003963# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003964 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3965 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003966 my $ln = $linenr;
3967 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003968 my ($off, $dstat, $dcond, $rest);
3969 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003970 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003971 ctx_statement_block($linenr, $realcnt, 0);
3972 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003973 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003974 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003975
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003976 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003977 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003978 $dstat =~ s/\\\n.//g;
3979 $dstat =~ s/^\s*//s;
3980 $dstat =~ s/\s*$//s;
3981
3982 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003983 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3984 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003985 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003986 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003987 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003988
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003989 # Flatten any obvious string concatentation.
3990 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3991 $dstat =~ s/$Ident\s*("X*")/$1/)
3992 {
3993 }
3994
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003995 my $exceptions = qr{
3996 $Declare|
3997 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003998 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003999 DECLARE_PER_CPU|
4000 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004001 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004002 union|
4003 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004004 \.$Ident\s*=\s*|
4005 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004006 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004007 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004008 if ($dstat ne '' &&
4009 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4010 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004011 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004012 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004013 $dstat !~ /$exceptions/ &&
4014 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004015 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004016 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004017 $dstat !~ /^for\s*$Constant$/ && # for (...)
4018 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4019 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004020 $dstat !~ /^\({/ && # ({...
4021 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004022 {
4023 $ctx =~ s/\n*$//;
4024 my $herectx = $here . "\n";
4025 my $cnt = statement_rawlines($ctx);
4026
4027 for (my $n = 0; $n < $cnt; $n++) {
4028 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004029 }
4030
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004031 if ($dstat =~ /;/) {
4032 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4033 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4034 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004035 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004036 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004037 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004038 }
Joe Perches5023d342012-12-17 16:01:47 -08004039
Joe Perches481eb482012-12-17 16:01:56 -08004040# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004041
4042 } else {
4043 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004044 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4045 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004046 $line =~ /^\+.*\\$/) {
4047 WARN("LINE_CONTINUATIONS",
4048 "Avoid unnecessary line continuations\n" . $herecurr);
4049 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004050 }
4051
Joe Perchesb13edf72012-07-30 14:41:24 -07004052# do {} while (0) macro tests:
4053# single-statement macros do not need to be enclosed in do while (0) loop,
4054# macro should not end with a semicolon
4055 if ($^V && $^V ge 5.10.0 &&
4056 $realfile !~ m@/vmlinux.lds.h$@ &&
4057 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4058 my $ln = $linenr;
4059 my $cnt = $realcnt;
4060 my ($off, $dstat, $dcond, $rest);
4061 my $ctx = '';
4062 ($dstat, $dcond, $ln, $cnt, $off) =
4063 ctx_statement_block($linenr, $realcnt, 0);
4064 $ctx = $dstat;
4065
4066 $dstat =~ s/\\\n.//g;
4067
4068 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4069 my $stmts = $2;
4070 my $semis = $3;
4071
4072 $ctx =~ s/\n*$//;
4073 my $cnt = statement_rawlines($ctx);
4074 my $herectx = $here . "\n";
4075
4076 for (my $n = 0; $n < $cnt; $n++) {
4077 $herectx .= raw_line($linenr, $n) . "\n";
4078 }
4079
Joe Perchesac8e97f2012-08-21 16:15:53 -07004080 if (($stmts =~ tr/;/;/) == 1 &&
4081 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004082 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4083 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4084 }
4085 if (defined $semis && $semis ne "") {
4086 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4087 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4088 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004089 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4090 $ctx =~ s/\n*$//;
4091 my $cnt = statement_rawlines($ctx);
4092 my $herectx = $here . "\n";
4093
4094 for (my $n = 0; $n < $cnt; $n++) {
4095 $herectx .= raw_line($linenr, $n) . "\n";
4096 }
4097
4098 WARN("TRAILING_SEMICOLON",
4099 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004100 }
4101 }
4102
Mike Frysinger080ba922009-01-06 14:41:25 -08004103# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4104# all assignments may have only one of the following with an assignment:
4105# .
4106# ALIGN(...)
4107# VMLINUX_SYMBOL(...)
4108 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004109 WARN("MISSING_VMLINUX_SYMBOL",
4110 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004111 }
4112
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004113# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004114 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4115 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004116 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004117 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004118 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4119 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004120 my @allowed = ();
4121 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004122 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004123 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004124 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004125 for my $chunk (@chunks) {
4126 my ($cond, $block) = @{$chunk};
4127
Andy Whitcroft773647a2008-03-28 14:15:58 -07004128 # If the condition carries leading newlines, then count those as offsets.
4129 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4130 my $offset = statement_rawlines($whitespace) - 1;
4131
Joe Perchesaad4f612012-03-23 15:02:19 -07004132 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004133 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4134
4135 # We have looked at and allowed this specific line.
4136 $suppress_ifbraces{$ln + $offset} = 1;
4137
4138 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004139 $ln += statement_rawlines($block) - 1;
4140
Andy Whitcroft773647a2008-03-28 14:15:58 -07004141 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004142
4143 $seen++ if ($block =~ /^\s*{/);
4144
Joe Perchesaad4f612012-03-23 15:02:19 -07004145 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004146 if (statement_lines($cond) > 1) {
4147 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004148 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004149 }
4150 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004151 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004152 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004153 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004154 if (statement_block_size($block) > 1) {
4155 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004156 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004157 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004158 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004159 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004160 if ($seen) {
4161 my $sum_allowed = 0;
4162 foreach (@allowed) {
4163 $sum_allowed += $_;
4164 }
4165 if ($sum_allowed == 0) {
4166 WARN("BRACES",
4167 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4168 } elsif ($sum_allowed != $allow &&
4169 $seen != $allow) {
4170 CHK("BRACES",
4171 "braces {} should be used on all arms of this statement\n" . $herectx);
4172 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004173 }
4174 }
4175 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004176 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004177 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004178 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004179
Andy Whitcroftcf655042008-03-04 14:28:20 -08004180 # Check the pre-context.
4181 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4182 #print "APW: ALLOWED: pre<$1>\n";
4183 $allowed = 1;
4184 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004185
4186 my ($level, $endln, @chunks) =
4187 ctx_statement_full($linenr, $realcnt, $-[0]);
4188
Andy Whitcroftcf655042008-03-04 14:28:20 -08004189 # Check the condition.
4190 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004191 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004192 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004193 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004194 }
4195 if (statement_lines($cond) > 1) {
4196 #print "APW: ALLOWED: cond<$cond>\n";
4197 $allowed = 1;
4198 }
4199 if ($block =~/\b(?:if|for|while)\b/) {
4200 #print "APW: ALLOWED: block<$block>\n";
4201 $allowed = 1;
4202 }
4203 if (statement_block_size($block) > 1) {
4204 #print "APW: ALLOWED: lines block<$block>\n";
4205 $allowed = 1;
4206 }
4207 # Check the post-context.
4208 if (defined $chunks[1]) {
4209 my ($cond, $block) = @{$chunks[1]};
4210 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004211 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004212 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004213 if ($block =~ /^\s*\{/) {
4214 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4215 $allowed = 1;
4216 }
4217 }
4218 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004219 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004220 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004221
Andy Whitcroftf0556632008-10-15 22:02:23 -07004222 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004223 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004224 }
4225
Joe Perches000d1cc12011-07-25 17:13:25 -07004226 WARN("BRACES",
4227 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004228 }
4229 }
4230
Joe Perches0979ae62012-12-17 16:01:59 -08004231# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004232 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004233 CHK("BRACES",
4234 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4235 }
Joe Perches77b9a532013-07-03 15:05:29 -07004236 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004237 CHK("BRACES",
4238 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4239 }
4240
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004241# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004242 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4243 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004244 WARN("VOLATILE",
4245 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004246 }
4247
Andy Whitcroft00df3442007-06-08 13:47:06 -07004248# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004249 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004250 CHK("REDUNDANT_CODE",
4251 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004252 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004253 }
4254
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004255# check for needless "if (<foo>) fn(<foo>)" uses
4256 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4257 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4258 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4259 WARN('NEEDLESS_IF',
4260 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004261 }
4262 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004263
Joe Perchesebfdc402014-08-06 16:10:27 -07004264# check for unnecessary "Out of Memory" messages
4265 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4266 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4267 (defined $1 || defined $3) &&
4268 $linenr > 3) {
4269 my $testval = $2;
4270 my $testline = $lines[$linenr - 3];
4271
4272 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4273# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4274
4275 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4276 WARN("OOM_MESSAGE",
4277 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4278 }
4279 }
4280
Joe Perches8716de32013-09-11 14:24:05 -07004281# check for bad placement of section $InitAttribute (e.g.: __initdata)
4282 if ($line =~ /(\b$InitAttribute\b)/) {
4283 my $attr = $1;
4284 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4285 my $ptr = $1;
4286 my $var = $2;
4287 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4288 ERROR("MISPLACED_INIT",
4289 "$attr should be placed after $var\n" . $herecurr)) ||
4290 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4291 WARN("MISPLACED_INIT",
4292 "$attr should be placed after $var\n" . $herecurr))) &&
4293 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004294 $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 -07004295 }
4296 }
4297 }
4298
Joe Perchese970b882013-11-12 15:10:10 -08004299# check for $InitAttributeData (ie: __initdata) with const
4300 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4301 my $attr = $1;
4302 $attr =~ /($InitAttributePrefix)(.*)/;
4303 my $attr_prefix = $1;
4304 my $attr_type = $2;
4305 if (ERROR("INIT_ATTRIBUTE",
4306 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4307 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004308 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004309 s/$InitAttributeData/${attr_prefix}initconst/;
4310 }
4311 }
4312
4313# check for $InitAttributeConst (ie: __initconst) without const
4314 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4315 my $attr = $1;
4316 if (ERROR("INIT_ATTRIBUTE",
4317 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4318 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004319 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004320 /(^\+\s*(?:static\s+))/;
4321 $lead = rtrim($1);
4322 $lead = "$lead " if ($lead !~ /^\+$/);
4323 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004324 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08004325 }
4326 }
4327
Joe Perchesfbdb8132014-04-03 14:49:14 -07004328# don't use __constant_<foo> functions outside of include/uapi/
4329 if ($realfile !~ m@^include/uapi/@ &&
4330 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4331 my $constant_func = $1;
4332 my $func = $constant_func;
4333 $func =~ s/^__constant_//;
4334 if (WARN("CONSTANT_CONVERSION",
4335 "$constant_func should be $func\n" . $herecurr) &&
4336 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004337 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004338 }
4339 }
4340
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004341# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004342 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004343 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004344 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004345 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004346 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004347 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4348 }
4349 if ($delay > 2000) {
4350 WARN("LONG_UDELAY",
4351 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004352 }
4353 }
4354
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004355# warn about unexpectedly long msleep's
4356 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4357 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004358 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004359 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004360 }
4361 }
4362
Joe Perches36ec1932013-07-03 15:05:25 -07004363# check for comparisons of jiffies
4364 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4365 WARN("JIFFIES_COMPARISON",
4366 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4367 }
4368
Joe Perches9d7a34a2013-07-03 15:05:26 -07004369# check for comparisons of get_jiffies_64()
4370 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4371 WARN("JIFFIES_COMPARISON",
4372 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4373 }
4374
Andy Whitcroft00df3442007-06-08 13:47:06 -07004375# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004376# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004377# print "#ifdef in C files should be avoided\n";
4378# print "$herecurr";
4379# $clean = 0;
4380# }
4381
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004382# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004383 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004384 if (ERROR("SPACING",
4385 "exactly one space required after that #$1\n" . $herecurr) &&
4386 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004387 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004388 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4389 }
4390
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004391 }
4392
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004393# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004394 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4395 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004396 my $which = $1;
4397 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004398 CHK("UNCOMMENTED_DEFINITION",
4399 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004400 }
4401 }
4402# check for memory barriers without a comment.
4403 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4404 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004405 WARN("MEMORY_BARRIER",
4406 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004407 }
4408 }
4409# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004410 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004411 CHK("ARCH_DEFINES",
4412 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004413 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004414
Tobias Klauserd4977c72010-05-24 14:33:30 -07004415# Check that the storage class is at the beginning of a declaration
4416 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004417 WARN("STORAGE_CLASS",
4418 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004419 }
4420
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004421# check the location of the inline attribute, that it is between
4422# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004423 if ($line =~ /\b$Type\s+$Inline\b/ ||
4424 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004425 ERROR("INLINE_LOCATION",
4426 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004427 }
4428
Andy Whitcroft8905a672007-11-28 16:21:06 -08004429# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004430 if ($realfile !~ m@\binclude/uapi/@ &&
4431 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004432 if (WARN("INLINE",
4433 "plain inline is preferred over $1\n" . $herecurr) &&
4434 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004435 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004436
4437 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004438 }
4439
Joe Perches3d130fd2011-01-12 17:00:00 -08004440# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004441 if ($realfile !~ m@\binclude/uapi/@ &&
4442 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004443 WARN("PREFER_PACKED",
4444 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004445 }
4446
Joe Perches39b7e282011-07-25 17:13:24 -07004447# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004448 if ($realfile !~ m@\binclude/uapi/@ &&
4449 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004450 WARN("PREFER_ALIGNED",
4451 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004452 }
4453
Joe Perches5f14d3b2012-01-10 15:09:52 -08004454# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004455 if ($realfile !~ m@\binclude/uapi/@ &&
4456 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004457 if (WARN("PREFER_PRINTF",
4458 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4459 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004460 $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 -07004461
4462 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004463 }
4464
Joe Perches6061d942012-03-23 15:02:16 -07004465# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004466 if ($realfile !~ m@\binclude/uapi/@ &&
4467 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004468 if (WARN("PREFER_SCANF",
4469 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4470 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004471 $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 -07004472 }
Joe Perches6061d942012-03-23 15:02:16 -07004473 }
4474
Joe Perches8f53a9b2010-03-05 13:43:48 -08004475# check for sizeof(&)
4476 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004477 WARN("SIZEOF_ADDRESS",
4478 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004479 }
4480
Joe Perches66c80b62012-07-30 14:41:22 -07004481# check for sizeof without parenthesis
4482 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004483 if (WARN("SIZEOF_PARENTHESIS",
4484 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4485 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004486 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004487 }
Joe Perches66c80b62012-07-30 14:41:22 -07004488 }
4489
Joe Perches428e2fd2011-05-24 17:13:39 -07004490# check for line continuations in quoted strings with odd counts of "
4491 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004492 WARN("LINE_CONTINUATIONS",
4493 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004494 }
4495
Joe Perches88982fe2012-12-17 16:02:00 -08004496# check for struct spinlock declarations
4497 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4498 WARN("USE_SPINLOCK_T",
4499 "struct spinlock should be spinlock_t\n" . $herecurr);
4500 }
4501
Joe Perchesa6962d72013-04-29 16:18:13 -07004502# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004503 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004504 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004505 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004506 if (WARN("PREFER_SEQ_PUTS",
4507 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4508 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004509 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004510 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004511 }
4512 }
4513
Andy Whitcroft554e1652012-01-10 15:09:57 -08004514# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004515 if ($^V && $^V ge 5.10.0 &&
4516 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004517 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004518
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004519 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004520 my $ms_val = $7;
4521 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004522
Andy Whitcroft554e1652012-01-10 15:09:57 -08004523 if ($ms_size =~ /^(0x|)0$/i) {
4524 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004525 "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 -08004526 } elsif ($ms_size =~ /^(0x|)1$/i) {
4527 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004528 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4529 }
4530 }
4531
Joe Perches98a9bba2014-01-23 15:54:52 -08004532# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4533 if ($^V && $^V ge 5.10.0 &&
4534 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4535 if (WARN("PREFER_ETHER_ADDR_COPY",
4536 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4537 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004538 $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 -08004539 }
4540 }
4541
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004542# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004543 if ($^V && $^V ge 5.10.0 &&
4544 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004545 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004546 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004547 my $call = $1;
4548 my $cast1 = deparenthesize($2);
4549 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004550 my $cast2 = deparenthesize($7);
4551 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004552 my $cast;
4553
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004554 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004555 $cast = "$cast1 or $cast2";
4556 } elsif ($cast1 ne "") {
4557 $cast = $cast1;
4558 } else {
4559 $cast = $cast2;
4560 }
4561 WARN("MINMAX",
4562 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004563 }
4564 }
4565
Joe Perches4a273192012-07-30 14:41:20 -07004566# check usleep_range arguments
4567 if ($^V && $^V ge 5.10.0 &&
4568 defined $stat &&
4569 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4570 my $min = $1;
4571 my $max = $7;
4572 if ($min eq $max) {
4573 WARN("USLEEP_RANGE",
4574 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4575 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4576 $min > $max) {
4577 WARN("USLEEP_RANGE",
4578 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4579 }
4580 }
4581
Joe Perches823b7942013-11-12 15:10:15 -08004582# check for naked sscanf
4583 if ($^V && $^V ge 5.10.0 &&
4584 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004585 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004586 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4587 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4588 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4589 my $lc = $stat =~ tr@\n@@;
4590 $lc = $lc + $linenr;
4591 my $stat_real = raw_line($linenr, 0);
4592 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4593 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4594 }
4595 WARN("NAKED_SSCANF",
4596 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4597 }
4598
Joe Perchesafc819a2014-06-04 16:12:08 -07004599# check for simple sscanf that should be kstrto<foo>
4600 if ($^V && $^V ge 5.10.0 &&
4601 defined $stat &&
4602 $line =~ /\bsscanf\b/) {
4603 my $lc = $stat =~ tr@\n@@;
4604 $lc = $lc + $linenr;
4605 my $stat_real = raw_line($linenr, 0);
4606 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4607 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4608 }
4609 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4610 my $format = $6;
4611 my $count = $format =~ tr@%@%@;
4612 if ($count == 1 &&
4613 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4614 WARN("SSCANF_TO_KSTRTO",
4615 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4616 }
4617 }
4618 }
4619
Joe Perches70dc8a42013-09-11 14:23:58 -07004620# check for new externs in .h files.
4621 if ($realfile =~ /\.h$/ &&
4622 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004623 if (CHK("AVOID_EXTERNS",
4624 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004625 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004626 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07004627 }
4628 }
4629
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004630# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004631 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004632 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004633 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004634 my $function_name = $1;
4635 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004636
4637 my $s = $stat;
4638 if (defined $cond) {
4639 substr($s, 0, length($cond), '');
4640 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004641 if ($s =~ /^\s*;/ &&
4642 $function_name ne 'uninitialized_var')
4643 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004644 WARN("AVOID_EXTERNS",
4645 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004646 }
4647
4648 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004649 WARN("FUNCTION_ARGUMENTS",
4650 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004651 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004652
4653 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4654 $stat =~ /^.\s*extern\s+/)
4655 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004656 WARN("AVOID_EXTERNS",
4657 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004658 }
4659
4660# checks for new __setup's
4661 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4662 my $name = $1;
4663
4664 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004665 CHK("UNDOCUMENTED_SETUP",
4666 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004667 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004668 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004669
4670# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004671 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004672 WARN("UNNECESSARY_CASTS",
4673 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004674 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004675
Joe Perchesa640d252013-07-03 15:05:21 -07004676# alloc style
4677# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4678 if ($^V && $^V ge 5.10.0 &&
4679 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4680 CHK("ALLOC_SIZEOF_STRUCT",
4681 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4682 }
4683
Joe Perches60a55362014-06-04 16:12:07 -07004684# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4685 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07004686 $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 -07004687 my $oldfunc = $3;
4688 my $a1 = $4;
4689 my $a2 = $10;
4690 my $newfunc = "kmalloc_array";
4691 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07004692 my $r1 = $a1;
4693 my $r2 = $a2;
4694 if ($a1 =~ /^sizeof\s*\S/) {
4695 $r1 = $a2;
4696 $r2 = $a1;
4697 }
4698 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4699 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07004700 if (WARN("ALLOC_WITH_MULTIPLY",
4701 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4702 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004703 $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 -07004704
4705 }
4706 }
4707 }
4708
Joe Perches972fdea2013-04-29 16:18:12 -07004709# check for krealloc arg reuse
4710 if ($^V && $^V ge 5.10.0 &&
4711 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4712 WARN("KREALLOC_ARG_REUSE",
4713 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4714 }
4715
Joe Perches5ce59ae2013-02-21 16:44:18 -08004716# check for alloc argument mismatch
4717 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4718 WARN("ALLOC_ARRAY_ARGS",
4719 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4720 }
4721
Joe Perchescaf2a542011-01-12 16:59:56 -08004722# check for multiple semicolons
4723 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004724 if (WARN("ONE_SEMICOLON",
4725 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4726 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004727 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004728 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004729 }
4730
Joe Perchesc34c09a2014-01-23 15:54:43 -08004731# check for case / default statements not preceeded by break/fallthrough/switch
4732 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4733 my $has_break = 0;
4734 my $has_statement = 0;
4735 my $count = 0;
4736 my $prevline = $linenr;
4737 while ($prevline > 1 && $count < 3 && !$has_break) {
4738 $prevline--;
4739 my $rline = $rawlines[$prevline - 1];
4740 my $fline = $lines[$prevline - 1];
4741 last if ($fline =~ /^\@\@/);
4742 next if ($fline =~ /^\-/);
4743 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4744 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4745 next if ($fline =~ /^.[\s$;]*$/);
4746 $has_statement = 1;
4747 $count++;
4748 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4749 }
4750 if (!$has_break && $has_statement) {
4751 WARN("MISSING_BREAK",
4752 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4753 }
4754 }
4755
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004756# check for switch/default statements without a break;
4757 if ($^V && $^V ge 5.10.0 &&
4758 defined $stat &&
4759 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4760 my $ctx = '';
4761 my $herectx = $here . "\n";
4762 my $cnt = statement_rawlines($stat);
4763 for (my $n = 0; $n < $cnt; $n++) {
4764 $herectx .= raw_line($linenr, $n) . "\n";
4765 }
4766 WARN("DEFAULT_NO_BREAK",
4767 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004768 }
4769
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004770# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004771 if ($line =~ /\b__FUNCTION__\b/) {
4772 if (WARN("USE_FUNC",
4773 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4774 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004775 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004776 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004777 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004778
Joe Perches2c924882012-03-23 15:02:20 -07004779# check for use of yield()
4780 if ($line =~ /\byield\s*\(\s*\)/) {
4781 WARN("YIELD",
4782 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4783 }
4784
Joe Perches179f8f42013-07-03 15:05:30 -07004785# check for comparisons against true and false
4786 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4787 my $lead = $1;
4788 my $arg = $2;
4789 my $test = $3;
4790 my $otype = $4;
4791 my $trail = $5;
4792 my $op = "!";
4793
4794 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4795
4796 my $type = lc($otype);
4797 if ($type =~ /^(?:true|false)$/) {
4798 if (("$test" eq "==" && "$type" eq "true") ||
4799 ("$test" eq "!=" && "$type" eq "false")) {
4800 $op = "";
4801 }
4802
4803 CHK("BOOL_COMPARISON",
4804 "Using comparison to $otype is error prone\n" . $herecurr);
4805
4806## maybe suggesting a correct construct would better
4807## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4808
4809 }
4810 }
4811
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004812# check for semaphores initialized locked
4813 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004814 WARN("CONSIDER_COMPLETION",
4815 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004816 }
Joe Perches6712d852012-03-23 15:02:20 -07004817
Joe Perches67d0a072011-10-31 17:13:10 -07004818# recommend kstrto* over simple_strto* and strict_strto*
4819 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004820 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004821 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004822 }
Joe Perches6712d852012-03-23 15:02:20 -07004823
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004824# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07004825 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004826 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004827 "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 -07004828 }
Joe Perches6712d852012-03-23 15:02:20 -07004829
Emese Revfy79404842010-03-05 13:43:53 -08004830# check for various ops structs, ensure they are const.
4831 my $struct_ops = qr{acpi_dock_ops|
4832 address_space_operations|
4833 backlight_ops|
4834 block_device_operations|
4835 dentry_operations|
4836 dev_pm_ops|
4837 dma_map_ops|
4838 extent_io_ops|
4839 file_lock_operations|
4840 file_operations|
4841 hv_ops|
4842 ide_dma_ops|
4843 intel_dvo_dev_ops|
4844 item_operations|
4845 iwl_ops|
4846 kgdb_arch|
4847 kgdb_io|
4848 kset_uevent_ops|
4849 lock_manager_operations|
4850 microcode_ops|
4851 mtrr_ops|
4852 neigh_ops|
4853 nlmsvc_binding|
4854 pci_raw_ops|
4855 pipe_buf_operations|
4856 platform_hibernation_ops|
4857 platform_suspend_ops|
4858 proto_ops|
4859 rpc_pipe_ops|
4860 seq_operations|
4861 snd_ac97_build_ops|
4862 soc_pcmcia_socket_ops|
4863 stacktrace_ops|
4864 sysfs_ops|
4865 tty_operations|
4866 usb_mon_operations|
4867 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004868 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004869 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004870 WARN("CONST_STRUCT",
4871 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004872 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004873 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004874
4875# use of NR_CPUS is usually wrong
4876# ignore definitions of NR_CPUS and usage to define arrays as likely right
4877 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004878 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4879 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004880 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4881 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4882 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004883 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004884 WARN("NR_CPUS",
4885 "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 -07004886 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004887
Joe Perches52ea8502013-11-12 15:10:09 -08004888# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4889 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4890 ERROR("DEFINE_ARCH_HAS",
4891 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4892 }
4893
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004894# check for %L{u,d,i} in strings
4895 my $string;
4896 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4897 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004898 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004899 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004900 WARN("PRINTF_L",
4901 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004902 last;
4903 }
4904 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004905
4906# whine mightly about in_atomic
4907 if ($line =~ /\bin_atomic\s*\(/) {
4908 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004909 ERROR("IN_ATOMIC",
4910 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004911 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004912 WARN("IN_ATOMIC",
4913 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004914 }
4915 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004916
4917# check for lockdep_set_novalidate_class
4918 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4919 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4920 if ($realfile !~ m@^kernel/lockdep@ &&
4921 $realfile !~ m@^include/linux/lockdep@ &&
4922 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004923 ERROR("LOCKDEP",
4924 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004925 }
4926 }
Dave Jones88f88312011-01-12 16:59:59 -08004927
4928 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4929 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004930 WARN("EXPORTED_WORLD_WRITABLE",
4931 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004932 }
Joe Perches24358802014-04-03 14:49:13 -07004933
Joe Perches515a2352014-04-03 14:49:24 -07004934# Mode permission misuses where it seems decimal should be octal
4935# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4936 if ($^V && $^V ge 5.10.0 &&
4937 $line =~ /$mode_perms_search/) {
4938 foreach my $entry (@mode_permission_funcs) {
4939 my $func = $entry->[0];
4940 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004941
Joe Perches515a2352014-04-03 14:49:24 -07004942 my $skip_args = "";
4943 if ($arg_pos > 1) {
4944 $arg_pos--;
4945 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4946 }
4947 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4948 if ($line =~ /$test/) {
4949 my $val = $1;
4950 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004951
Joe Perches515a2352014-04-03 14:49:24 -07004952 if ($val !~ /^0$/ &&
4953 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4954 length($val) ne 4)) {
4955 ERROR("NON_OCTAL_PERMISSIONS",
4956 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4957 }
Joe Perches24358802014-04-03 14:49:13 -07004958 }
4959 }
4960 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004961 }
4962
4963 # If we have no input at all, then there is nothing to report on
4964 # so just keep quiet.
4965 if ($#rawlines == -1) {
4966 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004967 }
4968
Andy Whitcroft8905a672007-11-28 16:21:06 -08004969 # In mailback mode only produce a report in the negative, for
4970 # things that appear to be patches.
4971 if ($mailback && ($clean == 1 || !$is_patch)) {
4972 exit(0);
4973 }
4974
4975 # This is not a patch, and we are are in 'no-patch' mode so
4976 # just keep quiet.
4977 if (!$chk_patch && !$is_patch) {
4978 exit(0);
4979 }
4980
4981 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004982 ERROR("NOT_UNIFIED_DIFF",
4983 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004984 }
4985 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004986 ERROR("MISSING_SIGN_OFF",
4987 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004988 }
4989
Andy Whitcroft8905a672007-11-28 16:21:06 -08004990 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004991 if ($summary && !($clean == 1 && $quiet == 1)) {
4992 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004993 print "total: $cnt_error errors, $cnt_warn warnings, " .
4994 (($check)? "$cnt_chk checks, " : "") .
4995 "$cnt_lines lines checked\n";
4996 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004997 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004998
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004999 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005000
5001 if ($^V lt 5.10.0) {
5002 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5003 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5004 }
5005
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005006 # If there were whitespace errors which cleanpatch can fix
5007 # then suggest that.
5008 if ($rpt_cleaners) {
5009 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5010 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005011 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005012 }
5013 }
5014
Joe Perches91bfe482013-09-11 14:23:59 -07005015 hash_show_words(\%use_type, "Used");
5016 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005017
Joe Perchesd752fcc2014-08-06 16:11:05 -07005018 if ($clean == 0 && $fix &&
5019 ("@rawlines" ne "@fixed" ||
5020 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005021 my $newfile = $filename;
5022 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005023 my $linecount = 0;
5024 my $f;
5025
Joe Perchesd752fcc2014-08-06 16:11:05 -07005026 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5027
Joe Perches3705ce52013-07-03 15:05:31 -07005028 open($f, '>', $newfile)
5029 or die "$P: Can't open $newfile for write\n";
5030 foreach my $fixed_line (@fixed) {
5031 $linecount++;
5032 if ($file) {
5033 if ($linecount > 3) {
5034 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005035 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005036 }
5037 } else {
5038 print $f $fixed_line . "\n";
5039 }
5040 }
5041 close($f);
5042
5043 if (!$quiet) {
5044 print << "EOM";
5045Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5046
5047Do _NOT_ trust the results written to this file.
5048Do _NOT_ submit these changes without inspecting them for correctness.
5049
5050This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5051No warranties, expressed or implied...
5052
5053EOM
5054 }
5055 }
5056
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005057 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005058 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005059 }
5060 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005061 print << "EOM";
5062$vname has style problems, please review.
5063
5064If any of these errors are false positives, please report
5065them to the maintainer, see CHECKPATCH in MAINTAINERS.
5066EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005067 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005068
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005069 return $clean;
5070}