blob: f354ae619da06df0242c32a45380e105fe061343 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070027my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080028my $summary = 1;
29my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080030my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070031my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070032my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080033my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070034my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080035my %debug;
Joe Perches34456862013-07-03 15:05:34 -070036my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070037my %use_type = ();
38my @use = ();
39my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070040my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070041my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070042my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080043my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070044my $ignore_perl_version = 0;
45my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070046
47sub help {
48 my ($exitcode) = @_;
49
50 print << "EOM";
51Usage: $P [OPTION]... [FILE]...
52Version: $V
53
54Options:
55 -q, --quiet quiet
56 --no-tree run without a kernel tree
57 --no-signoff do not check for 'Signed-off-by' line
58 --patch treat FILE as patchfile (default)
59 --emacs emacs compile window format
60 --terse one line per report
61 -f, --file treat FILE as regular source file
62 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070063 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070064 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080065 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070066 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070067 --root=PATH PATH to the kernel tree root
68 --no-summary suppress the per-file summary
69 --mailback only produce a report in case of warnings/errors
70 --summary-file include the filename in summary
71 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
72 'values', 'possible', 'type', and 'attr' (default
73 is all off)
74 --test-only=WORD report only warnings/errors containing WORD
75 literally
Joe Perches3705ce52013-07-03 15:05:31 -070076 --fix EXPERIMENTAL - may create horrible results
77 If correctable single-line errors exist, create
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
80 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080081 --fix-inplace EXPERIMENTAL - may create horrible results
82 Is the same as --fix, but overwrites the input
83 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070084 --ignore-perl-version override checking of perl version. expect
85 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070086 -h, --help, --version display this help and exit
87
88When FILE is - read standard input.
89EOM
90
91 exit($exitcode);
92}
93
Joe Perches000d1cc12011-07-25 17:13:25 -070094my $conf = which_conf($configuration_file);
95if (-f $conf) {
96 my @conf_args;
97 open(my $conffile, '<', "$conf")
98 or warn "$P: Can't find a readable $configuration_file file $!\n";
99
100 while (<$conffile>) {
101 my $line = $_;
102
103 $line =~ s/\s*\n?$//g;
104 $line =~ s/^\s*//g;
105 $line =~ s/\s+/ /g;
106
107 next if ($line =~ m/^\s*#/);
108 next if ($line =~ m/^\s*$/);
109
110 my @words = split(" ", $line);
111 foreach my $word (@words) {
112 last if ($word =~ m/^#/);
113 push (@conf_args, $word);
114 }
115 }
116 close($conffile);
117 unshift(@ARGV, @conf_args) if @conf_args;
118}
119
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700120GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700121 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700122 'tree!' => \$tree,
123 'signoff!' => \$chk_signoff,
124 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700125 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800126 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700127 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700128 'subjective!' => \$check,
129 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700130 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700131 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700132 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800133 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700134 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800135 'summary!' => \$summary,
136 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800137 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700138 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800139 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700140 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800141 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700142 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700143 'h|help' => \$help,
144 'version' => \$help
145) or help(1);
146
147help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700148
Joe Perches9624b8d2014-01-23 15:54:44 -0800149$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700150$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800151
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700152my $exit = 0;
153
Dave Hansend62a2012013-09-11 14:23:56 -0700154if ($^V && $^V lt $minimum_perl_version) {
155 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
156 if (!$ignore_perl_version) {
157 exit(1);
158 }
159}
160
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700161if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700162 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700163 exit(1);
164}
165
Joe Perches91bfe482013-09-11 14:23:59 -0700166sub hash_save_array_words {
167 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700168
Joe Perches91bfe482013-09-11 14:23:59 -0700169 my @array = split(/,/, join(',', @$arrayRef));
170 foreach my $word (@array) {
171 $word =~ s/\s*\n?$//g;
172 $word =~ s/^\s*//g;
173 $word =~ s/\s+/ /g;
174 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700175
Joe Perches91bfe482013-09-11 14:23:59 -0700176 next if ($word =~ m/^\s*#/);
177 next if ($word =~ m/^\s*$/);
178
179 $hashRef->{$word}++;
180 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700181}
182
Joe Perches91bfe482013-09-11 14:23:59 -0700183sub hash_show_words {
184 my ($hashRef, $prefix) = @_;
185
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700188 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700189 print " $word";
190 }
191 print "\n\n";
192 }
193}
194
195hash_save_array_words(\%ignore_type, \@ignore);
196hash_save_array_words(\%use_type, \@use);
197
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800198my $dbg_values = 0;
199my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700200my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700201my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800202for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800203 ## no critic
204 eval "\${dbg_$key} = '$debug{$key}';";
205 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800206}
207
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700208my $rpt_cleaners = 0;
209
Andy Whitcroft8905a672007-11-28 16:21:06 -0800210if ($terse) {
211 $emacs = 1;
212 $quiet++;
213}
214
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700215if ($tree) {
216 if (defined $root) {
217 if (!top_of_kernel_tree($root)) {
218 die "$P: $root: --root does not point at a valid tree\n";
219 }
220 } else {
221 if (top_of_kernel_tree('.')) {
222 $root = '.';
223 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
224 top_of_kernel_tree($1)) {
225 $root = $1;
226 }
227 }
228
229 if (!defined $root) {
230 print "Must be run from the top-level dir. of a kernel tree\n";
231 exit(2);
232 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700233}
234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235my $emitted_corrupt = 0;
236
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700237our $Ident = qr{
238 [A-Za-z_][A-Za-z\d_]*
239 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
240 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700241our $Storage = qr{extern|static|asmlinkage};
242our $Sparse = qr{
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800249 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700250 __ref|
251 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700252 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800253our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
254our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
255our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
256our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
257our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700258
Wolfram Sang52131292010-03-05 13:43:51 -0800259# Notes to $Attribute:
260# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261our $Attribute = qr{
262 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700277 __read_mostly|
278 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700279 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800282 ____cacheline_internodealigned_in_smp|
283 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700285our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700286our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700287our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
288our $Lval = qr{$Ident(?:$Member)*};
289
Joe Perches95e2c602013-07-03 15:05:20 -0700290our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
291our $Binary = qr{(?i)0b[01]+$Int_type?};
292our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
293our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700294our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800295our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
296our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
297our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800298our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700299our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800300our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700301our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c92013-07-03 15:05:31 -0700302our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303our $Operators = qr{
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c92013-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
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700438 (?:(?:\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
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700553$chk_signoff = 0 if ($file);
554
Andy Whitcroft00df3442007-06-08 13:47:06 -0700555my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800556my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700557my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800558my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700559for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800560 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700561 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800562 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700563 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800564 } elsif ($filename eq '-') {
565 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700566 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800567 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700568 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700569 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800570 if ($filename eq '-') {
571 $vname = 'Your patch';
572 } else {
573 $vname = $filename;
574 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800575 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700576 chomp;
577 push(@rawlines, $_);
578 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800579 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800580 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700581 $exit = 1;
582 }
583 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800584 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700585 @fixed = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700586}
587
588exit($exit);
589
590sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700591 my ($root) = @_;
592
593 my @tree_check = (
594 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
595 "README", "Documentation", "arch", "include", "drivers",
596 "fs", "init", "ipc", "kernel", "lib", "scripts",
597 );
598
599 foreach my $check (@tree_check) {
600 if (! -e $root . '/' . $check) {
601 return 0;
602 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700603 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700604 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700605}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700606
Joe Perches20112472011-07-25 17:13:23 -0700607sub parse_email {
608 my ($formatted_email) = @_;
609
610 my $name = "";
611 my $address = "";
612 my $comment = "";
613
614 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
615 $name = $1;
616 $address = $2;
617 $comment = $3 if defined $3;
618 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
619 $address = $1;
620 $comment = $2 if defined $2;
621 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
622 $address = $1;
623 $comment = $2 if defined $2;
624 $formatted_email =~ s/$address.*$//;
625 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700626 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700627 $name =~ s/^\"|\"$//g;
628 # If there's a name left after stripping spaces and
629 # leading quotes, and the address doesn't have both
630 # leading and trailing angle brackets, the address
631 # is invalid. ie:
632 # "joe smith joe@smith.com" bad
633 # "joe smith <joe@smith.com" bad
634 if ($name ne "" && $address !~ /^<[^>]+>$/) {
635 $name = "";
636 $address = "";
637 $comment = "";
638 }
639 }
640
Joe Perches3705ce52013-07-03 15:05:31 -0700641 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700642 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700643 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700644 $address =~ s/^\<|\>$//g;
645
646 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
647 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
648 $name = "\"$name\"";
649 }
650
651 return ($name, $address, $comment);
652}
653
654sub format_email {
655 my ($name, $address) = @_;
656
657 my $formatted_email;
658
Joe Perches3705ce52013-07-03 15:05:31 -0700659 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700660 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700661 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700662
663 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
664 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
665 $name = "\"$name\"";
666 }
667
668 if ("$name" eq "") {
669 $formatted_email = "$address";
670 } else {
671 $formatted_email = "$name <$address>";
672 }
673
674 return $formatted_email;
675}
676
Joe Perches000d1cc12011-07-25 17:13:25 -0700677sub which_conf {
678 my ($conf) = @_;
679
680 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
681 if (-e "$path/$conf") {
682 return "$path/$conf";
683 }
684 }
685
686 return "";
687}
688
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700689sub expand_tabs {
690 my ($str) = @_;
691
692 my $res = '';
693 my $n = 0;
694 for my $c (split(//, $str)) {
695 if ($c eq "\t") {
696 $res .= ' ';
697 $n++;
698 for (; ($n % 8) != 0; $n++) {
699 $res .= ' ';
700 }
701 next;
702 }
703 $res .= $c;
704 $n++;
705 }
706
707 return $res;
708}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700709sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700710 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700711 return $res;
712}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700713
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700714sub line_stats {
715 my ($line) = @_;
716
717 # Drop the diff line leader and expand tabs
718 $line =~ s/^.//;
719 $line = expand_tabs($line);
720
721 # Pick the indent from the front of the line.
722 my ($white) = ($line =~ /^(\s*)/);
723
724 return (length($line), length($white));
725}
726
Andy Whitcroft773647a2008-03-28 14:15:58 -0700727my $sanitise_quote = '';
728
729sub sanitise_line_reset {
730 my ($in_comment) = @_;
731
732 if ($in_comment) {
733 $sanitise_quote = '*/';
734 } else {
735 $sanitise_quote = '';
736 }
737}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700738sub sanitise_line {
739 my ($line) = @_;
740
741 my $res = '';
742 my $l = '';
743
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800744 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700745 my $off = 0;
746 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700747
Andy Whitcroft773647a2008-03-28 14:15:58 -0700748 # Always copy over the diff marker.
749 $res = substr($line, 0, 1);
750
751 for ($off = 1; $off < length($line); $off++) {
752 $c = substr($line, $off, 1);
753
754 # Comments we are wacking completly including the begin
755 # and end, all to $;.
756 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
757 $sanitise_quote = '*/';
758
759 substr($res, $off, 2, "$;$;");
760 $off++;
761 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800762 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700763 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700764 $sanitise_quote = '';
765 substr($res, $off, 2, "$;$;");
766 $off++;
767 next;
768 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700769 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
770 $sanitise_quote = '//';
771
772 substr($res, $off, 2, $sanitise_quote);
773 $off++;
774 next;
775 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700776
777 # A \ in a string means ignore the next character.
778 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
779 $c eq "\\") {
780 substr($res, $off, 2, 'XX');
781 $off++;
782 next;
783 }
784 # Regular quotes.
785 if ($c eq "'" || $c eq '"') {
786 if ($sanitise_quote eq '') {
787 $sanitise_quote = $c;
788
789 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700790 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700791 } elsif ($sanitise_quote eq $c) {
792 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700793 }
794 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700795
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800796 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700797 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
798 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700799 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
800 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700801 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
802 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700803 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700804 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700805 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800806 }
807
Daniel Walker113f04a2009-09-21 17:04:35 -0700808 if ($sanitise_quote eq '//') {
809 $sanitise_quote = '';
810 }
811
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800812 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700813 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800814 my $clean = 'X' x length($1);
815 $res =~ s@\<.*\>@<$clean>@;
816
817 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700818 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800819 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700820 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800821 }
822
Andy Whitcroft00df3442007-06-08 13:47:06 -0700823 return $res;
824}
825
Joe Perchesa6962d72013-04-29 16:18:13 -0700826sub get_quoted_string {
827 my ($line, $rawline) = @_;
828
829 return "" if ($line !~ m/(\"[X]+\")/g);
830 return substr($rawline, $-[0], $+[0] - $-[0]);
831}
832
Andy Whitcroft8905a672007-11-28 16:21:06 -0800833sub ctx_statement_block {
834 my ($linenr, $remain, $off) = @_;
835 my $line = $linenr - 1;
836 my $blk = '';
837 my $soff = $off;
838 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700839 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800840
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800841 my $loff = 0;
842
Andy Whitcroft8905a672007-11-28 16:21:06 -0800843 my $type = '';
844 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800845 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800846 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800847 my $c;
848 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800849
850 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800851 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800852 @stack = (['', 0]) if ($#stack == -1);
853
Andy Whitcroft773647a2008-03-28 14:15:58 -0700854 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800855 # If we are about to drop off the end, pull in more
856 # context.
857 if ($off >= $len) {
858 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700859 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800860 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800861 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800862 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800863 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800864 $len = length($blk);
865 $line++;
866 last;
867 }
868 # Bail if there is no further context.
869 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800870 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800871 last;
872 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800873 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
874 $level++;
875 $type = '#';
876 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800877 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800878 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800879 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800880 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800881
Andy Whitcroft773647a2008-03-28 14:15:58 -0700882 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800883
884 # Handle nested #if/#else.
885 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
886 push(@stack, [ $type, $level ]);
887 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
888 ($type, $level) = @{$stack[$#stack - 1]};
889 } elsif ($remainder =~ /^#\s*endif\b/) {
890 ($type, $level) = @{pop(@stack)};
891 }
892
Andy Whitcroft8905a672007-11-28 16:21:06 -0800893 # Statement ends at the ';' or a close '}' at the
894 # outermost level.
895 if ($level == 0 && $c eq ';') {
896 last;
897 }
898
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800899 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700900 if ($level == 0 && $coff_set == 0 &&
901 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
902 $remainder =~ /^(else)(?:\s|{)/ &&
903 $remainder !~ /^else\s+if\b/) {
904 $coff = $off + length($1) - 1;
905 $coff_set = 1;
906 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
907 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800908 }
909
Andy Whitcroft8905a672007-11-28 16:21:06 -0800910 if (($type eq '' || $type eq '(') && $c eq '(') {
911 $level++;
912 $type = '(';
913 }
914 if ($type eq '(' && $c eq ')') {
915 $level--;
916 $type = ($level != 0)? '(' : '';
917
918 if ($level == 0 && $coff < $soff) {
919 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700920 $coff_set = 1;
921 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800922 }
923 }
924 if (($type eq '' || $type eq '{') && $c eq '{') {
925 $level++;
926 $type = '{';
927 }
928 if ($type eq '{' && $c eq '}') {
929 $level--;
930 $type = ($level != 0)? '{' : '';
931
932 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700933 if (substr($blk, $off + 1, 1) eq ';') {
934 $off++;
935 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800936 last;
937 }
938 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800939 # Preprocessor commands end at the newline unless escaped.
940 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
941 $level--;
942 $type = '';
943 $off++;
944 last;
945 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800946 $off++;
947 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700948 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800949 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700950 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800951 $line++;
952 $remain--;
953 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800954
955 my $statement = substr($blk, $soff, $off - $soff + 1);
956 my $condition = substr($blk, $soff, $coff - $soff + 1);
957
958 #warn "STATEMENT<$statement>\n";
959 #warn "CONDITION<$condition>\n";
960
Andy Whitcroft773647a2008-03-28 14:15:58 -0700961 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800962
963 return ($statement, $condition,
964 $line, $remain + 1, $off - $loff + 1, $level);
965}
966
Andy Whitcroftcf655042008-03-04 14:28:20 -0800967sub statement_lines {
968 my ($stmt) = @_;
969
970 # Strip the diff line prefixes and rip blank lines at start and end.
971 $stmt =~ s/(^|\n)./$1/g;
972 $stmt =~ s/^\s*//;
973 $stmt =~ s/\s*$//;
974
975 my @stmt_lines = ($stmt =~ /\n/g);
976
977 return $#stmt_lines + 2;
978}
979
980sub statement_rawlines {
981 my ($stmt) = @_;
982
983 my @stmt_lines = ($stmt =~ /\n/g);
984
985 return $#stmt_lines + 2;
986}
987
988sub statement_block_size {
989 my ($stmt) = @_;
990
991 $stmt =~ s/(^|\n)./$1/g;
992 $stmt =~ s/^\s*{//;
993 $stmt =~ s/}\s*$//;
994 $stmt =~ s/^\s*//;
995 $stmt =~ s/\s*$//;
996
997 my @stmt_lines = ($stmt =~ /\n/g);
998 my @stmt_statements = ($stmt =~ /;/g);
999
1000 my $stmt_lines = $#stmt_lines + 2;
1001 my $stmt_statements = $#stmt_statements + 1;
1002
1003 if ($stmt_lines > $stmt_statements) {
1004 return $stmt_lines;
1005 } else {
1006 return $stmt_statements;
1007 }
1008}
1009
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001010sub ctx_statement_full {
1011 my ($linenr, $remain, $off) = @_;
1012 my ($statement, $condition, $level);
1013
1014 my (@chunks);
1015
Andy Whitcroftcf655042008-03-04 14:28:20 -08001016 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001017 ($statement, $condition, $linenr, $remain, $off, $level) =
1018 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001019 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001020 push(@chunks, [ $condition, $statement ]);
1021 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1022 return ($level, $linenr, @chunks);
1023 }
1024
1025 # Pull in the following conditional/block pairs and see if they
1026 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001027 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001028 ($statement, $condition, $linenr, $remain, $off, $level) =
1029 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001030 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001031 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001032 #print "C: push\n";
1033 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001034 }
1035
1036 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001037}
1038
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001039sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001040 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001041 my $line;
1042 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001043 my $blk = '';
1044 my @o;
1045 my @c;
1046 my @res = ();
1047
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001048 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001049 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001050 for ($line = $start; $remain > 0; $line++) {
1051 next if ($rawlines[$line] =~ /^-/);
1052 $remain--;
1053
1054 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001055
1056 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001057 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001058 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001059 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001060 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001061 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001062 $level = pop(@stack);
1063 }
1064
Andy Whitcroft01464f32010-10-26 14:23:19 -07001065 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001066 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1067 if ($off > 0) {
1068 $off--;
1069 next;
1070 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001071
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001072 if ($c eq $close && $level > 0) {
1073 $level--;
1074 last if ($level == 0);
1075 } elsif ($c eq $open) {
1076 $level++;
1077 }
1078 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001079
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001080 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001081 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001082 }
1083
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001084 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001085 }
1086
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001087 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001088}
1089sub ctx_block_outer {
1090 my ($linenr, $remain) = @_;
1091
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001092 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1093 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001094}
1095sub ctx_block {
1096 my ($linenr, $remain) = @_;
1097
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001098 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1099 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001100}
1101sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001102 my ($linenr, $remain, $off) = @_;
1103
1104 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1105 return @r;
1106}
1107sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001108 my ($linenr, $remain) = @_;
1109
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001110 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001111}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001112sub ctx_statement_level {
1113 my ($linenr, $remain, $off) = @_;
1114
1115 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1116}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001117
1118sub ctx_locate_comment {
1119 my ($first_line, $end_line) = @_;
1120
1121 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001122 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001123 return $current_comment if (defined $current_comment);
1124
1125 # Look through the context and try and figure out if there is a
1126 # comment.
1127 my $in_comment = 0;
1128 $current_comment = '';
1129 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001130 my $line = $rawlines[$linenr - 1];
1131 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001132 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1133 $in_comment = 1;
1134 }
1135 if ($line =~ m@/\*@) {
1136 $in_comment = 1;
1137 }
1138 if (!$in_comment && $current_comment ne '') {
1139 $current_comment = '';
1140 }
1141 $current_comment .= $line . "\n" if ($in_comment);
1142 if ($line =~ m@\*/@) {
1143 $in_comment = 0;
1144 }
1145 }
1146
1147 chomp($current_comment);
1148 return($current_comment);
1149}
1150sub ctx_has_comment {
1151 my ($first_line, $end_line) = @_;
1152 my $cmt = ctx_locate_comment($first_line, $end_line);
1153
Andy Whitcroft00df3442007-06-08 13:47:06 -07001154 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001155 ##print "CMMT: $cmt\n";
1156
1157 return ($cmt ne '');
1158}
1159
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001160sub raw_line {
1161 my ($linenr, $cnt) = @_;
1162
1163 my $offset = $linenr - 1;
1164 $cnt++;
1165
1166 my $line;
1167 while ($cnt) {
1168 $line = $rawlines[$offset++];
1169 next if (defined($line) && $line =~ /^-/);
1170 $cnt--;
1171 }
1172
1173 return $line;
1174}
1175
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001176sub cat_vet {
1177 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001178 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001179
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001180 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001181 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1182 $res .= $1;
1183 if ($2 ne '') {
1184 $coded = sprintf("^%c", unpack('C', $2) + 64);
1185 $res .= $coded;
1186 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001187 }
1188 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001189
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001190 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001191}
1192
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001193my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001194my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001195my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001196my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001197
1198sub annotate_reset {
1199 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001200 $av_pending = '_';
1201 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001202 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203}
1204
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001205sub annotate_values {
1206 my ($stream, $type) = @_;
1207
1208 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001209 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001210 my $cur = $stream;
1211
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001212 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001213
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001214 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001215 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001216 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001217 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001218 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001219 print "WS($1)\n" if ($dbg_values > 1);
1220 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001221 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001222 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001223 }
1224
Florian Micklerc023e4732011-01-12 16:59:58 -08001225 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001226 print "CAST($1)\n" if ($dbg_values > 1);
1227 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001228 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001229
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001230 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001231 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001232 $type = 'T';
1233
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001234 } elsif ($cur =~ /^($Modifier)\s*/) {
1235 print "MODIFIER($1)\n" if ($dbg_values > 1);
1236 $type = 'T';
1237
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001238 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001239 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001240 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001241 push(@av_paren_type, $type);
1242 if ($2 ne '') {
1243 $av_pending = 'N';
1244 }
1245 $type = 'E';
1246
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001247 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001248 print "UNDEF($1)\n" if ($dbg_values > 1);
1249 $av_preprocessor = 1;
1250 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001251
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001252 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001253 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001254 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001255
1256 push(@av_paren_type, $type);
1257 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001258 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001259
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001260 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001261 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1262 $av_preprocessor = 1;
1263
1264 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1265
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001266 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001267
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001268 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001269 print "PRE_END($1)\n" if ($dbg_values > 1);
1270
1271 $av_preprocessor = 1;
1272
1273 # Assume all arms of the conditional end as this
1274 # one does, and continue as if the #endif was not here.
1275 pop(@av_paren_type);
1276 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001277 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001278
1279 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001280 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001281
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001282 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1283 print "ATTR($1)\n" if ($dbg_values > 1);
1284 $av_pending = $type;
1285 $type = 'N';
1286
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001287 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001288 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001289 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001290 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001291 }
1292 $type = 'N';
1293
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001294 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001295 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001296 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001297 $type = 'N';
1298
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001299 } elsif ($cur =~/^(case)/o) {
1300 print "CASE($1)\n" if ($dbg_values > 1);
1301 $av_pend_colon = 'C';
1302 $type = 'N';
1303
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001304 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001305 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001306 $type = 'N';
1307
1308 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001309 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001310 push(@av_paren_type, $av_pending);
1311 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001312 $type = 'N';
1313
1314 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001315 my $new_type = pop(@av_paren_type);
1316 if ($new_type ne '_') {
1317 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001318 print "PAREN('$1') -> $type\n"
1319 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001320 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001321 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001322 }
1323
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001324 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001325 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001326 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001327 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001328
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001329 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1330 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001331 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001332 } elsif ($type eq 'E') {
1333 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001334 }
1335 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1336 $type = 'V';
1337
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001338 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001339 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001340 $type = 'V';
1341
1342 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001343 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001344 $type = 'N';
1345
Andy Whitcroftcf655042008-03-04 14:28:20 -08001346 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001347 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001348 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001349 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001350
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001351 } elsif ($cur =~/^(,)/) {
1352 print "COMMA($1)\n" if ($dbg_values > 1);
1353 $type = 'C';
1354
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001355 } elsif ($cur =~ /^(\?)/o) {
1356 print "QUESTION($1)\n" if ($dbg_values > 1);
1357 $type = 'N';
1358
1359 } elsif ($cur =~ /^(:)/o) {
1360 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1361
1362 substr($var, length($res), 1, $av_pend_colon);
1363 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1364 $type = 'E';
1365 } else {
1366 $type = 'N';
1367 }
1368 $av_pend_colon = 'O';
1369
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001370 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001371 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001372 $type = 'N';
1373
Andy Whitcroft0d413862008-10-15 22:02:16 -07001374 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001375 my $variant;
1376
1377 print "OPV($1)\n" if ($dbg_values > 1);
1378 if ($type eq 'V') {
1379 $variant = 'B';
1380 } else {
1381 $variant = 'U';
1382 }
1383
1384 substr($var, length($res), 1, $variant);
1385 $type = 'N';
1386
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001387 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001388 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001389 if ($1 ne '++' && $1 ne '--') {
1390 $type = 'N';
1391 }
1392
1393 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001394 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001395 }
1396 if (defined $1) {
1397 $cur = substr($cur, length($1));
1398 $res .= $type x length($1);
1399 }
1400 }
1401
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001402 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001403}
1404
Andy Whitcroft8905a672007-11-28 16:21:06 -08001405sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001406 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001407 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001408 ^(?:
1409 $Modifier|
1410 $Storage|
1411 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001412 DEFINE_\S+
1413 )$|
1414 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001415 goto|
1416 return|
1417 case|
1418 else|
1419 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001420 do|
1421 \#|
1422 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001423 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001424 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001425 )}x;
1426 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1427 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001428 # Check for modifiers.
1429 $possible =~ s/\s*$Storage\s*//g;
1430 $possible =~ s/\s*$Sparse\s*//g;
1431 if ($possible =~ /^\s*$/) {
1432
1433 } elsif ($possible =~ /\s/) {
1434 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001435 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001436 if ($modifier !~ $notPermitted) {
1437 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1438 push(@modifierList, $modifier);
1439 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001440 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001441
1442 } else {
1443 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1444 push(@typeList, $possible);
1445 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001446 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001447 } else {
1448 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001449 }
1450}
1451
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001452my $prefix = '';
1453
Joe Perches000d1cc12011-07-25 17:13:25 -07001454sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001455 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001456
Joe Perchescbec18a2014-04-03 14:49:19 -07001457 return defined $use_type{$type} if (scalar keys %use_type > 0);
1458
1459 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001460}
1461
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001462sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001463 my ($level, $type, $msg) = @_;
1464
1465 if (!show_type($type) ||
1466 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001467 return 0;
1468 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001469 my $line;
1470 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001471 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001472 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001473 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001474 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001475 $line = (split('\n', $line))[0] . "\n" if ($terse);
1476
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001477 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001478
1479 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001480}
Joe Perchescbec18a2014-04-03 14:49:19 -07001481
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001482sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001483 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001484}
Joe Perches000d1cc12011-07-25 17:13:25 -07001485
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001486sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001487 my ($type, $msg) = @_;
1488
1489 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001490 our $clean = 0;
1491 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001492 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001493 }
Joe Perches3705ce52013-07-03 15:05:31 -07001494 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001495}
1496sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001497 my ($type, $msg) = @_;
1498
1499 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001500 our $clean = 0;
1501 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001502 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001503 }
Joe Perches3705ce52013-07-03 15:05:31 -07001504 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001505}
1506sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001507 my ($type, $msg) = @_;
1508
1509 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001510 our $clean = 0;
1511 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001512 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001513 }
Joe Perches3705ce52013-07-03 15:05:31 -07001514 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001515}
1516
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001517sub check_absolute_file {
1518 my ($absolute, $herecurr) = @_;
1519 my $file = $absolute;
1520
1521 ##print "absolute<$absolute>\n";
1522
1523 # See if any suffix of this path is a path within the tree.
1524 while ($file =~ s@^[^/]*/@@) {
1525 if (-f "$root/$file") {
1526 ##print "file<$file>\n";
1527 last;
1528 }
1529 }
1530 if (! -f _) {
1531 return 0;
1532 }
1533
1534 # It is, so see if the prefix is acceptable.
1535 my $prefix = $absolute;
1536 substr($prefix, -length($file)) = '';
1537
1538 ##print "prefix<$prefix>\n";
1539 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001540 WARN("USE_RELATIVE_PATH",
1541 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001542 }
1543}
1544
Joe Perches3705ce52013-07-03 15:05:31 -07001545sub trim {
1546 my ($string) = @_;
1547
Joe Perchesb34c6482013-09-11 14:24:01 -07001548 $string =~ s/^\s+|\s+$//g;
1549
1550 return $string;
1551}
1552
1553sub ltrim {
1554 my ($string) = @_;
1555
1556 $string =~ s/^\s+//;
1557
1558 return $string;
1559}
1560
1561sub rtrim {
1562 my ($string) = @_;
1563
1564 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001565
1566 return $string;
1567}
1568
Joe Perches52ea8502013-11-12 15:10:09 -08001569sub string_find_replace {
1570 my ($string, $find, $replace) = @_;
1571
1572 $string =~ s/$find/$replace/g;
1573
1574 return $string;
1575}
1576
Joe Perches3705ce52013-07-03 15:05:31 -07001577sub tabify {
1578 my ($leading) = @_;
1579
1580 my $source_indent = 8;
1581 my $max_spaces_before_tab = $source_indent - 1;
1582 my $spaces_to_tab = " " x $source_indent;
1583
1584 #convert leading spaces to tabs
1585 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1586 #Remove spaces before a tab
1587 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1588
1589 return "$leading";
1590}
1591
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001592sub pos_last_openparen {
1593 my ($line) = @_;
1594
1595 my $pos = 0;
1596
1597 my $opens = $line =~ tr/\(/\(/;
1598 my $closes = $line =~ tr/\)/\)/;
1599
1600 my $last_openparen = 0;
1601
1602 if (($opens == 0) || ($closes >= $opens)) {
1603 return -1;
1604 }
1605
1606 my $len = length($line);
1607
1608 for ($pos = 0; $pos < $len; $pos++) {
1609 my $string = substr($line, $pos);
1610 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1611 $pos += length($1) - 1;
1612 } elsif (substr($line, $pos, 1) eq '(') {
1613 $last_openparen = $pos;
1614 } elsif (index($string, '(') == -1) {
1615 last;
1616 }
1617 }
1618
Joe Perches91cb5192014-04-03 14:49:32 -07001619 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001620}
1621
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001622sub process {
1623 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001624
1625 my $linenr=0;
1626 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001627 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001628 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001629 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001630
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001631 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001632 my $indent;
1633 my $previndent=0;
1634 my $stashindent=0;
1635
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001636 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001637 my $signoff = 0;
1638 my $is_patch = 0;
1639
Joe Perches15662b32011-10-31 17:13:12 -07001640 my $in_header_lines = 1;
1641 my $in_commit_log = 0; #Scanning lines before patch
1642
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001643 my $non_utf8_charset = 0;
1644
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001645 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001646 our $cnt_lines = 0;
1647 our $cnt_error = 0;
1648 our $cnt_warn = 0;
1649 our $cnt_chk = 0;
1650
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001651 # Trace the real file/line as we go.
1652 my $realfile = '';
1653 my $realline = 0;
1654 my $realcnt = 0;
1655 my $here = '';
1656 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001657 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001658 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001659 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001660
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001661 my $prev_values = 'E';
1662
1663 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001664 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001665 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001666 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001667 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001668
Joe Perches7e51f192013-09-11 14:23:57 -07001669 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001670
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001671 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001672 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001673 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001674 my @setup_docs = ();
1675 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001676
Joe Perchesd8b07712013-11-12 15:10:06 -08001677 my $camelcase_file_seeded = 0;
1678
Andy Whitcroft773647a2008-03-28 14:15:58 -07001679 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001680 my $line;
1681 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001682 $linenr++;
1683 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001684
Joe Perches3705ce52013-07-03 15:05:31 -07001685 push(@fixed, $rawline) if ($fix);
1686
Andy Whitcroft773647a2008-03-28 14:15:58 -07001687 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001688 $setup_docs = 0;
1689 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1690 $setup_docs = 1;
1691 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001692 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001693 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001694 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1695 $realline=$1-1;
1696 if (defined $2) {
1697 $realcnt=$3+1;
1698 } else {
1699 $realcnt=1+1;
1700 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001701 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001702
1703 # Guestimate if this is a continuing comment. Run
1704 # the context looking for a comment "edge". If this
1705 # edge is a close comment then we must be in a comment
1706 # at context start.
1707 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001708 my $cnt = $realcnt;
1709 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1710 next if (defined $rawlines[$ln - 1] &&
1711 $rawlines[$ln - 1] =~ /^-/);
1712 $cnt--;
1713 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001714 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001715 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1716 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1717 ($edge) = $1;
1718 last;
1719 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001720 }
1721 if (defined $edge && $edge eq '*/') {
1722 $in_comment = 1;
1723 }
1724
1725 # Guestimate if this is a continuing comment. If this
1726 # is the start of a diff block and this line starts
1727 # ' *' then it is very likely a comment.
1728 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001729 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001730 {
1731 $in_comment = 1;
1732 }
1733
1734 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1735 sanitise_line_reset($in_comment);
1736
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001737 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001738 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001739 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001740 $line = sanitise_line($rawline);
1741 }
1742 push(@lines, $line);
1743
1744 if ($realcnt > 1) {
1745 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1746 } else {
1747 $realcnt = 0;
1748 }
1749
1750 #print "==>$rawline\n";
1751 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001752
1753 if ($setup_docs && $line =~ /^\+/) {
1754 push(@setup_docs, $line);
1755 }
1756 }
1757
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001758 $prefix = '';
1759
Andy Whitcroft773647a2008-03-28 14:15:58 -07001760 $realcnt = 0;
1761 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001762 foreach my $line (@lines) {
1763 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001764 my $sline = $line; #copy of $line
1765 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001766
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001767 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001768
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001769#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001770 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001771 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001772 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001773 $realline=$1-1;
1774 if (defined $2) {
1775 $realcnt=$3+1;
1776 } else {
1777 $realcnt=1+1;
1778 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001779 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001780 $prev_values = 'E';
1781
Andy Whitcroft773647a2008-03-28 14:15:58 -07001782 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001783 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001784 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001785 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001786 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001787
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001788# track the line number as we move through the hunk, note that
1789# new versions of GNU diff omit the leading space on completely
1790# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001791 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001792 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001793 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001794
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001795 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001796 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001797
1798 # Track the previous line.
1799 ($prevline, $stashline) = ($stashline, $line);
1800 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001801 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1802
Andy Whitcroft773647a2008-03-28 14:15:58 -07001803 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001804
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001805 } elsif ($realcnt == 1) {
1806 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001807 }
1808
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001809 my $hunk_line = ($realcnt != 0);
1810
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001811#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001812 $prefix = "$filename:$realline: " if ($emacs && $file);
1813 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1814
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001815 $here = "#$linenr: " if (!$file);
1816 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001818 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001819 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001820 if ($line =~ /^diff --git.*?(\S+)$/) {
1821 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001822 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001823 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001824 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001825 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001826 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001827 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001828 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001829
1830 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001831 if (!$file && $tree && $p1_prefix ne '' &&
1832 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001833 WARN("PATCH_PREFIX",
1834 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001835 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001836
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001837 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001838 ERROR("MODIFIED_INCLUDE_ASM",
1839 "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 -07001840 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001841 $found_file = 1;
1842 }
1843
1844 if ($found_file) {
1845 if ($realfile =~ m@^(drivers/net/|net/)@) {
1846 $check = 1;
1847 } else {
1848 $check = $check_orig;
1849 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001850 next;
1851 }
1852
Randy Dunlap389834b2007-06-08 13:47:03 -07001853 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001854
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001855 my $hereline = "$here\n$rawline\n";
1856 my $herecurr = "$here\n$rawline\n";
1857 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001858
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001859 $cnt_lines++ if ($realcnt != 0);
1860
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001861# Check for incorrect file permissions
1862 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1863 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001864 if ($realfile !~ m@scripts/@ &&
1865 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001866 ERROR("EXECUTE_PERMISSIONS",
1867 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001868 }
1869 }
1870
Joe Perches20112472011-07-25 17:13:23 -07001871# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001872 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001873 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001874 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001875 }
1876
1877# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001878 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001879 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001880 my $space_before = $1;
1881 my $sign_off = $2;
1882 my $space_after = $3;
1883 my $email = $4;
1884 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1885
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001886 if ($sign_off !~ /$signature_tags/) {
1887 WARN("BAD_SIGN_OFF",
1888 "Non-standard signature: $sign_off\n" . $herecurr);
1889 }
Joe Perches20112472011-07-25 17:13:23 -07001890 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001891 if (WARN("BAD_SIGN_OFF",
1892 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1893 $fix) {
1894 $fixed[$linenr - 1] =
1895 "$ucfirst_sign_off $email";
1896 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001897 }
Joe Perches20112472011-07-25 17:13:23 -07001898 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001899 if (WARN("BAD_SIGN_OFF",
1900 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1901 $fix) {
1902 $fixed[$linenr - 1] =
1903 "$ucfirst_sign_off $email";
1904 }
1905
Joe Perches20112472011-07-25 17:13:23 -07001906 }
1907 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001908 if (WARN("BAD_SIGN_OFF",
1909 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1910 $fix) {
1911 $fixed[$linenr - 1] =
1912 "$ucfirst_sign_off $email";
1913 }
Joe Perches20112472011-07-25 17:13:23 -07001914 }
1915
1916 my ($email_name, $email_address, $comment) = parse_email($email);
1917 my $suggested_email = format_email(($email_name, $email_address));
1918 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001919 ERROR("BAD_SIGN_OFF",
1920 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001921 } else {
1922 my $dequoted = $suggested_email;
1923 $dequoted =~ s/^"//;
1924 $dequoted =~ s/" </ </;
1925 # Don't force email to have quotes
1926 # Allow just an angle bracketed address
1927 if ("$dequoted$comment" ne $email &&
1928 "<$email_address>$comment" ne $email &&
1929 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001930 WARN("BAD_SIGN_OFF",
1931 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001932 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001933 }
Joe Perches7e51f192013-09-11 14:23:57 -07001934
1935# Check for duplicate signatures
1936 my $sig_nospace = $line;
1937 $sig_nospace =~ s/\s//g;
1938 $sig_nospace = lc($sig_nospace);
1939 if (defined $signatures{$sig_nospace}) {
1940 WARN("BAD_SIGN_OFF",
1941 "Duplicate signature\n" . $herecurr);
1942 } else {
1943 $signatures{$sig_nospace} = 1;
1944 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001945 }
1946
Christopher Covington7ebd05e2014-04-03 14:49:31 -07001947# Check for unwanted Gerrit info
1948 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1949 ERROR("GERRIT_CHANGE_ID",
1950 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
1951 }
1952
Andy Whitcroft00df3442007-06-08 13:47:06 -07001953# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001954 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001955 ERROR("CORRUPTED_PATCH",
1956 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001957 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001958 }
1959
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001960# Check for absolute kernel paths.
1961 if ($tree) {
1962 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1963 my $file = $1;
1964
1965 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1966 check_absolute_file($1, $herecurr)) {
1967 #
1968 } else {
1969 check_absolute_file($file, $herecurr);
1970 }
1971 }
1972 }
1973
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001974# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1975 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001976 $rawline !~ m/^$UTF8*$/) {
1977 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1978
1979 my $blank = copy_spacing($rawline);
1980 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1981 my $hereptr = "$hereline$ptr\n";
1982
Joe Perches34d99212011-07-25 17:13:26 -07001983 CHK("INVALID_UTF8",
1984 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001985 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001986
Joe Perches15662b32011-10-31 17:13:12 -07001987# Check if it's the start of a commit log
1988# (not a header line and we haven't seen the patch filename)
1989 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001990 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001991 $in_header_lines = 0;
1992 $in_commit_log = 1;
1993 }
1994
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001995# Check if there is UTF-8 in a commit log when a mail header has explicitly
1996# declined it, i.e defined some charset where it is missing.
1997 if ($in_header_lines &&
1998 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1999 $1 !~ /utf-8/i) {
2000 $non_utf8_charset = 1;
2001 }
2002
2003 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002004 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002005 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002006 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2007 }
2008
Andy Whitcroft306708542008-10-15 22:02:28 -07002009# ignore non-hunk lines and lines being removed
2010 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002011
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002012#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002013 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002014 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002015 if (ERROR("DOS_LINE_ENDINGS",
2016 "DOS line endings\n" . $herevet) &&
2017 $fix) {
2018 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2019 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002020 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2021 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002022 if (ERROR("TRAILING_WHITESPACE",
2023 "trailing whitespace\n" . $herevet) &&
2024 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002025 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002026 }
2027
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002028 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002029 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002030
Josh Triplett4783f892013-11-12 15:10:12 -08002031# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002032 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002033 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2034 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002035 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2036 my $msg_type = \&ERROR;
2037 $msg_type = \&CHK if ($file);
2038 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002039 "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 -08002040 }
2041
Andi Kleen33549572010-05-24 14:33:29 -07002042# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002043# Only applies when adding the entry originally, after that we do not have
2044# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002045 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08002046 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002047 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002048 my $cnt = $realcnt;
2049 my $ln = $linenr + 1;
2050 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002051 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002052 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002053 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002054 $f = $lines[$ln - 1];
2055 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2056 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002057
2058 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002059
2060 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2061 $is_start = 1;
2062 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2063 $length = -1;
2064 }
2065
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002066 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002067 $f =~ s/#.*//;
2068 $f =~ s/^\s+//;
2069 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002070 if ($f =~ /^\s*config\s/) {
2071 $is_end = 1;
2072 last;
2073 }
Andi Kleen33549572010-05-24 14:33:29 -07002074 $length++;
2075 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002076 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002077 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2078 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002079 }
2080
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002081# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2082 if ($realfile =~ /Kconfig/ &&
2083 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2084 WARN("CONFIG_EXPERIMENTAL",
2085 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2086 }
2087
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002088 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2089 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2090 my $flag = $1;
2091 my $replacement = {
2092 'EXTRA_AFLAGS' => 'asflags-y',
2093 'EXTRA_CFLAGS' => 'ccflags-y',
2094 'EXTRA_CPPFLAGS' => 'cppflags-y',
2095 'EXTRA_LDFLAGS' => 'ldflags-y',
2096 };
2097
2098 WARN("DEPRECATED_VARIABLE",
2099 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2100 }
2101
Rob Herringbff5da42014-01-23 15:54:51 -08002102# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002103 if (defined $root &&
2104 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2105 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2106
Rob Herringbff5da42014-01-23 15:54:51 -08002107 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2108
Florian Vaussardcc933192014-04-03 14:49:27 -07002109 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2110 my $vp_file = $dt_path . "vendor-prefixes.txt";
2111
Rob Herringbff5da42014-01-23 15:54:51 -08002112 foreach my $compat (@compats) {
2113 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002114 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2115 my $compat3 = $compat;
2116 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2117 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002118 if ( $? >> 8 ) {
2119 WARN("UNDOCUMENTED_DT_STRING",
2120 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2121 }
2122
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002123 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2124 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002125 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002126 if ( $? >> 8 ) {
2127 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002128 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002129 }
2130 }
2131 }
2132
Andy Whitcroft5368df22008-10-15 22:02:27 -07002133# check we are in a valid source file if not then ignore this hunk
2134 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2135
Joe Perches6cd7f382012-12-17 16:01:54 -08002136#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002137 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002138 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002139 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002140 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002141 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002142 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002143 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002144 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002145 }
2146
Josh Triplettca56dc02012-03-23 15:02:21 -07002147# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002148# to grep for the string. Make exceptions when the previous string ends in a
2149# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2150# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002151 if ($line =~ /^\+\s*"/ &&
2152 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002153 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002154 WARN("SPLIT_STRING",
2155 "quoted string split across lines\n" . $hereprev);
2156 }
2157
Joe Perches5e79d962010-03-05 13:43:55 -08002158# check for spaces before a quoted newline
2159 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002160 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2161 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2162 $fix) {
2163 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2164 }
2165
Joe Perches5e79d962010-03-05 13:43:55 -08002166 }
2167
Andy Whitcroft8905a672007-11-28 16:21:06 -08002168# check for adding lines without a newline.
2169 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002170 WARN("MISSING_EOF_NEWLINE",
2171 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002172 }
2173
Mike Frysinger42e41c52009-09-21 17:04:40 -07002174# Blackfin: use hi/lo macros
2175 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2176 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2177 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002178 ERROR("LO_MACRO",
2179 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002180 }
2181 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2182 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002183 ERROR("HI_MACRO",
2184 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002185 }
2186 }
2187
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002188# check we are in a valid source file C or perl if not then ignore this hunk
2189 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002190
2191# at the beginning of a line any tabs must come first and anything
2192# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002193 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2194 $rawline =~ /^\+\s* \s*/) {
2195 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002196 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002197 if (ERROR("CODE_INDENT",
2198 "code indent should use tabs where possible\n" . $herevet) &&
2199 $fix) {
2200 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2201 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002202 }
2203
Alberto Panizzo08e44362010-03-05 13:43:54 -08002204# check for space before tabs.
2205 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2206 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002207 if (WARN("SPACE_BEFORE_TAB",
2208 "please, no space before tabs\n" . $herevet) &&
2209 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002210 while ($fixed[$linenr - 1] =~
2211 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2212 while ($fixed[$linenr - 1] =~
2213 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002214 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002215 }
2216
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002217# check for && or || at the start of a line
2218 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2219 CHK("LOGICAL_CONTINUATIONS",
2220 "Logical continuations should be on the previous line\n" . $hereprev);
2221 }
2222
2223# check multi-line statement indentation matches previous line
2224 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002225 $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 -07002226 $prevline =~ /^\+(\t*)(.*)$/;
2227 my $oldindent = $1;
2228 my $rest = $2;
2229
2230 my $pos = pos_last_openparen($rest);
2231 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002232 $line =~ /^(\+| )([ \t]*)/;
2233 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002234
2235 my $goodtabindent = $oldindent .
2236 "\t" x ($pos / 8) .
2237 " " x ($pos % 8);
2238 my $goodspaceindent = $oldindent . " " x $pos;
2239
2240 if ($newindent ne $goodtabindent &&
2241 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002242
2243 if (CHK("PARENTHESIS_ALIGNMENT",
2244 "Alignment should match open parenthesis\n" . $hereprev) &&
2245 $fix && $line =~ /^\+/) {
2246 $fixed[$linenr - 1] =~
2247 s/^\+[ \t]*/\+$goodtabindent/;
2248 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002249 }
2250 }
2251 }
2252
Joe Perches23f780c92013-07-03 15:05:31 -07002253 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002254 if (CHK("SPACING",
2255 "No space is necessary after a cast\n" . $hereprev) &&
2256 $fix) {
2257 $fixed[$linenr - 1] =~
2258 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2259 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002260 }
2261
Joe Perches05880602012-10-04 17:13:35 -07002262 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002263 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002264 $rawline =~ /^\+[ \t]*\*/ &&
2265 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002266 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2267 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2268 }
2269
2270 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002271 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2272 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002273 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002274 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2275 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2276 "networking block comments start with * on subsequent lines\n" . $hereprev);
2277 }
2278
2279 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002280 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2281 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2282 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2283 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002284 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2285 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2286 }
2287
Joe Perches3b617e3b2014-04-03 14:49:28 -07002288# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002289 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2290 # actual declarations
2291 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2292 # foo bar; where foo is some local typedef or #define
2293 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2294 # known declaration macros
2295 $prevline =~ /^\+\s+$declaration_macros/) &&
2296 # for "else if" which can look like "$Ident $Ident"
2297 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2298 # other possible extensions of declaration lines
2299 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2300 # not starting a section or a macro "\" extended line
2301 $prevline =~ /(?:\{\s*|\\)$/) &&
2302 # looks like a declaration
2303 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2304 # foo bar; where foo is some local typedef or #define
2305 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2306 # known declaration macros
2307 $sline =~ /^\+\s+$declaration_macros/ ||
2308 # start of struct or union or enum
Joe Perches3b617e3b2014-04-03 14:49:28 -07002309 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002310 # start or end of block or continuation of declaration
2311 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2312 # bitfield continuation
2313 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2314 # other possible extensions of declaration lines
2315 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2316 # indentation of previous and current line are the same
2317 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perches3b617e3b2014-04-03 14:49:28 -07002318 WARN("SPACING",
Joe Perches3f7bac02014-06-04 16:12:04 -07002319 "Missing a blank line after declarations\n" . $hereprev);
Joe Perches3b617e3b2014-04-03 14:49:28 -07002320 }
2321
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002322# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002323# Exceptions:
2324# 1) within comments
2325# 2) indented preprocessor commands
2326# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002327 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002328 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002329 if (WARN("LEADING_SPACE",
2330 "please, no spaces at the start of a line\n" . $herevet) &&
2331 $fix) {
2332 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2333 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002334 }
2335
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002336# check we are in a valid C source file if not then ignore this hunk
2337 next if ($realfile !~ /\.(h|c)$/);
2338
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002339# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2340 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2341 WARN("CONFIG_EXPERIMENTAL",
2342 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2343 }
2344
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002345# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002346 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002347 WARN("CVS_KEYWORD",
2348 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002349 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002350
Mike Frysinger42e41c52009-09-21 17:04:40 -07002351# Blackfin: don't use __builtin_bfin_[cs]sync
2352 if ($line =~ /__builtin_bfin_csync/) {
2353 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002354 ERROR("CSYNC",
2355 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002356 }
2357 if ($line =~ /__builtin_bfin_ssync/) {
2358 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002359 ERROR("SSYNC",
2360 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002361 }
2362
Joe Perches56e77d72013-02-21 16:44:14 -08002363# check for old HOTPLUG __dev<foo> section markings
2364 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2365 WARN("HOTPLUG_SECTION",
2366 "Using $1 is unnecessary\n" . $herecurr);
2367 }
2368
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002369# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002370 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2371 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002372#print "LINE<$line>\n";
2373 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002374 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002375 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002376 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002377 $stat =~ s/\n./\n /g;
2378 $cond =~ s/\n./\n /g;
2379
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002380#print "linenr<$linenr> <$stat>\n";
2381 # If this statement has no statement boundaries within
2382 # it there is no point in retrying a statement scan
2383 # until we hit end of it.
2384 my $frag = $stat; $frag =~ s/;+\s*$//;
2385 if ($frag !~ /(?:{|;)/) {
2386#print "skip<$line_nr_next>\n";
2387 $suppress_statement = $line_nr_next;
2388 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002389
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002390 # Find the real next line.
2391 $realline_next = $line_nr_next;
2392 if (defined $realline_next &&
2393 (!defined $lines[$realline_next - 1] ||
2394 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2395 $realline_next++;
2396 }
2397
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002398 my $s = $stat;
2399 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002400
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002401 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002402 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002403
2404 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002405 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002406
Andy Whitcroft463f2862009-09-21 17:04:34 -07002407 } elsif ($s =~ /^.\s*else\b/s) {
2408
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002409 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002410 } 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 -07002411 my $type = $1;
2412 $type =~ s/\s+/ /g;
2413 possible($type, "A:" . $s);
2414
Andy Whitcroft8905a672007-11-28 16:21:06 -08002415 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002416 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002417 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002418 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002419
2420 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002421 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002422 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002423 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002424
2425 # Check for any sort of function declaration.
2426 # int foo(something bar, other baz);
2427 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002428 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 -08002429 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002430
Andy Whitcroftcf655042008-03-04 14:28:20 -08002431 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002432 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002433 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002434
Andy Whitcroft8905a672007-11-28 16:21:06 -08002435 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002436 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002437
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002438 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002439 }
2440 }
2441 }
2442
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002443 }
2444
Andy Whitcroft653d4872007-06-23 17:16:34 -07002445#
2446# Checks which may be anchored in the context.
2447#
2448
2449# Check for switch () and associated case and default
2450# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002451 if ($line=~/\bswitch\s*\(.*\)/) {
2452 my $err = '';
2453 my $sep = '';
2454 my @ctx = ctx_block_outer($linenr, $realcnt);
2455 shift(@ctx);
2456 for my $ctx (@ctx) {
2457 my ($clen, $cindent) = line_stats($ctx);
2458 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2459 $indent != $cindent) {
2460 $err .= "$sep$ctx\n";
2461 $sep = '';
2462 } else {
2463 $sep = "[...]\n";
2464 }
2465 }
2466 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002467 ERROR("SWITCH_CASE_INDENT_LEVEL",
2468 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002469 }
2470 }
2471
2472# if/while/etc brace do not go on next line, unless defining a do while loop,
2473# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002474 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002475 my $pre_ctx = "$1$2";
2476
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002477 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002478
2479 if ($line =~ /^\+\t{6,}/) {
2480 WARN("DEEP_INDENTATION",
2481 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2482 }
2483
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002484 my $ctx_cnt = $realcnt - $#ctx - 1;
2485 my $ctx = join("\n", @ctx);
2486
Andy Whitcroft548596d2008-07-23 21:29:01 -07002487 my $ctx_ln = $linenr;
2488 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002489
Andy Whitcroft548596d2008-07-23 21:29:01 -07002490 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2491 defined $lines[$ctx_ln - 1] &&
2492 $lines[$ctx_ln - 1] =~ /^-/)) {
2493 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2494 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002495 $ctx_ln++;
2496 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002497
Andy Whitcroft53210162008-07-23 21:29:03 -07002498 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2499 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002500
2501 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002502 ERROR("OPEN_BRACE",
2503 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002504 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002505 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002506 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2507 $ctx =~ /\)\s*\;\s*$/ &&
2508 defined $lines[$ctx_ln - 1])
2509 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002510 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2511 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002512 WARN("TRAILING_SEMICOLON",
2513 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002514 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002515 }
2516 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002517 }
2518
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002519# Check relative indent for conditionals and blocks.
2520 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002521 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2522 ctx_statement_block($linenr, $realcnt, 0)
2523 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002524 my ($s, $c) = ($stat, $cond);
2525
2526 substr($s, 0, length($c), '');
2527
2528 # Make sure we remove the line prefixes as we have
2529 # none on the first line, and are going to readd them
2530 # where necessary.
2531 $s =~ s/\n./\n/gs;
2532
2533 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002534 my @newlines = ($c =~ /\n/gs);
2535 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002536
2537 # We want to check the first line inside the block
2538 # starting at the end of the conditional, so remove:
2539 # 1) any blank line termination
2540 # 2) any opening brace { on end of the line
2541 # 3) any do (...) {
2542 my $continuation = 0;
2543 my $check = 0;
2544 $s =~ s/^.*\bdo\b//;
2545 $s =~ s/^\s*{//;
2546 if ($s =~ s/^\s*\\//) {
2547 $continuation = 1;
2548 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002549 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002550 $check = 1;
2551 $cond_lines++;
2552 }
2553
2554 # Also ignore a loop construct at the end of a
2555 # preprocessor statement.
2556 if (($prevline =~ /^.\s*#\s*define\s/ ||
2557 $prevline =~ /\\\s*$/) && $continuation == 0) {
2558 $check = 0;
2559 }
2560
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002561 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002562 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002563 while ($cond_ptr != $cond_lines) {
2564 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002565
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002566 # If we see an #else/#elif then the code
2567 # is not linear.
2568 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2569 $check = 0;
2570 }
2571
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002572 # Ignore:
2573 # 1) blank lines, they should be at 0,
2574 # 2) preprocessor lines, and
2575 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002576 if ($continuation ||
2577 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002578 $s =~ /^\s*#\s*?/ ||
2579 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002580 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002581 if ($s =~ s/^.*?\n//) {
2582 $cond_lines++;
2583 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002584 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002585 }
2586
2587 my (undef, $sindent) = line_stats("+" . $s);
2588 my $stat_real = raw_line($linenr, $cond_lines);
2589
2590 # Check if either of these lines are modified, else
2591 # this is not this patch's fault.
2592 if (!defined($stat_real) ||
2593 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2594 $check = 0;
2595 }
2596 if (defined($stat_real) && $cond_lines > 1) {
2597 $stat_real = "[...]\n$stat_real";
2598 }
2599
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002600 #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 -07002601
2602 if ($check && (($sindent % 8) != 0 ||
2603 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002604 WARN("SUSPECT_CODE_INDENT",
2605 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002606 }
2607 }
2608
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002609 # Track the 'values' across context and added lines.
2610 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002611 my ($curr_values, $curr_vars) =
2612 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002613 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002614 if ($dbg_values) {
2615 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002616 print "$linenr > .$outline\n";
2617 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002618 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002619 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002620 $prev_values = substr($curr_values, -1);
2621
Andy Whitcroft00df3442007-06-08 13:47:06 -07002622#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002623 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002624
Andy Whitcroft653d4872007-06-23 17:16:34 -07002625# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002626 if ($dbg_type) {
2627 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002628 ERROR("TEST_TYPE",
2629 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002630 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002631 ERROR("TEST_NOT_TYPE",
2632 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002633 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002634 next;
2635 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002636# TEST: allow direct testing of the attribute matcher.
2637 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002638 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002639 ERROR("TEST_ATTR",
2640 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002641 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002642 ERROR("TEST_NOT_ATTR",
2643 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002644 }
2645 next;
2646 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002647
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002648# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002649 if ($line =~ /^.\s*{/ &&
2650 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002651 ERROR("OPEN_BRACE",
2652 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002653 }
2654
Andy Whitcroft653d4872007-06-23 17:16:34 -07002655#
2656# Checks which are anchored on the added line.
2657#
2658
2659# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002660 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002661 my $path = $1;
2662 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002663 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002664 "malformed #include filename\n" . $herecurr);
2665 }
2666 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2667 ERROR("UAPI_INCLUDE",
2668 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002669 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002670 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002671
2672# no C99 // comments
2673 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002674 if (ERROR("C99_COMMENTS",
2675 "do not use C99 // comments\n" . $herecurr) &&
2676 $fix) {
2677 my $line = $fixed[$linenr - 1];
2678 if ($line =~ /\/\/(.*)$/) {
2679 my $comment = trim($1);
2680 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2681 }
2682 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002683 }
2684 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002685 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002686 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002687
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002688# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2689# the whole statement.
2690#print "APW <$lines[$realline_next - 1]>\n";
2691 if (defined $realline_next &&
2692 exists $lines[$realline_next - 1] &&
2693 !defined $suppress_export{$realline_next} &&
2694 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2695 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002696 # Handle definitions which produce identifiers with
2697 # a prefix:
2698 # XXX(foo);
2699 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002700 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002701 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002702 $name =~ /^${Ident}_$2/) {
2703#print "FOO C name<$name>\n";
2704 $suppress_export{$realline_next} = 1;
2705
2706 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002707 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002708 ^.DEFINE_$Ident\(\Q$name\E\)|
2709 ^.DECLARE_$Ident\(\Q$name\E\)|
2710 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002711 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2712 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002713 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002714#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2715 $suppress_export{$realline_next} = 2;
2716 } else {
2717 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002718 }
2719 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002720 if (!defined $suppress_export{$linenr} &&
2721 $prevline =~ /^.\s*$/ &&
2722 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2723 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2724#print "FOO B <$lines[$linenr - 1]>\n";
2725 $suppress_export{$linenr} = 2;
2726 }
2727 if (defined $suppress_export{$linenr} &&
2728 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002729 WARN("EXPORT_SYMBOL",
2730 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002731 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002732
Joe Eloff5150bda2010-08-09 17:21:00 -07002733# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002734 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2735 if (ERROR("GLOBAL_INITIALISERS",
2736 "do not initialise globals to 0 or NULL\n" .
2737 $herecurr) &&
2738 $fix) {
2739 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2740 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002741 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002742# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002743 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2744 if (ERROR("INITIALISED_STATIC",
2745 "do not initialise statics to 0 or NULL\n" .
2746 $herecurr) &&
2747 $fix) {
2748 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2749 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002750 }
2751
Joe Perchescb710ec2010-10-26 14:23:20 -07002752# check for static const char * arrays.
2753 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002754 WARN("STATIC_CONST_CHAR_ARRAY",
2755 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002756 $herecurr);
2757 }
2758
2759# check for static char foo[] = "bar" declarations.
2760 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002761 WARN("STATIC_CONST_CHAR_ARRAY",
2762 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002763 $herecurr);
2764 }
2765
Joe Perches9b0fa602014-04-03 14:49:18 -07002766# check for non-global char *foo[] = {"bar", ...} declarations.
2767 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2768 WARN("STATIC_CONST_CHAR_ARRAY",
2769 "char * array declaration might be better as static const\n" .
2770 $herecurr);
2771 }
2772
Joe Perchesb36190c2014-01-27 17:07:18 -08002773# check for function declarations without arguments like "int foo()"
2774 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2775 if (ERROR("FUNCTION_WITHOUT_ARGS",
2776 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2777 $fix) {
2778 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2779 }
2780 }
2781
Joe Perches92e112f2013-12-13 11:36:22 -07002782# check for uses of DEFINE_PCI_DEVICE_TABLE
2783 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2784 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2785 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2786 $fix) {
2787 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2788 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002789 }
2790
Andy Whitcroft653d4872007-06-23 17:16:34 -07002791# check for new typedefs, only function parameters and sparse annotations
2792# make sense.
2793 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002794 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002795 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002796 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002797 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002798 WARN("NEW_TYPEDEFS",
2799 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002800 }
2801
2802# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002803 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002804 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2805 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002806 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002807
Andy Whitcroft65863862009-01-06 14:41:21 -08002808 # Should start with a space.
2809 $to =~ s/^(\S)/ $1/;
2810 # Should not end with a space.
2811 $to =~ s/\s+$//;
2812 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002813 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002814 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002815
Joe Perches3705ce52013-07-03 15:05:31 -07002816## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002817 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002818 if (ERROR("POINTER_LOCATION",
2819 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2820 $fix) {
2821 my $sub_from = $ident;
2822 my $sub_to = $ident;
2823 $sub_to =~ s/\Q$from\E/$to/;
2824 $fixed[$linenr - 1] =~
2825 s@\Q$sub_from\E@$sub_to@;
2826 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002827 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002828 }
2829 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2830 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002831 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002832
Andy Whitcroft65863862009-01-06 14:41:21 -08002833 # Should start with a space.
2834 $to =~ s/^(\S)/ $1/;
2835 # Should not end with a space.
2836 $to =~ s/\s+$//;
2837 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002838 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002839 }
2840 # Modifiers should have spaces.
2841 $to =~ s/(\b$Modifier$)/$1 /;
2842
Joe Perches3705ce52013-07-03 15:05:31 -07002843## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002844 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002845 if (ERROR("POINTER_LOCATION",
2846 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2847 $fix) {
2848
2849 my $sub_from = $match;
2850 my $sub_to = $match;
2851 $sub_to =~ s/\Q$from\E/$to/;
2852 $fixed[$linenr - 1] =~
2853 s@\Q$sub_from\E@$sub_to@;
2854 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002855 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002856 }
2857
2858# # no BUG() or BUG_ON()
2859# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2860# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2861# print "$herecurr";
2862# $clean = 0;
2863# }
2864
Andy Whitcroft8905a672007-11-28 16:21:06 -08002865 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002866 WARN("LINUX_VERSION_CODE",
2867 "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 -08002868 }
2869
Joe Perches17441222011-06-15 15:08:17 -07002870# check for uses of printk_ratelimit
2871 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002872 WARN("PRINTK_RATELIMITED",
2873"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002874 }
2875
Andy Whitcroft00df3442007-06-08 13:47:06 -07002876# printk should use KERN_* levels. Note that follow on printk's on the
2877# same line do not need a level, so we use the current block context
2878# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002879# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002880# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002881 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002882 my $ok = 0;
2883 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2884 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002885 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002886 # with "\n" ignore it, else it is to blame
2887 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2888 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2889 $ok = 1;
2890 }
2891 last;
2892 }
2893 }
2894 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002895 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2896 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002897 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002898 }
2899
Joe Perches243f3802012-05-31 16:26:09 -07002900 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2901 my $orig = $1;
2902 my $level = lc($orig);
2903 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002904 my $level2 = $level;
2905 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002906 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07002907 "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 -07002908 }
2909
2910 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002911 if (WARN("PREFER_PR_LEVEL",
2912 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2913 $fix) {
2914 $fixed[$linenr - 1] =~
2915 s/\bpr_warning\b/pr_warn/;
2916 }
Joe Perches243f3802012-05-31 16:26:09 -07002917 }
2918
Joe Perchesdc139312013-02-21 16:44:13 -08002919 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2920 my $orig = $1;
2921 my $level = lc($orig);
2922 $level = "warn" if ($level eq "warning");
2923 $level = "dbg" if ($level eq "debug");
2924 WARN("PREFER_DEV_LEVEL",
2925 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2926 }
2927
Andy Whitcroft653d4872007-06-23 17:16:34 -07002928# function brace can't be on same line, except for #defines of do while,
2929# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002930 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2931 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002932 ERROR("OPEN_BRACE",
2933 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002934 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002935
Andy Whitcroft8905a672007-11-28 16:21:06 -08002936# open braces for enum, union and struct go on the same line.
2937 if ($line =~ /^.\s*{/ &&
2938 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002939 ERROR("OPEN_BRACE",
2940 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002941 }
2942
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002943# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002944 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2945 if (WARN("SPACING",
2946 "missing space after $1 definition\n" . $herecurr) &&
2947 $fix) {
2948 $fixed[$linenr - 1] =~
2949 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2950 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002951 }
2952
Joe Perches31070b52014-01-23 15:54:49 -08002953# Function pointer declarations
2954# check spacing between type, funcptr, and args
2955# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002956 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002957 my $declare = $1;
2958 my $pre_pointer_space = $2;
2959 my $post_pointer_space = $3;
2960 my $funcname = $4;
2961 my $post_funcname_space = $5;
2962 my $pre_args_space = $6;
2963
Joe Perches91f72e92014-04-03 14:49:12 -07002964# the $Declare variable will capture all spaces after the type
2965# so check it for a missing trailing missing space but pointer return types
2966# don't need a space so don't warn for those.
2967 my $post_declare_space = "";
2968 if ($declare =~ /(\s+)$/) {
2969 $post_declare_space = $1;
2970 $declare = rtrim($declare);
2971 }
2972 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002973 WARN("SPACING",
2974 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002975 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002976 }
2977
2978# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002979# This test is not currently implemented because these declarations are
2980# equivalent to
2981# int foo(int bar, ...)
2982# and this is form shouldn't/doesn't generate a checkpatch warning.
2983#
2984# elsif ($declare =~ /\s{2,}$/) {
2985# WARN("SPACING",
2986# "Multiple spaces after return type\n" . $herecurr);
2987# }
Joe Perches31070b52014-01-23 15:54:49 -08002988
2989# unnecessary space "type ( *funcptr)(args...)"
2990 if (defined $pre_pointer_space &&
2991 $pre_pointer_space =~ /^\s/) {
2992 WARN("SPACING",
2993 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2994 }
2995
2996# unnecessary space "type (* funcptr)(args...)"
2997 if (defined $post_pointer_space &&
2998 $post_pointer_space =~ /^\s/) {
2999 WARN("SPACING",
3000 "Unnecessary space before function pointer name\n" . $herecurr);
3001 }
3002
3003# unnecessary space "type (*funcptr )(args...)"
3004 if (defined $post_funcname_space &&
3005 $post_funcname_space =~ /^\s/) {
3006 WARN("SPACING",
3007 "Unnecessary space after function pointer name\n" . $herecurr);
3008 }
3009
3010# unnecessary space "type (*funcptr) (args...)"
3011 if (defined $pre_args_space &&
3012 $pre_args_space =~ /^\s/) {
3013 WARN("SPACING",
3014 "Unnecessary space before function pointer arguments\n" . $herecurr);
3015 }
3016
3017 if (show_type("SPACING") && $fix) {
3018 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003019 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003020 }
3021 }
3022
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003023# check for spacing round square brackets; allowed:
3024# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003025# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3026# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003027 while ($line =~ /(.*?\s)\[/g) {
3028 my ($where, $prefix) = ($-[1], $1);
3029 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003030 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003031 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003032 if (ERROR("BRACKET_SPACE",
3033 "space prohibited before open square bracket '['\n" . $herecurr) &&
3034 $fix) {
3035 $fixed[$linenr - 1] =~
3036 s/^(\+.*?)\s+\[/$1\[/;
3037 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003038 }
3039 }
3040
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003041# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003042 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003043 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003044 my $ctx_before = substr($line, 0, $-[1]);
3045 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003046
3047 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003048 if ($name =~ /^(?:
3049 if|for|while|switch|return|case|
3050 volatile|__volatile__|
3051 __attribute__|format|__extension__|
3052 asm|__asm__)$/x)
3053 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003054 # cpp #define statements have non-optional spaces, ie
3055 # if there is a space between the name and the open
3056 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003057 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003058
3059 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003060 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003061
3062 # If this whole things ends with a type its most
3063 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003064 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003065
3066 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003067 if (WARN("SPACING",
3068 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3069 $fix) {
3070 $fixed[$linenr - 1] =~
3071 s/\b$name\s+\(/$name\(/;
3072 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003073 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003074 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003075
Andy Whitcroft653d4872007-06-23 17:16:34 -07003076# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003077 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003078 my $fixed_line = "";
3079 my $line_fixed = 0;
3080
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003081 my $ops = qr{
3082 <<=|>>=|<=|>=|==|!=|
3083 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3084 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003085 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003086 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003087 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003088 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003089
3090## print("element count: <" . $#elements . ">\n");
3091## foreach my $el (@elements) {
3092## print("el: <$el>\n");
3093## }
3094
3095 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003096 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003097
Joe Perches3705ce52013-07-03 15:05:31 -07003098 foreach my $el (@elements) {
3099 push(@fix_elements, substr($rawline, $off, length($el)));
3100 $off += length($el);
3101 }
3102
3103 $off = 0;
3104
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003105 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003106 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003107
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003108 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003109
3110 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3111
3112## print("n: <$n> good: <$good>\n");
3113
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003114 $off += length($elements[$n]);
3115
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003116 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003117 my $ca = substr($opline, 0, $off);
3118 my $cc = '';
3119 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3120 $cc = substr($opline, $off + length($elements[$n + 1]));
3121 }
3122 my $cb = "$ca$;$cc";
3123
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003124 my $a = '';
3125 $a = 'V' if ($elements[$n] ne '');
3126 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003127 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003128 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3129 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003130 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003131
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003132 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003133
3134 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003135 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003136 $c = 'V' if ($elements[$n + 2] ne '');
3137 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003138 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003139 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3140 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003141 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003142 } else {
3143 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003144 }
3145
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003146 my $ctx = "${a}x${c}";
3147
3148 my $at = "(ctx:$ctx)";
3149
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003150 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003151 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003152
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003153 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003154 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003155
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003156 # Get the full operator variant.
3157 my $opv = $op . substr($curr_vars, $off, 1);
3158
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003159 # Ignore operators passed as parameters.
3160 if ($op_type ne 'V' &&
3161 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3162
Andy Whitcroftcf655042008-03-04 14:28:20 -08003163# # Ignore comments
3164# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003165
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003166 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003167 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003168 if ($ctx !~ /.x[WEBC]/ &&
3169 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003170 if (ERROR("SPACING",
3171 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003172 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003173 $line_fixed = 1;
3174 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003175 }
3176
3177 # // is a comment
3178 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003179
Joe Perchesb00e4812014-04-03 14:49:33 -07003180 # : when part of a bitfield
3181 } elsif ($opv eq ':B') {
3182 # skip the bitfield test for now
3183
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003184 # No spaces for:
3185 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003186 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003187 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003188 if (ERROR("SPACING",
3189 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003190 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003191 if (defined $fix_elements[$n + 2]) {
3192 $fix_elements[$n + 2] =~ s/^\s+//;
3193 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003194 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003195 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003196 }
3197
3198 # , must have a space on the right.
3199 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003200 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003201 if (ERROR("SPACING",
3202 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003203 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003204 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003205 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003206 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003207 }
3208
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003209 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003210 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003211 #warn "'*' is part of type\n";
3212
3213 # unary operators should have a space before and
3214 # none after. May be left adjacent to another
3215 # unary operator, or a cast
3216 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003217 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003218 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003219 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003220 if (ERROR("SPACING",
3221 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003222 if ($n != $last_after + 2) {
3223 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3224 $line_fixed = 1;
3225 }
Joe Perches3705ce52013-07-03 15:05:31 -07003226 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003227 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003228 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003229 # A unary '*' may be const
3230
3231 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003232 if (ERROR("SPACING",
3233 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003234 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003235 if (defined $fix_elements[$n + 2]) {
3236 $fix_elements[$n + 2] =~ s/^\s+//;
3237 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003238 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003239 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003240 }
3241
3242 # unary ++ and unary -- are allowed no space on one side.
3243 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003244 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003245 if (ERROR("SPACING",
3246 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003247 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003248 $line_fixed = 1;
3249 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003250 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003251 if ($ctx =~ /Wx[BE]/ ||
3252 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003253 if (ERROR("SPACING",
3254 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003255 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003256 $line_fixed = 1;
3257 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003258 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003259 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003260 if (ERROR("SPACING",
3261 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003262 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003263 if (defined $fix_elements[$n + 2]) {
3264 $fix_elements[$n + 2] =~ s/^\s+//;
3265 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003266 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003267 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003268 }
3269
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003270 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003271 } elsif ($op eq '<<' or $op eq '>>' or
3272 $op eq '&' or $op eq '^' or $op eq '|' or
3273 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003274 $op eq '*' or $op eq '/' or
3275 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003276 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003277 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003278 if (ERROR("SPACING",
3279 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003280 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3281 if (defined $fix_elements[$n + 2]) {
3282 $fix_elements[$n + 2] =~ s/^\s+//;
3283 }
Joe Perches3705ce52013-07-03 15:05:31 -07003284 $line_fixed = 1;
3285 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003286 }
3287
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003288 # A colon needs no spaces before when it is
3289 # terminating a case value or a label.
3290 } elsif ($opv eq ':C' || $opv eq ':L') {
3291 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003292 if (ERROR("SPACING",
3293 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003294 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003295 $line_fixed = 1;
3296 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003297 }
3298
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003299 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003300 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003301 my $ok = 0;
3302
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003303 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003304 if (($op eq '<' &&
3305 $cc =~ /^\S+\@\S+>/) ||
3306 ($op eq '>' &&
3307 $ca =~ /<\S+\@\S+$/))
3308 {
3309 $ok = 1;
3310 }
3311
Joe Perches84731622013-11-12 15:10:05 -08003312 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003313 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003314 my $msg_type = \&ERROR;
3315 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3316
3317 if (&{$msg_type}("SPACING",
3318 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003319 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3320 if (defined $fix_elements[$n + 2]) {
3321 $fix_elements[$n + 2] =~ s/^\s+//;
3322 }
Joe Perches3705ce52013-07-03 15:05:31 -07003323 $line_fixed = 1;
3324 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003325 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003326 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003327 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003328
3329## print("n: <$n> GOOD: <$good>\n");
3330
3331 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003332 }
Joe Perches3705ce52013-07-03 15:05:31 -07003333
3334 if (($#elements % 2) == 0) {
3335 $fixed_line = $fixed_line . $fix_elements[$#elements];
3336 }
3337
3338 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3339 $fixed[$linenr - 1] = $fixed_line;
3340 }
3341
3342
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003343 }
3344
Joe Perches786b6322013-07-03 15:05:32 -07003345# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003346 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003347 if (WARN("SPACING",
3348 "space prohibited before semicolon\n" . $herecurr) &&
3349 $fix) {
3350 1 while $fixed[$linenr - 1] =~
3351 s/^(\+.*\S)\s+;/$1;/;
3352 }
3353 }
3354
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003355# check for multiple assignments
3356 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003357 CHK("MULTIPLE_ASSIGNMENTS",
3358 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003359 }
3360
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003361## # check for multiple declarations, allowing for a function declaration
3362## # continuation.
3363## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3364## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3365##
3366## # Remove any bracketed sections to ensure we do not
3367## # falsly report the parameters of functions.
3368## my $ln = $line;
3369## while ($ln =~ s/\([^\(\)]*\)//g) {
3370## }
3371## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003372## WARN("MULTIPLE_DECLARATION",
3373## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003374## }
3375## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003376
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003377#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003378 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3379 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003380 if (ERROR("SPACING",
3381 "space required before the open brace '{'\n" . $herecurr) &&
3382 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003383 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003384 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003385 }
3386
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003387## # check for blank lines before declarations
3388## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3389## $prevrawline =~ /^.\s*$/) {
3390## WARN("SPACING",
3391## "No blank lines before declarations\n" . $hereprev);
3392## }
3393##
3394
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003395# closing brace should have a space following it when it has anything
3396# on the line
3397 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003398 if (ERROR("SPACING",
3399 "space required after that close brace '}'\n" . $herecurr) &&
3400 $fix) {
3401 $fixed[$linenr - 1] =~
3402 s/}((?!(?:,|;|\)))\S)/} $1/;
3403 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003404 }
3405
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003406# check spacing on square brackets
3407 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003408 if (ERROR("SPACING",
3409 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3410 $fix) {
3411 $fixed[$linenr - 1] =~
3412 s/\[\s+/\[/;
3413 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003414 }
3415 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003416 if (ERROR("SPACING",
3417 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3418 $fix) {
3419 $fixed[$linenr - 1] =~
3420 s/\s+\]/\]/;
3421 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003422 }
3423
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003424# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003425 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3426 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003427 if (ERROR("SPACING",
3428 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3429 $fix) {
3430 $fixed[$linenr - 1] =~
3431 s/\(\s+/\(/;
3432 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003433 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003434 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003435 $line !~ /for\s*\(.*;\s+\)/ &&
3436 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003437 if (ERROR("SPACING",
3438 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3439 $fix) {
3440 $fixed[$linenr - 1] =~
3441 s/\s+\)/\)/;
3442 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003443 }
3444
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003445#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003446 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003447 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003448 if (WARN("INDENTED_LABEL",
3449 "labels should not be indented\n" . $herecurr) &&
3450 $fix) {
3451 $fixed[$linenr - 1] =~
3452 s/^(.)\s+/$1/;
3453 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003454 }
3455
Joe Perches5b9553a2014-04-03 14:49:21 -07003456# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003457 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003458 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003459 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003460 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3461 my $value = $1;
3462 $value = deparenthesize($value);
3463 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3464 ERROR("RETURN_PARENTHESES",
3465 "return is not a function, parentheses are not required\n" . $herecurr);
3466 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003467 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003468 ERROR("SPACING",
3469 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003470 }
3471 }
Joe Perches507e5142013-11-12 15:10:13 -08003472
Joe Perches9819cf22014-06-04 16:12:09 -07003473# unnecessary return in a void function? (a single leading tab, then return;)
3474 if ($sline =~ /^\+\treturn\s*;\s*$/ &&
3475 $prevline =~ /^\+/) {
3476 WARN("RETURN_VOID",
3477 "void function return statements are not generally useful\n" . $herecurr);
3478 }
3479
Joe Perches189248d2014-01-23 15:54:47 -08003480# if statements using unnecessary parentheses - ie: if ((foo == bar))
3481 if ($^V && $^V ge 5.10.0 &&
3482 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3483 my $openparens = $1;
3484 my $count = $openparens =~ tr@\(@\(@;
3485 my $msg = "";
3486 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3487 my $comp = $4; #Not $1 because of $LvalOrFunc
3488 $msg = " - maybe == should be = ?" if ($comp eq "==");
3489 WARN("UNNECESSARY_PARENTHESES",
3490 "Unnecessary parentheses$msg\n" . $herecurr);
3491 }
3492 }
3493
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003494# Return of what appears to be an errno should normally be -'ve
3495 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3496 my $name = $1;
3497 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003498 WARN("USE_NEGATIVE_ERRNO",
3499 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003500 }
3501 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003502
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003503# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003504 if ($line =~ /\b(if|while|for|switch)\(/) {
3505 if (ERROR("SPACING",
3506 "space required before the open parenthesis '('\n" . $herecurr) &&
3507 $fix) {
3508 $fixed[$linenr - 1] =~
3509 s/\b(if|while|for|switch)\(/$1 \(/;
3510 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003511 }
3512
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003513# Check for illegal assignment in if conditional -- and check for trailing
3514# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003515 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003516 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3517 ctx_statement_block($linenr, $realcnt, 0)
3518 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003519 my ($stat_next) = ctx_statement_block($line_nr_next,
3520 $remain_next, $off_next);
3521 $stat_next =~ s/\n./\n /g;
3522 ##print "stat<$stat> stat_next<$stat_next>\n";
3523
3524 if ($stat_next =~ /^\s*while\b/) {
3525 # If the statement carries leading newlines,
3526 # then count those as offsets.
3527 my ($whitespace) =
3528 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3529 my $offset =
3530 statement_rawlines($whitespace) - 1;
3531
3532 $suppress_whiletrailers{$line_nr_next +
3533 $offset} = 1;
3534 }
3535 }
3536 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003537 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003538 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003539 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003540
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003541 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003542 ERROR("ASSIGN_IN_IF",
3543 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003544 }
3545
3546 # Find out what is on the end of the line after the
3547 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003548 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003549 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003550 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003551 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3552 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003553 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003554 # Find out how long the conditional actually is.
3555 my @newlines = ($c =~ /\n/gs);
3556 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003557 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003558
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003559 $stat_real = raw_line($linenr, $cond_lines)
3560 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003561 if (defined($stat_real) && $cond_lines > 1) {
3562 $stat_real = "[...]\n$stat_real";
3563 }
3564
Joe Perches000d1cc12011-07-25 17:13:25 -07003565 ERROR("TRAILING_STATEMENTS",
3566 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003567 }
3568 }
3569
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003570# Check for bitwise tests written as boolean
3571 if ($line =~ /
3572 (?:
3573 (?:\[|\(|\&\&|\|\|)
3574 \s*0[xX][0-9]+\s*
3575 (?:\&\&|\|\|)
3576 |
3577 (?:\&\&|\|\|)
3578 \s*0[xX][0-9]+\s*
3579 (?:\&\&|\|\||\)|\])
3580 )/x)
3581 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003582 WARN("HEXADECIMAL_BOOLEAN_TEST",
3583 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003584 }
3585
Andy Whitcroft8905a672007-11-28 16:21:06 -08003586# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003587 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3588 my $s = $1;
3589 $s =~ s/$;//g; # Remove any comments
3590 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003591 ERROR("TRAILING_STATEMENTS",
3592 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003593 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003594 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003595# if should not continue a brace
3596 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003597 ERROR("TRAILING_STATEMENTS",
3598 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003599 $herecurr);
3600 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003601# case and default should not have general statements after them
3602 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3603 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003604 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003605 \s*return\s+
3606 )/xg)
3607 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003608 ERROR("TRAILING_STATEMENTS",
3609 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003610 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003611
3612 # Check for }<nl>else {, these must be at the same
3613 # indent level to be relevant to each other.
3614 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3615 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003616 ERROR("ELSE_AFTER_BRACE",
3617 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003618 }
3619
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003620 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3621 $previndent == $indent) {
3622 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3623
3624 # Find out what is on the end of the line after the
3625 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003626 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003627 $s =~ s/\n.*//g;
3628
3629 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003630 ERROR("WHILE_AFTER_BRACE",
3631 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003632 }
3633 }
3634
Joe Perches95e2c602013-07-03 15:05:20 -07003635#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003636 while ($line =~ m{($Constant|$Lval)}g) {
3637 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003638
3639#gcc binary extension
3640 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003641 if (WARN("GCC_BINARY_CONSTANT",
3642 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3643 $fix) {
3644 my $hexval = sprintf("0x%x", oct($var));
3645 $fixed[$linenr - 1] =~
3646 s/\b$var\b/$hexval/;
3647 }
Joe Perches95e2c602013-07-03 15:05:20 -07003648 }
3649
3650#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003651 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003652 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003653#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003654 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003655#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003656 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003657 while ($var =~ m{($Ident)}g) {
3658 my $word = $1;
3659 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003660 if ($check) {
3661 seed_camelcase_includes();
3662 if (!$file && !$camelcase_file_seeded) {
3663 seed_camelcase_file($realfile);
3664 $camelcase_file_seeded = 1;
3665 }
3666 }
Joe Perches7e781f62013-09-11 14:23:55 -07003667 if (!defined $camelcase{$word}) {
3668 $camelcase{$word} = 1;
3669 CHK("CAMELCASE",
3670 "Avoid CamelCase: <$word>\n" . $herecurr);
3671 }
Joe Perches34456862013-07-03 15:05:34 -07003672 }
Joe Perches323c1262012-12-17 16:02:07 -08003673 }
3674 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003675
3676#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003677 if ($line =~ /\#\s*define.*\\\s+$/) {
3678 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3679 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3680 $fix) {
3681 $fixed[$linenr - 1] =~ s/\s+$//;
3682 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003683 }
3684
Andy Whitcroft653d4872007-06-23 17:16:34 -07003685#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003686 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003687 my $file = "$1.h";
3688 my $checkfile = "include/linux/$file";
3689 if (-f "$root/$checkfile" &&
3690 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003691 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003692 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003693 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003694 CHK("ARCH_INCLUDE_LINUX",
3695 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003696 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003697 WARN("INCLUDE_LINUX",
3698 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003699 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003700 }
3701 }
3702
Andy Whitcroft653d4872007-06-23 17:16:34 -07003703# multi-statement macros should be enclosed in a do while loop, grab the
3704# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003705# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003706 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3707 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003708 my $ln = $linenr;
3709 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003710 my ($off, $dstat, $dcond, $rest);
3711 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003712 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003713 ctx_statement_block($linenr, $realcnt, 0);
3714 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003715 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003716 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003717
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003718 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003719 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003720 $dstat =~ s/\\\n.//g;
3721 $dstat =~ s/^\s*//s;
3722 $dstat =~ s/\s*$//s;
3723
3724 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003725 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3726 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003727 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003728 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003729 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003730
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003731 # Flatten any obvious string concatentation.
3732 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3733 $dstat =~ s/$Ident\s*("X*")/$1/)
3734 {
3735 }
3736
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003737 my $exceptions = qr{
3738 $Declare|
3739 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003740 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003741 DECLARE_PER_CPU|
3742 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003743 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003744 union|
3745 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003746 \.$Ident\s*=\s*|
3747 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003748 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003749 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003750 if ($dstat ne '' &&
3751 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3752 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003753 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003754 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003755 $dstat !~ /$exceptions/ &&
3756 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003757 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003758 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003759 $dstat !~ /^for\s*$Constant$/ && # for (...)
3760 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3761 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003762 $dstat !~ /^\({/ && # ({...
3763 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003764 {
3765 $ctx =~ s/\n*$//;
3766 my $herectx = $here . "\n";
3767 my $cnt = statement_rawlines($ctx);
3768
3769 for (my $n = 0; $n < $cnt; $n++) {
3770 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003771 }
3772
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003773 if ($dstat =~ /;/) {
3774 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3775 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3776 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003777 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003778 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003779 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003780 }
Joe Perches5023d342012-12-17 16:01:47 -08003781
Joe Perches481eb482012-12-17 16:01:56 -08003782# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003783
3784 } else {
3785 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003786 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3787 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003788 $line =~ /^\+.*\\$/) {
3789 WARN("LINE_CONTINUATIONS",
3790 "Avoid unnecessary line continuations\n" . $herecurr);
3791 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003792 }
3793
Joe Perchesb13edf72012-07-30 14:41:24 -07003794# do {} while (0) macro tests:
3795# single-statement macros do not need to be enclosed in do while (0) loop,
3796# macro should not end with a semicolon
3797 if ($^V && $^V ge 5.10.0 &&
3798 $realfile !~ m@/vmlinux.lds.h$@ &&
3799 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3800 my $ln = $linenr;
3801 my $cnt = $realcnt;
3802 my ($off, $dstat, $dcond, $rest);
3803 my $ctx = '';
3804 ($dstat, $dcond, $ln, $cnt, $off) =
3805 ctx_statement_block($linenr, $realcnt, 0);
3806 $ctx = $dstat;
3807
3808 $dstat =~ s/\\\n.//g;
3809
3810 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3811 my $stmts = $2;
3812 my $semis = $3;
3813
3814 $ctx =~ s/\n*$//;
3815 my $cnt = statement_rawlines($ctx);
3816 my $herectx = $here . "\n";
3817
3818 for (my $n = 0; $n < $cnt; $n++) {
3819 $herectx .= raw_line($linenr, $n) . "\n";
3820 }
3821
Joe Perchesac8e97f2012-08-21 16:15:53 -07003822 if (($stmts =~ tr/;/;/) == 1 &&
3823 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003824 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3825 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3826 }
3827 if (defined $semis && $semis ne "") {
3828 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3829 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3830 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07003831 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
3832 $ctx =~ s/\n*$//;
3833 my $cnt = statement_rawlines($ctx);
3834 my $herectx = $here . "\n";
3835
3836 for (my $n = 0; $n < $cnt; $n++) {
3837 $herectx .= raw_line($linenr, $n) . "\n";
3838 }
3839
3840 WARN("TRAILING_SEMICOLON",
3841 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07003842 }
3843 }
3844
Mike Frysinger080ba922009-01-06 14:41:25 -08003845# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3846# all assignments may have only one of the following with an assignment:
3847# .
3848# ALIGN(...)
3849# VMLINUX_SYMBOL(...)
3850 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003851 WARN("MISSING_VMLINUX_SYMBOL",
3852 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003853 }
3854
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003855# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003856 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3857 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003858 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003859 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003860 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3861 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003862 my @allowed = ();
3863 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003864 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003865 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003866 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003867 for my $chunk (@chunks) {
3868 my ($cond, $block) = @{$chunk};
3869
Andy Whitcroft773647a2008-03-28 14:15:58 -07003870 # If the condition carries leading newlines, then count those as offsets.
3871 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3872 my $offset = statement_rawlines($whitespace) - 1;
3873
Joe Perchesaad4f612012-03-23 15:02:19 -07003874 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003875 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3876
3877 # We have looked at and allowed this specific line.
3878 $suppress_ifbraces{$ln + $offset} = 1;
3879
3880 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003881 $ln += statement_rawlines($block) - 1;
3882
Andy Whitcroft773647a2008-03-28 14:15:58 -07003883 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003884
3885 $seen++ if ($block =~ /^\s*{/);
3886
Joe Perchesaad4f612012-03-23 15:02:19 -07003887 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003888 if (statement_lines($cond) > 1) {
3889 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003890 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003891 }
3892 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003893 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003894 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003895 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003896 if (statement_block_size($block) > 1) {
3897 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003898 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003899 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003900 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003901 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003902 if ($seen) {
3903 my $sum_allowed = 0;
3904 foreach (@allowed) {
3905 $sum_allowed += $_;
3906 }
3907 if ($sum_allowed == 0) {
3908 WARN("BRACES",
3909 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3910 } elsif ($sum_allowed != $allow &&
3911 $seen != $allow) {
3912 CHK("BRACES",
3913 "braces {} should be used on all arms of this statement\n" . $herectx);
3914 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003915 }
3916 }
3917 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003918 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003919 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003920 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003921
Andy Whitcroftcf655042008-03-04 14:28:20 -08003922 # Check the pre-context.
3923 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3924 #print "APW: ALLOWED: pre<$1>\n";
3925 $allowed = 1;
3926 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003927
3928 my ($level, $endln, @chunks) =
3929 ctx_statement_full($linenr, $realcnt, $-[0]);
3930
Andy Whitcroftcf655042008-03-04 14:28:20 -08003931 # Check the condition.
3932 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003933 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003934 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003935 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003936 }
3937 if (statement_lines($cond) > 1) {
3938 #print "APW: ALLOWED: cond<$cond>\n";
3939 $allowed = 1;
3940 }
3941 if ($block =~/\b(?:if|for|while)\b/) {
3942 #print "APW: ALLOWED: block<$block>\n";
3943 $allowed = 1;
3944 }
3945 if (statement_block_size($block) > 1) {
3946 #print "APW: ALLOWED: lines block<$block>\n";
3947 $allowed = 1;
3948 }
3949 # Check the post-context.
3950 if (defined $chunks[1]) {
3951 my ($cond, $block) = @{$chunks[1]};
3952 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003953 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003954 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003955 if ($block =~ /^\s*\{/) {
3956 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3957 $allowed = 1;
3958 }
3959 }
3960 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003961 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003962 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003963
Andy Whitcroftf0556632008-10-15 22:02:23 -07003964 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003965 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003966 }
3967
Joe Perches000d1cc12011-07-25 17:13:25 -07003968 WARN("BRACES",
3969 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003970 }
3971 }
3972
Joe Perches0979ae62012-12-17 16:01:59 -08003973# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003974 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003975 CHK("BRACES",
3976 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3977 }
Joe Perches77b9a532013-07-03 15:05:29 -07003978 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003979 CHK("BRACES",
3980 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3981 }
3982
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003983# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003984 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3985 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003986 WARN("VOLATILE",
3987 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003988 }
3989
Andy Whitcroft00df3442007-06-08 13:47:06 -07003990# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003991 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003992 CHK("REDUNDANT_CODE",
3993 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003994 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003995 }
3996
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003997# check for needless "if (<foo>) fn(<foo>)" uses
3998 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3999 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4000 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4001 WARN('NEEDLESS_IF',
4002 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004003 }
4004 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004005
Joe Perches8716de32013-09-11 14:24:05 -07004006# check for bad placement of section $InitAttribute (e.g.: __initdata)
4007 if ($line =~ /(\b$InitAttribute\b)/) {
4008 my $attr = $1;
4009 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4010 my $ptr = $1;
4011 my $var = $2;
4012 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4013 ERROR("MISPLACED_INIT",
4014 "$attr should be placed after $var\n" . $herecurr)) ||
4015 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4016 WARN("MISPLACED_INIT",
4017 "$attr should be placed after $var\n" . $herecurr))) &&
4018 $fix) {
4019 $fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
4020 }
4021 }
4022 }
4023
Joe Perchese970b882013-11-12 15:10:10 -08004024# check for $InitAttributeData (ie: __initdata) with const
4025 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4026 my $attr = $1;
4027 $attr =~ /($InitAttributePrefix)(.*)/;
4028 my $attr_prefix = $1;
4029 my $attr_type = $2;
4030 if (ERROR("INIT_ATTRIBUTE",
4031 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4032 $fix) {
4033 $fixed[$linenr - 1] =~
4034 s/$InitAttributeData/${attr_prefix}initconst/;
4035 }
4036 }
4037
4038# check for $InitAttributeConst (ie: __initconst) without const
4039 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4040 my $attr = $1;
4041 if (ERROR("INIT_ATTRIBUTE",
4042 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4043 $fix) {
4044 my $lead = $fixed[$linenr - 1] =~
4045 /(^\+\s*(?:static\s+))/;
4046 $lead = rtrim($1);
4047 $lead = "$lead " if ($lead !~ /^\+$/);
4048 $lead = "${lead}const ";
4049 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
4050 }
4051 }
4052
Joe Perchesfbdb8132014-04-03 14:49:14 -07004053# don't use __constant_<foo> functions outside of include/uapi/
4054 if ($realfile !~ m@^include/uapi/@ &&
4055 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4056 my $constant_func = $1;
4057 my $func = $constant_func;
4058 $func =~ s/^__constant_//;
4059 if (WARN("CONSTANT_CONVERSION",
4060 "$constant_func should be $func\n" . $herecurr) &&
4061 $fix) {
4062 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4063 }
4064 }
4065
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004066# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004067 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004068 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004069 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004070 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004071 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004072 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4073 }
4074 if ($delay > 2000) {
4075 WARN("LONG_UDELAY",
4076 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004077 }
4078 }
4079
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004080# warn about unexpectedly long msleep's
4081 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4082 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004083 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004084 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004085 }
4086 }
4087
Joe Perches36ec1932013-07-03 15:05:25 -07004088# check for comparisons of jiffies
4089 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4090 WARN("JIFFIES_COMPARISON",
4091 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4092 }
4093
Joe Perches9d7a34a2013-07-03 15:05:26 -07004094# check for comparisons of get_jiffies_64()
4095 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4096 WARN("JIFFIES_COMPARISON",
4097 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4098 }
4099
Andy Whitcroft00df3442007-06-08 13:47:06 -07004100# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004101# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004102# print "#ifdef in C files should be avoided\n";
4103# print "$herecurr";
4104# $clean = 0;
4105# }
4106
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004107# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004108 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004109 if (ERROR("SPACING",
4110 "exactly one space required after that #$1\n" . $herecurr) &&
4111 $fix) {
4112 $fixed[$linenr - 1] =~
4113 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4114 }
4115
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004116 }
4117
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004118# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004119 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4120 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004121 my $which = $1;
4122 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004123 CHK("UNCOMMENTED_DEFINITION",
4124 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004125 }
4126 }
4127# check for memory barriers without a comment.
4128 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4129 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004130 WARN("MEMORY_BARRIER",
4131 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004132 }
4133 }
4134# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004135 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004136 CHK("ARCH_DEFINES",
4137 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004138 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004139
Tobias Klauserd4977c72010-05-24 14:33:30 -07004140# Check that the storage class is at the beginning of a declaration
4141 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004142 WARN("STORAGE_CLASS",
4143 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004144 }
4145
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004146# check the location of the inline attribute, that it is between
4147# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004148 if ($line =~ /\b$Type\s+$Inline\b/ ||
4149 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004150 ERROR("INLINE_LOCATION",
4151 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004152 }
4153
Andy Whitcroft8905a672007-11-28 16:21:06 -08004154# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004155 if ($realfile !~ m@\binclude/uapi/@ &&
4156 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004157 if (WARN("INLINE",
4158 "plain inline is preferred over $1\n" . $herecurr) &&
4159 $fix) {
4160 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4161
4162 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004163 }
4164
Joe Perches3d130fd2011-01-12 17:00:00 -08004165# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004166 if ($realfile !~ m@\binclude/uapi/@ &&
4167 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004168 WARN("PREFER_PACKED",
4169 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004170 }
4171
Joe Perches39b7e282011-07-25 17:13:24 -07004172# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004173 if ($realfile !~ m@\binclude/uapi/@ &&
4174 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004175 WARN("PREFER_ALIGNED",
4176 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004177 }
4178
Joe Perches5f14d3b2012-01-10 15:09:52 -08004179# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004180 if ($realfile !~ m@\binclude/uapi/@ &&
4181 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004182 if (WARN("PREFER_PRINTF",
4183 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4184 $fix) {
4185 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4186
4187 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004188 }
4189
Joe Perches6061d942012-03-23 15:02:16 -07004190# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004191 if ($realfile !~ m@\binclude/uapi/@ &&
4192 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004193 if (WARN("PREFER_SCANF",
4194 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4195 $fix) {
4196 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4197 }
Joe Perches6061d942012-03-23 15:02:16 -07004198 }
4199
Joe Perches8f53a9b2010-03-05 13:43:48 -08004200# check for sizeof(&)
4201 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004202 WARN("SIZEOF_ADDRESS",
4203 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004204 }
4205
Joe Perches66c80b62012-07-30 14:41:22 -07004206# check for sizeof without parenthesis
4207 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004208 if (WARN("SIZEOF_PARENTHESIS",
4209 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4210 $fix) {
4211 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4212 }
Joe Perches66c80b62012-07-30 14:41:22 -07004213 }
4214
Joe Perches428e2fd2011-05-24 17:13:39 -07004215# check for line continuations in quoted strings with odd counts of "
4216 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004217 WARN("LINE_CONTINUATIONS",
4218 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004219 }
4220
Joe Perches88982fe2012-12-17 16:02:00 -08004221# check for struct spinlock declarations
4222 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4223 WARN("USE_SPINLOCK_T",
4224 "struct spinlock should be spinlock_t\n" . $herecurr);
4225 }
4226
Joe Perchesa6962d72013-04-29 16:18:13 -07004227# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004228 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004229 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004230 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004231 if (WARN("PREFER_SEQ_PUTS",
4232 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4233 $fix) {
4234 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4235 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004236 }
4237 }
4238
Andy Whitcroft554e1652012-01-10 15:09:57 -08004239# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004240 if ($^V && $^V ge 5.10.0 &&
4241 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004242 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004243
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004244 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004245 my $ms_val = $7;
4246 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004247
Andy Whitcroft554e1652012-01-10 15:09:57 -08004248 if ($ms_size =~ /^(0x|)0$/i) {
4249 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004250 "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 -08004251 } elsif ($ms_size =~ /^(0x|)1$/i) {
4252 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004253 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4254 }
4255 }
4256
Joe Perches98a9bba2014-01-23 15:54:52 -08004257# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4258 if ($^V && $^V ge 5.10.0 &&
4259 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4260 if (WARN("PREFER_ETHER_ADDR_COPY",
4261 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4262 $fix) {
4263 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4264 }
4265 }
4266
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004267# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004268 if ($^V && $^V ge 5.10.0 &&
4269 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004270 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004271 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004272 my $call = $1;
4273 my $cast1 = deparenthesize($2);
4274 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004275 my $cast2 = deparenthesize($7);
4276 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004277 my $cast;
4278
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004279 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004280 $cast = "$cast1 or $cast2";
4281 } elsif ($cast1 ne "") {
4282 $cast = $cast1;
4283 } else {
4284 $cast = $cast2;
4285 }
4286 WARN("MINMAX",
4287 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004288 }
4289 }
4290
Joe Perches4a273192012-07-30 14:41:20 -07004291# check usleep_range arguments
4292 if ($^V && $^V ge 5.10.0 &&
4293 defined $stat &&
4294 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4295 my $min = $1;
4296 my $max = $7;
4297 if ($min eq $max) {
4298 WARN("USLEEP_RANGE",
4299 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4300 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4301 $min > $max) {
4302 WARN("USLEEP_RANGE",
4303 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4304 }
4305 }
4306
Joe Perches823b7942013-11-12 15:10:15 -08004307# check for naked sscanf
4308 if ($^V && $^V ge 5.10.0 &&
4309 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004310 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004311 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4312 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4313 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4314 my $lc = $stat =~ tr@\n@@;
4315 $lc = $lc + $linenr;
4316 my $stat_real = raw_line($linenr, 0);
4317 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4318 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4319 }
4320 WARN("NAKED_SSCANF",
4321 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4322 }
4323
Joe Perchesafc819a2014-06-04 16:12:08 -07004324# check for simple sscanf that should be kstrto<foo>
4325 if ($^V && $^V ge 5.10.0 &&
4326 defined $stat &&
4327 $line =~ /\bsscanf\b/) {
4328 my $lc = $stat =~ tr@\n@@;
4329 $lc = $lc + $linenr;
4330 my $stat_real = raw_line($linenr, 0);
4331 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4332 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4333 }
4334 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4335 my $format = $6;
4336 my $count = $format =~ tr@%@%@;
4337 if ($count == 1 &&
4338 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4339 WARN("SSCANF_TO_KSTRTO",
4340 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4341 }
4342 }
4343 }
4344
Joe Perches70dc8a42013-09-11 14:23:58 -07004345# check for new externs in .h files.
4346 if ($realfile =~ /\.h$/ &&
4347 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004348 if (CHK("AVOID_EXTERNS",
4349 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004350 $fix) {
4351 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4352 }
4353 }
4354
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004355# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004356 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004357 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004358 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004359 my $function_name = $1;
4360 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004361
4362 my $s = $stat;
4363 if (defined $cond) {
4364 substr($s, 0, length($cond), '');
4365 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004366 if ($s =~ /^\s*;/ &&
4367 $function_name ne 'uninitialized_var')
4368 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004369 WARN("AVOID_EXTERNS",
4370 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004371 }
4372
4373 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004374 WARN("FUNCTION_ARGUMENTS",
4375 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004376 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004377
4378 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4379 $stat =~ /^.\s*extern\s+/)
4380 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004381 WARN("AVOID_EXTERNS",
4382 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004383 }
4384
4385# checks for new __setup's
4386 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4387 my $name = $1;
4388
4389 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004390 CHK("UNDOCUMENTED_SETUP",
4391 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004392 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004393 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004394
4395# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004396 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004397 WARN("UNNECESSARY_CASTS",
4398 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004399 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004400
Joe Perchesa640d252013-07-03 15:05:21 -07004401# alloc style
4402# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4403 if ($^V && $^V ge 5.10.0 &&
4404 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4405 CHK("ALLOC_SIZEOF_STRUCT",
4406 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4407 }
4408
Joe Perches60a55362014-06-04 16:12:07 -07004409# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4410 if ($^V && $^V ge 5.10.0 &&
4411 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) {
4412 my $oldfunc = $3;
4413 my $a1 = $4;
4414 my $a2 = $10;
4415 my $newfunc = "kmalloc_array";
4416 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
4417 if ($a1 =~ /^sizeof\s*\S/ || $a2 =~ /^sizeof\s*\S/) {
4418 if (WARN("ALLOC_WITH_MULTIPLY",
4419 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4420 $fix) {
4421 my $r1 = $a1;
4422 my $r2 = $a2;
4423 if ($a1 =~ /^sizeof\s*\S/) {
4424 $r1 = $a2;
4425 $r2 = $a1;
4426 }
4427 $fixed[$linenr - 1] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
4428
4429 }
4430 }
4431 }
4432
Joe Perches972fdea2013-04-29 16:18:12 -07004433# check for krealloc arg reuse
4434 if ($^V && $^V ge 5.10.0 &&
4435 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4436 WARN("KREALLOC_ARG_REUSE",
4437 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4438 }
4439
Joe Perches5ce59ae2013-02-21 16:44:18 -08004440# check for alloc argument mismatch
4441 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4442 WARN("ALLOC_ARRAY_ARGS",
4443 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4444 }
4445
Joe Perchescaf2a542011-01-12 16:59:56 -08004446# check for multiple semicolons
4447 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004448 if (WARN("ONE_SEMICOLON",
4449 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4450 $fix) {
4451 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4452 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004453 }
4454
Joe Perchesc34c09a2014-01-23 15:54:43 -08004455# check for case / default statements not preceeded by break/fallthrough/switch
4456 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4457 my $has_break = 0;
4458 my $has_statement = 0;
4459 my $count = 0;
4460 my $prevline = $linenr;
4461 while ($prevline > 1 && $count < 3 && !$has_break) {
4462 $prevline--;
4463 my $rline = $rawlines[$prevline - 1];
4464 my $fline = $lines[$prevline - 1];
4465 last if ($fline =~ /^\@\@/);
4466 next if ($fline =~ /^\-/);
4467 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4468 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4469 next if ($fline =~ /^.[\s$;]*$/);
4470 $has_statement = 1;
4471 $count++;
4472 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4473 }
4474 if (!$has_break && $has_statement) {
4475 WARN("MISSING_BREAK",
4476 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4477 }
4478 }
4479
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004480# check for switch/default statements without a break;
4481 if ($^V && $^V ge 5.10.0 &&
4482 defined $stat &&
4483 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4484 my $ctx = '';
4485 my $herectx = $here . "\n";
4486 my $cnt = statement_rawlines($stat);
4487 for (my $n = 0; $n < $cnt; $n++) {
4488 $herectx .= raw_line($linenr, $n) . "\n";
4489 }
4490 WARN("DEFAULT_NO_BREAK",
4491 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004492 }
4493
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004494# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004495 if ($line =~ /\b__FUNCTION__\b/) {
4496 if (WARN("USE_FUNC",
4497 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4498 $fix) {
4499 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4500 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004501 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004502
Joe Perches2c924882012-03-23 15:02:20 -07004503# check for use of yield()
4504 if ($line =~ /\byield\s*\(\s*\)/) {
4505 WARN("YIELD",
4506 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4507 }
4508
Joe Perches179f8f42013-07-03 15:05:30 -07004509# check for comparisons against true and false
4510 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4511 my $lead = $1;
4512 my $arg = $2;
4513 my $test = $3;
4514 my $otype = $4;
4515 my $trail = $5;
4516 my $op = "!";
4517
4518 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4519
4520 my $type = lc($otype);
4521 if ($type =~ /^(?:true|false)$/) {
4522 if (("$test" eq "==" && "$type" eq "true") ||
4523 ("$test" eq "!=" && "$type" eq "false")) {
4524 $op = "";
4525 }
4526
4527 CHK("BOOL_COMPARISON",
4528 "Using comparison to $otype is error prone\n" . $herecurr);
4529
4530## maybe suggesting a correct construct would better
4531## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4532
4533 }
4534 }
4535
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004536# check for semaphores initialized locked
4537 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004538 WARN("CONSIDER_COMPLETION",
4539 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004540 }
Joe Perches6712d852012-03-23 15:02:20 -07004541
Joe Perches67d0a072011-10-31 17:13:10 -07004542# recommend kstrto* over simple_strto* and strict_strto*
4543 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004544 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004545 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004546 }
Joe Perches6712d852012-03-23 15:02:20 -07004547
Michael Ellermanf3db6632008-07-23 21:28:57 -07004548# check for __initcall(), use device_initcall() explicitly please
4549 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004550 WARN("USE_DEVICE_INITCALL",
4551 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004552 }
Joe Perches6712d852012-03-23 15:02:20 -07004553
Emese Revfy79404842010-03-05 13:43:53 -08004554# check for various ops structs, ensure they are const.
4555 my $struct_ops = qr{acpi_dock_ops|
4556 address_space_operations|
4557 backlight_ops|
4558 block_device_operations|
4559 dentry_operations|
4560 dev_pm_ops|
4561 dma_map_ops|
4562 extent_io_ops|
4563 file_lock_operations|
4564 file_operations|
4565 hv_ops|
4566 ide_dma_ops|
4567 intel_dvo_dev_ops|
4568 item_operations|
4569 iwl_ops|
4570 kgdb_arch|
4571 kgdb_io|
4572 kset_uevent_ops|
4573 lock_manager_operations|
4574 microcode_ops|
4575 mtrr_ops|
4576 neigh_ops|
4577 nlmsvc_binding|
4578 pci_raw_ops|
4579 pipe_buf_operations|
4580 platform_hibernation_ops|
4581 platform_suspend_ops|
4582 proto_ops|
4583 rpc_pipe_ops|
4584 seq_operations|
4585 snd_ac97_build_ops|
4586 soc_pcmcia_socket_ops|
4587 stacktrace_ops|
4588 sysfs_ops|
4589 tty_operations|
4590 usb_mon_operations|
4591 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004592 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004593 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004594 WARN("CONST_STRUCT",
4595 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004596 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004597 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004598
4599# use of NR_CPUS is usually wrong
4600# ignore definitions of NR_CPUS and usage to define arrays as likely right
4601 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004602 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4603 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004604 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4605 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4606 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004607 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004608 WARN("NR_CPUS",
4609 "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 -07004610 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004611
Joe Perches52ea8502013-11-12 15:10:09 -08004612# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4613 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4614 ERROR("DEFINE_ARCH_HAS",
4615 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4616 }
4617
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004618# check for %L{u,d,i} in strings
4619 my $string;
4620 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4621 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004622 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004623 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004624 WARN("PRINTF_L",
4625 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004626 last;
4627 }
4628 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004629
4630# whine mightly about in_atomic
4631 if ($line =~ /\bin_atomic\s*\(/) {
4632 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004633 ERROR("IN_ATOMIC",
4634 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004635 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004636 WARN("IN_ATOMIC",
4637 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004638 }
4639 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004640
4641# check for lockdep_set_novalidate_class
4642 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4643 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4644 if ($realfile !~ m@^kernel/lockdep@ &&
4645 $realfile !~ m@^include/linux/lockdep@ &&
4646 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004647 ERROR("LOCKDEP",
4648 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004649 }
4650 }
Dave Jones88f88312011-01-12 16:59:59 -08004651
4652 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4653 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004654 WARN("EXPORTED_WORLD_WRITABLE",
4655 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004656 }
Joe Perches24358802014-04-03 14:49:13 -07004657
Joe Perches515a2352014-04-03 14:49:24 -07004658# Mode permission misuses where it seems decimal should be octal
4659# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4660 if ($^V && $^V ge 5.10.0 &&
4661 $line =~ /$mode_perms_search/) {
4662 foreach my $entry (@mode_permission_funcs) {
4663 my $func = $entry->[0];
4664 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004665
Joe Perches515a2352014-04-03 14:49:24 -07004666 my $skip_args = "";
4667 if ($arg_pos > 1) {
4668 $arg_pos--;
4669 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4670 }
4671 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4672 if ($line =~ /$test/) {
4673 my $val = $1;
4674 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004675
Joe Perches515a2352014-04-03 14:49:24 -07004676 if ($val !~ /^0$/ &&
4677 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4678 length($val) ne 4)) {
4679 ERROR("NON_OCTAL_PERMISSIONS",
4680 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4681 }
Joe Perches24358802014-04-03 14:49:13 -07004682 }
4683 }
4684 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004685 }
4686
4687 # If we have no input at all, then there is nothing to report on
4688 # so just keep quiet.
4689 if ($#rawlines == -1) {
4690 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004691 }
4692
Andy Whitcroft8905a672007-11-28 16:21:06 -08004693 # In mailback mode only produce a report in the negative, for
4694 # things that appear to be patches.
4695 if ($mailback && ($clean == 1 || !$is_patch)) {
4696 exit(0);
4697 }
4698
4699 # This is not a patch, and we are are in 'no-patch' mode so
4700 # just keep quiet.
4701 if (!$chk_patch && !$is_patch) {
4702 exit(0);
4703 }
4704
4705 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004706 ERROR("NOT_UNIFIED_DIFF",
4707 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004708 }
4709 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004710 ERROR("MISSING_SIGN_OFF",
4711 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004712 }
4713
Andy Whitcroft8905a672007-11-28 16:21:06 -08004714 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004715 if ($summary && !($clean == 1 && $quiet == 1)) {
4716 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004717 print "total: $cnt_error errors, $cnt_warn warnings, " .
4718 (($check)? "$cnt_chk checks, " : "") .
4719 "$cnt_lines lines checked\n";
4720 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004721 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004722
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004723 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004724
4725 if ($^V lt 5.10.0) {
4726 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4727 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4728 }
4729
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004730 # If there were whitespace errors which cleanpatch can fix
4731 # then suggest that.
4732 if ($rpt_cleaners) {
4733 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4734 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004735 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004736 }
4737 }
4738
Joe Perches91bfe482013-09-11 14:23:59 -07004739 hash_show_words(\%use_type, "Used");
4740 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004741
Joe Perches3705ce52013-07-03 15:05:31 -07004742 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004743 my $newfile = $filename;
4744 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004745 my $linecount = 0;
4746 my $f;
4747
4748 open($f, '>', $newfile)
4749 or die "$P: Can't open $newfile for write\n";
4750 foreach my $fixed_line (@fixed) {
4751 $linecount++;
4752 if ($file) {
4753 if ($linecount > 3) {
4754 $fixed_line =~ s/^\+//;
4755 print $f $fixed_line. "\n";
4756 }
4757 } else {
4758 print $f $fixed_line . "\n";
4759 }
4760 }
4761 close($f);
4762
4763 if (!$quiet) {
4764 print << "EOM";
4765Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4766
4767Do _NOT_ trust the results written to this file.
4768Do _NOT_ submit these changes without inspecting them for correctness.
4769
4770This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4771No warranties, expressed or implied...
4772
4773EOM
4774 }
4775 }
4776
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004777 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004778 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004779 }
4780 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004781 print << "EOM";
4782$vname has style problems, please review.
4783
4784If any of these errors are false positives, please report
4785them to the maintainer, see CHECKPATCH in MAINTAINERS.
4786EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004787 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004788
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004789 return $clean;
4790}