blob: fad2116f51a445b005617ba568d7d45e52dc21f0 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070027my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080028my $summary = 1;
29my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080030my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070031my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070032my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080033my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070034my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080035my %debug;
Joe Perches34456862013-07-03 15:05:34 -070036my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070037my %use_type = ();
38my @use = ();
39my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070040my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070041my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070042my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080043my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070044my $ignore_perl_version = 0;
45my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070046
47sub help {
48 my ($exitcode) = @_;
49
50 print << "EOM";
51Usage: $P [OPTION]... [FILE]...
52Version: $V
53
54Options:
55 -q, --quiet quiet
56 --no-tree run without a kernel tree
57 --no-signoff do not check for 'Signed-off-by' line
58 --patch treat FILE as patchfile (default)
59 --emacs emacs compile window format
60 --terse one line per report
61 -f, --file treat FILE as regular source file
62 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070063 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070064 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080065 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070066 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070067 --root=PATH PATH to the kernel tree root
68 --no-summary suppress the per-file summary
69 --mailback only produce a report in case of warnings/errors
70 --summary-file include the filename in summary
71 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
72 'values', 'possible', 'type', and 'attr' (default
73 is all off)
74 --test-only=WORD report only warnings/errors containing WORD
75 literally
Joe Perches3705ce52013-07-03 15:05:31 -070076 --fix EXPERIMENTAL - may create horrible results
77 If correctable single-line errors exist, create
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
80 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080081 --fix-inplace EXPERIMENTAL - may create horrible results
82 Is the same as --fix, but overwrites the input
83 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070084 --ignore-perl-version override checking of perl version. expect
85 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070086 -h, --help, --version display this help and exit
87
88When FILE is - read standard input.
89EOM
90
91 exit($exitcode);
92}
93
Joe Perches000d1cc12011-07-25 17:13:25 -070094my $conf = which_conf($configuration_file);
95if (-f $conf) {
96 my @conf_args;
97 open(my $conffile, '<', "$conf")
98 or warn "$P: Can't find a readable $configuration_file file $!\n";
99
100 while (<$conffile>) {
101 my $line = $_;
102
103 $line =~ s/\s*\n?$//g;
104 $line =~ s/^\s*//g;
105 $line =~ s/\s+/ /g;
106
107 next if ($line =~ m/^\s*#/);
108 next if ($line =~ m/^\s*$/);
109
110 my @words = split(" ", $line);
111 foreach my $word (@words) {
112 last if ($word =~ m/^#/);
113 push (@conf_args, $word);
114 }
115 }
116 close($conffile);
117 unshift(@ARGV, @conf_args) if @conf_args;
118}
119
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700120GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700121 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700122 'tree!' => \$tree,
123 'signoff!' => \$chk_signoff,
124 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700125 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800126 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700127 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700128 'subjective!' => \$check,
129 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700130 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700131 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700132 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800133 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700134 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800135 'summary!' => \$summary,
136 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800137 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700138 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800139 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700140 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800141 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700142 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700143 'h|help' => \$help,
144 'version' => \$help
145) or help(1);
146
147help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700148
Joe Perches9624b8d2014-01-23 15:54:44 -0800149$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700150$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800151
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700152my $exit = 0;
153
Dave Hansend62a2012013-09-11 14:23:56 -0700154if ($^V && $^V lt $minimum_perl_version) {
155 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
156 if (!$ignore_perl_version) {
157 exit(1);
158 }
159}
160
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700161if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700162 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700163 exit(1);
164}
165
Joe Perches91bfe482013-09-11 14:23:59 -0700166sub hash_save_array_words {
167 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700168
Joe Perches91bfe482013-09-11 14:23:59 -0700169 my @array = split(/,/, join(',', @$arrayRef));
170 foreach my $word (@array) {
171 $word =~ s/\s*\n?$//g;
172 $word =~ s/^\s*//g;
173 $word =~ s/\s+/ /g;
174 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700175
Joe Perches91bfe482013-09-11 14:23:59 -0700176 next if ($word =~ m/^\s*#/);
177 next if ($word =~ m/^\s*$/);
178
179 $hashRef->{$word}++;
180 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700181}
182
Joe Perches91bfe482013-09-11 14:23:59 -0700183sub hash_show_words {
184 my ($hashRef, $prefix) = @_;
185
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700188 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700189 print " $word";
190 }
191 print "\n\n";
192 }
193}
194
195hash_save_array_words(\%ignore_type, \@ignore);
196hash_save_array_words(\%use_type, \@use);
197
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800198my $dbg_values = 0;
199my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700200my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700201my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800202for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800203 ## no critic
204 eval "\${dbg_$key} = '$debug{$key}';";
205 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800206}
207
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700208my $rpt_cleaners = 0;
209
Andy Whitcroft8905a672007-11-28 16:21:06 -0800210if ($terse) {
211 $emacs = 1;
212 $quiet++;
213}
214
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700215if ($tree) {
216 if (defined $root) {
217 if (!top_of_kernel_tree($root)) {
218 die "$P: $root: --root does not point at a valid tree\n";
219 }
220 } else {
221 if (top_of_kernel_tree('.')) {
222 $root = '.';
223 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
224 top_of_kernel_tree($1)) {
225 $root = $1;
226 }
227 }
228
229 if (!defined $root) {
230 print "Must be run from the top-level dir. of a kernel tree\n";
231 exit(2);
232 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700233}
234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235my $emitted_corrupt = 0;
236
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700237our $Ident = qr{
238 [A-Za-z_][A-Za-z\d_]*
239 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
240 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700241our $Storage = qr{extern|static|asmlinkage};
242our $Sparse = qr{
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800249 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700250 __ref|
251 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700252 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800253our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
254our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
255our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
256our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
257our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700258
Wolfram Sang52131292010-03-05 13:43:51 -0800259# Notes to $Attribute:
260# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261our $Attribute = qr{
262 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700277 __read_mostly|
278 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700279 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800282 ____cacheline_internodealigned_in_smp|
283 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700285our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700286our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700287our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
288our $Lval = qr{$Ident(?:$Member)*};
289
Joe Perches95e2c602013-07-03 15:05:20 -0700290our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
291our $Binary = qr{(?i)0b[01]+$Int_type?};
292our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
293our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700294our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800295our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
296our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
297our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800298our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700299our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800300our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700301our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700302our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303our $Operators = qr{
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700306 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700307 }x;
308
Joe Perches91cb5192014-04-03 14:49:32 -0700309our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
310
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700312our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800313our $Type;
314our $Declare;
315
Joe Perches15662b32011-10-31 17:13:12 -0700316our $NON_ASCII_UTF8 = qr{
317 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700318 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
319 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
320 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
321 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
322 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
323 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
324}x;
325
Joe Perches15662b32011-10-31 17:13:12 -0700326our $UTF8 = qr{
327 [\x09\x0A\x0D\x20-\x7E] # ASCII
328 | $NON_ASCII_UTF8
329}x;
330
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700331our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700332 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700333 atomic_t
334)};
335
Joe Perches691e6692010-03-05 13:43:51 -0800336our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700337 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700338 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700339 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700340 panic|
Joe Perches06668722013-11-12 15:10:07 -0800341 MODULE_[A-Z_]+|
342 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800343)};
344
Joe Perches20112472011-07-25 17:13:23 -0700345our $signature_tags = qr{(?xi:
346 Signed-off-by:|
347 Acked-by:|
348 Tested-by:|
349 Reviewed-by:|
350 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700351 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700352 To:|
353 Cc:
354)};
355
Andy Whitcroft8905a672007-11-28 16:21:06 -0800356our @typeList = (
357 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700358 qr{(?:unsigned\s+)?char},
359 qr{(?:unsigned\s+)?short},
360 qr{(?:unsigned\s+)?int},
361 qr{(?:unsigned\s+)?long},
362 qr{(?:unsigned\s+)?long\s+int},
363 qr{(?:unsigned\s+)?long\s+long},
364 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800365 qr{unsigned},
366 qr{float},
367 qr{double},
368 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800369 qr{struct\s+$Ident},
370 qr{union\s+$Ident},
371 qr{enum\s+$Ident},
372 qr{${Ident}_t},
373 qr{${Ident}_handler},
374 qr{${Ident}_handler_fn},
375);
Joe Perches8716de32013-09-11 14:24:05 -0700376our @typeListWithAttr = (
377 @typeList,
378 qr{struct\s+$InitAttribute\s+$Ident},
379 qr{union\s+$InitAttribute\s+$Ident},
380);
381
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700382our @modifierList = (
383 qr{fastcall},
384);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385
Joe Perches24358802014-04-03 14:49:13 -0700386our @mode_permission_funcs = (
387 ["module_param", 3],
388 ["module_param_(?:array|named|string)", 4],
389 ["module_param_array_named", 5],
390 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
391 ["proc_create(?:_data|)", 2],
392 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
393);
394
Joe Perches515a2352014-04-03 14:49:24 -0700395#Create a search pattern for all these functions to speed up a loop below
396our $mode_perms_search = "";
397foreach my $entry (@mode_permission_funcs) {
398 $mode_perms_search .= '|' if ($mode_perms_search ne "");
399 $mode_perms_search .= $entry->[0];
400}
401
Joe Perches3f7bac02014-06-04 16:12:04 -0700402our $declaration_macros = qr{(?x:
403 (?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(|
404 (?:$Storage\s+)?LIST_HEAD\s*\(
405)};
406
Wolfram Sang7840a942010-08-09 17:20:57 -0700407our $allowed_asm_includes = qr{(?x:
408 irq|
409 memory
410)};
411# memory.h: ARM has a custom one
412
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700414 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
415 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700416 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700417 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800418 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700419 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800420 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800421 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700423 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800424 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700425 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700427 $NonptrTypeWithAttr = qr{
428 (?:$Modifier\s+|const\s+)*
429 (?:
430 (?:typeof|__typeof__)\s*\([^\)]*\)|
431 (?:$typeTypedefs\b)|
432 (?:${allWithAttr}\b)
433 )
434 (?:\s+$Modifier|\s+const)*
435 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800436 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700437 $NonptrType
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 Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700790 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700791 } elsif ($sanitise_quote eq $c) {
792 $sanitise_quote = '';
Andy Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700803 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700804 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -07001176sub cat_vet {
1177 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001178 my ($res, $coded);
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -07001189
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001190 return $res;
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -07001622sub process {
1623 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001624
1625 my $linenr=0;
1626 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001627 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001628 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001629 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001630
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001631 my $length;
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -07001637 my $signoff = 0;
1638 my $is_patch = 0;
1639
Joe Perches29ee1b02014-08-06 16:10:35 -07001640 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001641 my $in_commit_log = 0; #Scanning lines before patch
1642
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001643 my $non_utf8_charset = 0;
1644
Joe Perches365dd4e2014-08-06 16:10:42 -07001645 my $last_blank_line = 0;
1646
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001647 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001648 our $cnt_lines = 0;
1649 our $cnt_error = 0;
1650 our $cnt_warn = 0;
1651 our $cnt_chk = 0;
1652
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001653 # Trace the real file/line as we go.
1654 my $realfile = '';
1655 my $realline = 0;
1656 my $realcnt = 0;
1657 my $here = '';
1658 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001659 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001660 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001661 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001662
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001663 my $prev_values = 'E';
1664
1665 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001666 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001667 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001668 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001669 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001670
Joe Perches7e51f192013-09-11 14:23:57 -07001671 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001672
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001673 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001674 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001675 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001676 my @setup_docs = ();
1677 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001678
Joe Perchesd8b07712013-11-12 15:10:06 -08001679 my $camelcase_file_seeded = 0;
1680
Andy Whitcroft773647a2008-03-28 14:15:58 -07001681 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001682 my $line;
1683 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001684 $linenr++;
1685 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001686
Joe Perches3705ce52013-07-03 15:05:31 -07001687 push(@fixed, $rawline) if ($fix);
1688
Andy Whitcroft773647a2008-03-28 14:15:58 -07001689 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001690 $setup_docs = 0;
1691 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1692 $setup_docs = 1;
1693 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001694 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001695 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001696 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1697 $realline=$1-1;
1698 if (defined $2) {
1699 $realcnt=$3+1;
1700 } else {
1701 $realcnt=1+1;
1702 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001703 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001704
1705 # Guestimate if this is a continuing comment. Run
1706 # the context looking for a comment "edge". If this
1707 # edge is a close comment then we must be in a comment
1708 # at context start.
1709 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001710 my $cnt = $realcnt;
1711 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1712 next if (defined $rawlines[$ln - 1] &&
1713 $rawlines[$ln - 1] =~ /^-/);
1714 $cnt--;
1715 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001716 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001717 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1718 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1719 ($edge) = $1;
1720 last;
1721 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001722 }
1723 if (defined $edge && $edge eq '*/') {
1724 $in_comment = 1;
1725 }
1726
1727 # Guestimate if this is a continuing comment. If this
1728 # is the start of a diff block and this line starts
1729 # ' *' then it is very likely a comment.
1730 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001731 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001732 {
1733 $in_comment = 1;
1734 }
1735
1736 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1737 sanitise_line_reset($in_comment);
1738
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001739 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001740 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001741 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001742 $line = sanitise_line($rawline);
1743 }
1744 push(@lines, $line);
1745
1746 if ($realcnt > 1) {
1747 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1748 } else {
1749 $realcnt = 0;
1750 }
1751
1752 #print "==>$rawline\n";
1753 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001754
1755 if ($setup_docs && $line =~ /^\+/) {
1756 push(@setup_docs, $line);
1757 }
1758 }
1759
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001760 $prefix = '';
1761
Andy Whitcroft773647a2008-03-28 14:15:58 -07001762 $realcnt = 0;
1763 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001764 foreach my $line (@lines) {
1765 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001766 my $sline = $line; #copy of $line
1767 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001768
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001769 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001770
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001771#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001772 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001773 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001774 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001775 $realline=$1-1;
1776 if (defined $2) {
1777 $realcnt=$3+1;
1778 } else {
1779 $realcnt=1+1;
1780 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001781 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001782 $prev_values = 'E';
1783
Andy Whitcroft773647a2008-03-28 14:15:58 -07001784 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001785 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001786 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001787 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001788 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001789
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001790# track the line number as we move through the hunk, note that
1791# new versions of GNU diff omit the leading space on completely
1792# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001793 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001794 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001795 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001796
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001797 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001798 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001799
1800 # Track the previous line.
1801 ($prevline, $stashline) = ($stashline, $line);
1802 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001803 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1804
Andy Whitcroft773647a2008-03-28 14:15:58 -07001805 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001806
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001807 } elsif ($realcnt == 1) {
1808 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001809 }
1810
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001811 my $hunk_line = ($realcnt != 0);
1812
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001813#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001814 $prefix = "$filename:$realline: " if ($emacs && $file);
1815 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1816
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001817 $here = "#$linenr: " if (!$file);
1818 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001819
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001820 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001821 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001822 if ($line =~ /^diff --git.*?(\S+)$/) {
1823 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001824 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001825 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001826 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001827 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001828 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001829 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001830 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001831
1832 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001833 if (!$file && $tree && $p1_prefix ne '' &&
1834 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001835 WARN("PATCH_PREFIX",
1836 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001837 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001838
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001839 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001840 ERROR("MODIFIED_INCLUDE_ASM",
1841 "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 -07001842 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001843 $found_file = 1;
1844 }
1845
1846 if ($found_file) {
1847 if ($realfile =~ m@^(drivers/net/|net/)@) {
1848 $check = 1;
1849 } else {
1850 $check = $check_orig;
1851 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001852 next;
1853 }
1854
Randy Dunlap389834b2007-06-08 13:47:03 -07001855 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001856
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001857 my $hereline = "$here\n$rawline\n";
1858 my $herecurr = "$here\n$rawline\n";
1859 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001860
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001861 $cnt_lines++ if ($realcnt != 0);
1862
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001863# Check for incorrect file permissions
1864 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1865 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001866 if ($realfile !~ m@scripts/@ &&
1867 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001868 ERROR("EXECUTE_PERMISSIONS",
1869 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001870 }
1871 }
1872
Joe Perches20112472011-07-25 17:13:23 -07001873# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001874 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001875 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001876 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001877 }
1878
1879# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001880 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001881 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001882 my $space_before = $1;
1883 my $sign_off = $2;
1884 my $space_after = $3;
1885 my $email = $4;
1886 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1887
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001888 if ($sign_off !~ /$signature_tags/) {
1889 WARN("BAD_SIGN_OFF",
1890 "Non-standard signature: $sign_off\n" . $herecurr);
1891 }
Joe Perches20112472011-07-25 17:13:23 -07001892 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001893 if (WARN("BAD_SIGN_OFF",
1894 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1895 $fix) {
1896 $fixed[$linenr - 1] =
1897 "$ucfirst_sign_off $email";
1898 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001899 }
Joe Perches20112472011-07-25 17:13:23 -07001900 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001901 if (WARN("BAD_SIGN_OFF",
1902 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1903 $fix) {
1904 $fixed[$linenr - 1] =
1905 "$ucfirst_sign_off $email";
1906 }
1907
Joe Perches20112472011-07-25 17:13:23 -07001908 }
1909 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001910 if (WARN("BAD_SIGN_OFF",
1911 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1912 $fix) {
1913 $fixed[$linenr - 1] =
1914 "$ucfirst_sign_off $email";
1915 }
Joe Perches20112472011-07-25 17:13:23 -07001916 }
1917
1918 my ($email_name, $email_address, $comment) = parse_email($email);
1919 my $suggested_email = format_email(($email_name, $email_address));
1920 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001921 ERROR("BAD_SIGN_OFF",
1922 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001923 } else {
1924 my $dequoted = $suggested_email;
1925 $dequoted =~ s/^"//;
1926 $dequoted =~ s/" </ </;
1927 # Don't force email to have quotes
1928 # Allow just an angle bracketed address
1929 if ("$dequoted$comment" ne $email &&
1930 "<$email_address>$comment" ne $email &&
1931 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001932 WARN("BAD_SIGN_OFF",
1933 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001934 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001935 }
Joe Perches7e51f192013-09-11 14:23:57 -07001936
1937# Check for duplicate signatures
1938 my $sig_nospace = $line;
1939 $sig_nospace =~ s/\s//g;
1940 $sig_nospace = lc($sig_nospace);
1941 if (defined $signatures{$sig_nospace}) {
1942 WARN("BAD_SIGN_OFF",
1943 "Duplicate signature\n" . $herecurr);
1944 } else {
1945 $signatures{$sig_nospace} = 1;
1946 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001947 }
1948
Joe Perches9b3189eb2014-06-04 16:12:10 -07001949# Check for old stable address
1950 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
1951 ERROR("STABLE_ADDRESS",
1952 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
1953 }
1954
Christopher Covington7ebd05e2014-04-03 14:49:31 -07001955# Check for unwanted Gerrit info
1956 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1957 ERROR("GERRIT_CHANGE_ID",
1958 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
1959 }
1960
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001961# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001962 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001963 ERROR("CORRUPTED_PATCH",
1964 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001965 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001966 }
1967
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001968# Check for absolute kernel paths.
1969 if ($tree) {
1970 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1971 my $file = $1;
1972
1973 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1974 check_absolute_file($1, $herecurr)) {
1975 #
1976 } else {
1977 check_absolute_file($file, $herecurr);
1978 }
1979 }
1980 }
1981
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001982# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1983 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001984 $rawline !~ m/^$UTF8*$/) {
1985 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1986
1987 my $blank = copy_spacing($rawline);
1988 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1989 my $hereptr = "$hereline$ptr\n";
1990
Joe Perches34d99212011-07-25 17:13:26 -07001991 CHK("INVALID_UTF8",
1992 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001993 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001994
Joe Perches15662b32011-10-31 17:13:12 -07001995# Check if it's the start of a commit log
1996# (not a header line and we haven't seen the patch filename)
1997 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07001998 !($rawline =~ /^\s+\S/ ||
1999 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002000 $in_header_lines = 0;
2001 $in_commit_log = 1;
2002 }
2003
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002004# Check if there is UTF-8 in a commit log when a mail header has explicitly
2005# declined it, i.e defined some charset where it is missing.
2006 if ($in_header_lines &&
2007 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2008 $1 !~ /utf-8/i) {
2009 $non_utf8_charset = 1;
2010 }
2011
2012 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002013 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002014 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002015 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2016 }
2017
Andy Whitcroft306708542008-10-15 22:02:28 -07002018# ignore non-hunk lines and lines being removed
2019 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002020
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002021#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002022 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002023 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002024 if (ERROR("DOS_LINE_ENDINGS",
2025 "DOS line endings\n" . $herevet) &&
2026 $fix) {
2027 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2028 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002029 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2030 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002031 if (ERROR("TRAILING_WHITESPACE",
2032 "trailing whitespace\n" . $herevet) &&
2033 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002034 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002035 }
2036
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002037 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002038 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002039
Josh Triplett4783f892013-11-12 15:10:12 -08002040# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002041 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002042 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2043 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002044 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2045 my $msg_type = \&ERROR;
2046 $msg_type = \&CHK if ($file);
2047 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002048 "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 -08002049 }
2050
Andi Kleen33549572010-05-24 14:33:29 -07002051# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002052# Only applies when adding the entry originally, after that we do not have
2053# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002054 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08002055 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002056 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002057 my $cnt = $realcnt;
2058 my $ln = $linenr + 1;
2059 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002060 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002061 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002062 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002063 $f = $lines[$ln - 1];
2064 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2065 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002066
2067 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002068
2069 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2070 $is_start = 1;
2071 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2072 $length = -1;
2073 }
2074
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002075 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002076 $f =~ s/#.*//;
2077 $f =~ s/^\s+//;
2078 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002079 if ($f =~ /^\s*config\s/) {
2080 $is_end = 1;
2081 last;
2082 }
Andi Kleen33549572010-05-24 14:33:29 -07002083 $length++;
2084 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002085 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002086 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2087 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002088 }
2089
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002090# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2091 if ($realfile =~ /Kconfig/ &&
2092 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2093 WARN("CONFIG_EXPERIMENTAL",
2094 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2095 }
2096
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002097 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2098 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2099 my $flag = $1;
2100 my $replacement = {
2101 'EXTRA_AFLAGS' => 'asflags-y',
2102 'EXTRA_CFLAGS' => 'ccflags-y',
2103 'EXTRA_CPPFLAGS' => 'cppflags-y',
2104 'EXTRA_LDFLAGS' => 'ldflags-y',
2105 };
2106
2107 WARN("DEPRECATED_VARIABLE",
2108 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2109 }
2110
Rob Herringbff5da42014-01-23 15:54:51 -08002111# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002112 if (defined $root &&
2113 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2114 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2115
Rob Herringbff5da42014-01-23 15:54:51 -08002116 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2117
Florian Vaussardcc933192014-04-03 14:49:27 -07002118 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2119 my $vp_file = $dt_path . "vendor-prefixes.txt";
2120
Rob Herringbff5da42014-01-23 15:54:51 -08002121 foreach my $compat (@compats) {
2122 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002123 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2124 my $compat3 = $compat;
2125 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2126 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002127 if ( $? >> 8 ) {
2128 WARN("UNDOCUMENTED_DT_STRING",
2129 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2130 }
2131
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002132 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2133 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002134 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002135 if ( $? >> 8 ) {
2136 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002137 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002138 }
2139 }
2140 }
2141
Andy Whitcroft5368df202008-10-15 22:02:27 -07002142# check we are in a valid source file if not then ignore this hunk
2143 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2144
Joe Perches6cd7f382012-12-17 16:01:54 -08002145#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002146 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002147 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002148 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002149 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002150 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002151 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002152 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002153 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002154 }
2155
Josh Triplettca56dc02012-03-23 15:02:21 -07002156# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002157# to grep for the string. Make exceptions when the previous string ends in a
2158# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2159# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002160 if ($line =~ /^\+\s*"/ &&
2161 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002162 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002163 WARN("SPLIT_STRING",
2164 "quoted string split across lines\n" . $hereprev);
2165 }
2166
Joe Perches5e79d962010-03-05 13:43:55 -08002167# check for spaces before a quoted newline
2168 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002169 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2170 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2171 $fix) {
2172 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2173 }
2174
Joe Perches5e79d962010-03-05 13:43:55 -08002175 }
2176
Andy Whitcroft8905a672007-11-28 16:21:06 -08002177# check for adding lines without a newline.
2178 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002179 WARN("MISSING_EOF_NEWLINE",
2180 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002181 }
2182
Mike Frysinger42e41c52009-09-21 17:04:40 -07002183# Blackfin: use hi/lo macros
2184 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2185 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2186 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002187 ERROR("LO_MACRO",
2188 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002189 }
2190 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2191 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002192 ERROR("HI_MACRO",
2193 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002194 }
2195 }
2196
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002197# check we are in a valid source file C or perl if not then ignore this hunk
2198 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002199
2200# at the beginning of a line any tabs must come first and anything
2201# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002202 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2203 $rawline =~ /^\+\s* \s*/) {
2204 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002205 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002206 if (ERROR("CODE_INDENT",
2207 "code indent should use tabs where possible\n" . $herevet) &&
2208 $fix) {
2209 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2210 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002211 }
2212
Alberto Panizzo08e44362010-03-05 13:43:54 -08002213# check for space before tabs.
2214 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2215 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002216 if (WARN("SPACE_BEFORE_TAB",
2217 "please, no space before tabs\n" . $herevet) &&
2218 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002219 while ($fixed[$linenr - 1] =~
2220 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2221 while ($fixed[$linenr - 1] =~
2222 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002223 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002224 }
2225
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002226# check for && or || at the start of a line
2227 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2228 CHK("LOGICAL_CONTINUATIONS",
2229 "Logical continuations should be on the previous line\n" . $hereprev);
2230 }
2231
2232# check multi-line statement indentation matches previous line
2233 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002234 $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 -07002235 $prevline =~ /^\+(\t*)(.*)$/;
2236 my $oldindent = $1;
2237 my $rest = $2;
2238
2239 my $pos = pos_last_openparen($rest);
2240 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002241 $line =~ /^(\+| )([ \t]*)/;
2242 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002243
2244 my $goodtabindent = $oldindent .
2245 "\t" x ($pos / 8) .
2246 " " x ($pos % 8);
2247 my $goodspaceindent = $oldindent . " " x $pos;
2248
2249 if ($newindent ne $goodtabindent &&
2250 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002251
2252 if (CHK("PARENTHESIS_ALIGNMENT",
2253 "Alignment should match open parenthesis\n" . $hereprev) &&
2254 $fix && $line =~ /^\+/) {
2255 $fixed[$linenr - 1] =~
2256 s/^\+[ \t]*/\+$goodtabindent/;
2257 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002258 }
2259 }
2260 }
2261
Joe Perches23f780c2013-07-03 15:05:31 -07002262 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002263 if (CHK("SPACING",
2264 "No space is necessary after a cast\n" . $hereprev) &&
2265 $fix) {
2266 $fixed[$linenr - 1] =~
2267 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2268 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002269 }
2270
Joe Perches05880602012-10-04 17:13:35 -07002271 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002272 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002273 $rawline =~ /^\+[ \t]*\*/ &&
2274 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002275 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2276 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2277 }
2278
2279 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002280 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2281 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002282 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002283 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2284 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2285 "networking block comments start with * on subsequent lines\n" . $hereprev);
2286 }
2287
2288 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002289 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2290 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2291 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2292 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002293 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2294 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2295 }
2296
Joe Perches7f619192014-08-06 16:10:39 -07002297# check for missing blank lines after struct/union declarations
2298# with exceptions for various attributes and macros
2299 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2300 $line =~ /^\+/ &&
2301 !($line =~ /^\+\s*$/ ||
2302 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2303 $line =~ /^\+\s*MODULE_/i ||
2304 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2305 $line =~ /^\+[a-z_]*init/ ||
2306 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2307 $line =~ /^\+\s*DECLARE/ ||
2308 $line =~ /^\+\s*__setup/)) {
2309 CHK("LINE_SPACING",
2310 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev);
2311 }
2312
Joe Perches365dd4e2014-08-06 16:10:42 -07002313# check for multiple consecutive blank lines
2314 if ($prevline =~ /^[\+ ]\s*$/ &&
2315 $line =~ /^\+\s*$/ &&
2316 $last_blank_line != ($linenr - 1)) {
2317 CHK("LINE_SPACING",
2318 "Please don't use multiple blank lines\n" . $hereprev);
2319 $last_blank_line = $linenr;
2320 }
2321
Joe Perches3b617e32014-04-03 14:49:28 -07002322# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002323 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2324 # actual declarations
2325 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002326 # function pointer declarations
2327 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002328 # foo bar; where foo is some local typedef or #define
2329 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2330 # known declaration macros
2331 $prevline =~ /^\+\s+$declaration_macros/) &&
2332 # for "else if" which can look like "$Ident $Ident"
2333 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2334 # other possible extensions of declaration lines
2335 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2336 # not starting a section or a macro "\" extended line
2337 $prevline =~ /(?:\{\s*|\\)$/) &&
2338 # looks like a declaration
2339 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002340 # function pointer declarations
2341 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002342 # foo bar; where foo is some local typedef or #define
2343 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2344 # known declaration macros
2345 $sline =~ /^\+\s+$declaration_macros/ ||
2346 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002347 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002348 # start or end of block or continuation of declaration
2349 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2350 # bitfield continuation
2351 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2352 # other possible extensions of declaration lines
2353 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2354 # indentation of previous and current line are the same
2355 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perches3b617e32014-04-03 14:49:28 -07002356 WARN("SPACING",
Joe Perches3f7bac02014-06-04 16:12:04 -07002357 "Missing a blank line after declarations\n" . $hereprev);
Joe Perches3b617e32014-04-03 14:49:28 -07002358 }
2359
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002360# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002361# Exceptions:
2362# 1) within comments
2363# 2) indented preprocessor commands
2364# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002365 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002366 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002367 if (WARN("LEADING_SPACE",
2368 "please, no spaces at the start of a line\n" . $herevet) &&
2369 $fix) {
2370 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2371 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002372 }
2373
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002374# check we are in a valid C source file if not then ignore this hunk
2375 next if ($realfile !~ /\.(h|c)$/);
2376
Joe Perches032a4c02014-08-06 16:10:29 -07002377# check indentation of any line with a bare else
2378# if the previous line is a break or return and is indented 1 tab more...
2379 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2380 my $tabs = length($1) + 1;
2381 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2382 WARN("UNNECESSARY_ELSE",
2383 "else is not generally useful after a break or return\n" . $hereprev);
2384 }
2385 }
2386
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002387# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2388 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2389 WARN("CONFIG_EXPERIMENTAL",
2390 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2391 }
2392
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002393# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002394 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002395 WARN("CVS_KEYWORD",
2396 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002397 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002398
Mike Frysinger42e41c52009-09-21 17:04:40 -07002399# Blackfin: don't use __builtin_bfin_[cs]sync
2400 if ($line =~ /__builtin_bfin_csync/) {
2401 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002402 ERROR("CSYNC",
2403 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002404 }
2405 if ($line =~ /__builtin_bfin_ssync/) {
2406 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002407 ERROR("SSYNC",
2408 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002409 }
2410
Joe Perches56e77d72013-02-21 16:44:14 -08002411# check for old HOTPLUG __dev<foo> section markings
2412 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2413 WARN("HOTPLUG_SECTION",
2414 "Using $1 is unnecessary\n" . $herecurr);
2415 }
2416
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002417# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002418 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2419 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002420#print "LINE<$line>\n";
2421 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002422 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002423 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002424 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002425 $stat =~ s/\n./\n /g;
2426 $cond =~ s/\n./\n /g;
2427
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002428#print "linenr<$linenr> <$stat>\n";
2429 # If this statement has no statement boundaries within
2430 # it there is no point in retrying a statement scan
2431 # until we hit end of it.
2432 my $frag = $stat; $frag =~ s/;+\s*$//;
2433 if ($frag !~ /(?:{|;)/) {
2434#print "skip<$line_nr_next>\n";
2435 $suppress_statement = $line_nr_next;
2436 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002437
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002438 # Find the real next line.
2439 $realline_next = $line_nr_next;
2440 if (defined $realline_next &&
2441 (!defined $lines[$realline_next - 1] ||
2442 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2443 $realline_next++;
2444 }
2445
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002446 my $s = $stat;
2447 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002448
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002449 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002450 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002451
2452 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002453 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002454
Andy Whitcroft463f2862009-09-21 17:04:34 -07002455 } elsif ($s =~ /^.\s*else\b/s) {
2456
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002457 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002458 } 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 -07002459 my $type = $1;
2460 $type =~ s/\s+/ /g;
2461 possible($type, "A:" . $s);
2462
Andy Whitcroft8905a672007-11-28 16:21:06 -08002463 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002464 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002465 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002466 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002467
2468 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002469 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002470 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002471 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002472
2473 # Check for any sort of function declaration.
2474 # int foo(something bar, other baz);
2475 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002476 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 -08002477 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002478
Andy Whitcroftcf655042008-03-04 14:28:20 -08002479 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002480 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002481 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002482
Andy Whitcroft8905a672007-11-28 16:21:06 -08002483 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002484 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002485
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002486 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002487 }
2488 }
2489 }
2490
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002491 }
2492
Andy Whitcroft653d4872007-06-23 17:16:34 -07002493#
2494# Checks which may be anchored in the context.
2495#
2496
2497# Check for switch () and associated case and default
2498# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002499 if ($line=~/\bswitch\s*\(.*\)/) {
2500 my $err = '';
2501 my $sep = '';
2502 my @ctx = ctx_block_outer($linenr, $realcnt);
2503 shift(@ctx);
2504 for my $ctx (@ctx) {
2505 my ($clen, $cindent) = line_stats($ctx);
2506 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2507 $indent != $cindent) {
2508 $err .= "$sep$ctx\n";
2509 $sep = '';
2510 } else {
2511 $sep = "[...]\n";
2512 }
2513 }
2514 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002515 ERROR("SWITCH_CASE_INDENT_LEVEL",
2516 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002517 }
2518 }
2519
2520# if/while/etc brace do not go on next line, unless defining a do while loop,
2521# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002522 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002523 my $pre_ctx = "$1$2";
2524
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002525 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002526
2527 if ($line =~ /^\+\t{6,}/) {
2528 WARN("DEEP_INDENTATION",
2529 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2530 }
2531
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002532 my $ctx_cnt = $realcnt - $#ctx - 1;
2533 my $ctx = join("\n", @ctx);
2534
Andy Whitcroft548596d2008-07-23 21:29:01 -07002535 my $ctx_ln = $linenr;
2536 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002537
Andy Whitcroft548596d2008-07-23 21:29:01 -07002538 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2539 defined $lines[$ctx_ln - 1] &&
2540 $lines[$ctx_ln - 1] =~ /^-/)) {
2541 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2542 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002543 $ctx_ln++;
2544 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002545
Andy Whitcroft53210162008-07-23 21:29:03 -07002546 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2547 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002548
2549 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002550 ERROR("OPEN_BRACE",
2551 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002552 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002553 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002554 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2555 $ctx =~ /\)\s*\;\s*$/ &&
2556 defined $lines[$ctx_ln - 1])
2557 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002558 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2559 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002560 WARN("TRAILING_SEMICOLON",
2561 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002562 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002563 }
2564 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002565 }
2566
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002567# Check relative indent for conditionals and blocks.
2568 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002569 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2570 ctx_statement_block($linenr, $realcnt, 0)
2571 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002572 my ($s, $c) = ($stat, $cond);
2573
2574 substr($s, 0, length($c), '');
2575
2576 # Make sure we remove the line prefixes as we have
2577 # none on the first line, and are going to readd them
2578 # where necessary.
2579 $s =~ s/\n./\n/gs;
2580
2581 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002582 my @newlines = ($c =~ /\n/gs);
2583 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002584
2585 # We want to check the first line inside the block
2586 # starting at the end of the conditional, so remove:
2587 # 1) any blank line termination
2588 # 2) any opening brace { on end of the line
2589 # 3) any do (...) {
2590 my $continuation = 0;
2591 my $check = 0;
2592 $s =~ s/^.*\bdo\b//;
2593 $s =~ s/^\s*{//;
2594 if ($s =~ s/^\s*\\//) {
2595 $continuation = 1;
2596 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002597 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002598 $check = 1;
2599 $cond_lines++;
2600 }
2601
2602 # Also ignore a loop construct at the end of a
2603 # preprocessor statement.
2604 if (($prevline =~ /^.\s*#\s*define\s/ ||
2605 $prevline =~ /\\\s*$/) && $continuation == 0) {
2606 $check = 0;
2607 }
2608
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002609 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002610 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002611 while ($cond_ptr != $cond_lines) {
2612 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002613
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002614 # If we see an #else/#elif then the code
2615 # is not linear.
2616 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2617 $check = 0;
2618 }
2619
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002620 # Ignore:
2621 # 1) blank lines, they should be at 0,
2622 # 2) preprocessor lines, and
2623 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002624 if ($continuation ||
2625 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002626 $s =~ /^\s*#\s*?/ ||
2627 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002628 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002629 if ($s =~ s/^.*?\n//) {
2630 $cond_lines++;
2631 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002632 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002633 }
2634
2635 my (undef, $sindent) = line_stats("+" . $s);
2636 my $stat_real = raw_line($linenr, $cond_lines);
2637
2638 # Check if either of these lines are modified, else
2639 # this is not this patch's fault.
2640 if (!defined($stat_real) ||
2641 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2642 $check = 0;
2643 }
2644 if (defined($stat_real) && $cond_lines > 1) {
2645 $stat_real = "[...]\n$stat_real";
2646 }
2647
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002648 #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 -07002649
2650 if ($check && (($sindent % 8) != 0 ||
2651 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002652 WARN("SUSPECT_CODE_INDENT",
2653 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002654 }
2655 }
2656
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002657 # Track the 'values' across context and added lines.
2658 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002659 my ($curr_values, $curr_vars) =
2660 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002661 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002662 if ($dbg_values) {
2663 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002664 print "$linenr > .$outline\n";
2665 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002666 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002667 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002668 $prev_values = substr($curr_values, -1);
2669
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002670#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002671 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002672
Andy Whitcroft653d4872007-06-23 17:16:34 -07002673# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002674 if ($dbg_type) {
2675 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002676 ERROR("TEST_TYPE",
2677 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002678 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002679 ERROR("TEST_NOT_TYPE",
2680 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002681 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002682 next;
2683 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002684# TEST: allow direct testing of the attribute matcher.
2685 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002686 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002687 ERROR("TEST_ATTR",
2688 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002689 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002690 ERROR("TEST_NOT_ATTR",
2691 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002692 }
2693 next;
2694 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002695
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002696# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002697 if ($line =~ /^.\s*{/ &&
2698 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002699 ERROR("OPEN_BRACE",
2700 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002701 }
2702
Andy Whitcroft653d4872007-06-23 17:16:34 -07002703#
2704# Checks which are anchored on the added line.
2705#
2706
2707# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002708 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002709 my $path = $1;
2710 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002711 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002712 "malformed #include filename\n" . $herecurr);
2713 }
2714 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2715 ERROR("UAPI_INCLUDE",
2716 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002717 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002718 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002719
2720# no C99 // comments
2721 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002722 if (ERROR("C99_COMMENTS",
2723 "do not use C99 // comments\n" . $herecurr) &&
2724 $fix) {
2725 my $line = $fixed[$linenr - 1];
2726 if ($line =~ /\/\/(.*)$/) {
2727 my $comment = trim($1);
2728 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2729 }
2730 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002731 }
2732 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002733 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002734 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002735
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002736# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2737# the whole statement.
2738#print "APW <$lines[$realline_next - 1]>\n";
2739 if (defined $realline_next &&
2740 exists $lines[$realline_next - 1] &&
2741 !defined $suppress_export{$realline_next} &&
2742 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2743 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002744 # Handle definitions which produce identifiers with
2745 # a prefix:
2746 # XXX(foo);
2747 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002748 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002749 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002750 $name =~ /^${Ident}_$2/) {
2751#print "FOO C name<$name>\n";
2752 $suppress_export{$realline_next} = 1;
2753
2754 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002755 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002756 ^.DEFINE_$Ident\(\Q$name\E\)|
2757 ^.DECLARE_$Ident\(\Q$name\E\)|
2758 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002759 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2760 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002761 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002762#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2763 $suppress_export{$realline_next} = 2;
2764 } else {
2765 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002766 }
2767 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002768 if (!defined $suppress_export{$linenr} &&
2769 $prevline =~ /^.\s*$/ &&
2770 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2771 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2772#print "FOO B <$lines[$linenr - 1]>\n";
2773 $suppress_export{$linenr} = 2;
2774 }
2775 if (defined $suppress_export{$linenr} &&
2776 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002777 WARN("EXPORT_SYMBOL",
2778 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002779 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002780
Joe Eloff5150bda2010-08-09 17:21:00 -07002781# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002782 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2783 if (ERROR("GLOBAL_INITIALISERS",
2784 "do not initialise globals to 0 or NULL\n" .
2785 $herecurr) &&
2786 $fix) {
2787 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2788 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002789 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002790# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002791 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2792 if (ERROR("INITIALISED_STATIC",
2793 "do not initialise statics to 0 or NULL\n" .
2794 $herecurr) &&
2795 $fix) {
2796 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2797 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002798 }
2799
Joe Perchescb710ec2010-10-26 14:23:20 -07002800# check for static const char * arrays.
2801 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002802 WARN("STATIC_CONST_CHAR_ARRAY",
2803 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002804 $herecurr);
2805 }
2806
2807# check for static char foo[] = "bar" declarations.
2808 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002809 WARN("STATIC_CONST_CHAR_ARRAY",
2810 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002811 $herecurr);
2812 }
2813
Joe Perches9b0fa602014-04-03 14:49:18 -07002814# check for non-global char *foo[] = {"bar", ...} declarations.
2815 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2816 WARN("STATIC_CONST_CHAR_ARRAY",
2817 "char * array declaration might be better as static const\n" .
2818 $herecurr);
2819 }
2820
Joe Perchesb36190c2014-01-27 17:07:18 -08002821# check for function declarations without arguments like "int foo()"
2822 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2823 if (ERROR("FUNCTION_WITHOUT_ARGS",
2824 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2825 $fix) {
2826 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2827 }
2828 }
2829
Joe Perches92e112f2013-12-13 11:36:22 -07002830# check for uses of DEFINE_PCI_DEVICE_TABLE
2831 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2832 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2833 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2834 $fix) {
2835 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2836 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002837 }
2838
Andy Whitcroft653d4872007-06-23 17:16:34 -07002839# check for new typedefs, only function parameters and sparse annotations
2840# make sense.
2841 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002842 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002843 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002844 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002845 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002846 WARN("NEW_TYPEDEFS",
2847 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002848 }
2849
2850# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002851 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002852 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2853 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002854 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002855
Andy Whitcroft65863862009-01-06 14:41:21 -08002856 # Should start with a space.
2857 $to =~ s/^(\S)/ $1/;
2858 # Should not end with a space.
2859 $to =~ s/\s+$//;
2860 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002861 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002862 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002863
Joe Perches3705ce52013-07-03 15:05:31 -07002864## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002865 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002866 if (ERROR("POINTER_LOCATION",
2867 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2868 $fix) {
2869 my $sub_from = $ident;
2870 my $sub_to = $ident;
2871 $sub_to =~ s/\Q$from\E/$to/;
2872 $fixed[$linenr - 1] =~
2873 s@\Q$sub_from\E@$sub_to@;
2874 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002875 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002876 }
2877 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2878 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002879 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002880
Andy Whitcroft65863862009-01-06 14:41:21 -08002881 # Should start with a space.
2882 $to =~ s/^(\S)/ $1/;
2883 # Should not end with a space.
2884 $to =~ s/\s+$//;
2885 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002886 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002887 }
2888 # Modifiers should have spaces.
2889 $to =~ s/(\b$Modifier$)/$1 /;
2890
Joe Perches3705ce52013-07-03 15:05:31 -07002891## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002892 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002893 if (ERROR("POINTER_LOCATION",
2894 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2895 $fix) {
2896
2897 my $sub_from = $match;
2898 my $sub_to = $match;
2899 $sub_to =~ s/\Q$from\E/$to/;
2900 $fixed[$linenr - 1] =~
2901 s@\Q$sub_from\E@$sub_to@;
2902 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002903 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002904 }
2905
2906# # no BUG() or BUG_ON()
2907# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2908# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2909# print "$herecurr";
2910# $clean = 0;
2911# }
2912
Andy Whitcroft8905a672007-11-28 16:21:06 -08002913 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002914 WARN("LINUX_VERSION_CODE",
2915 "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 -08002916 }
2917
Joe Perches17441222011-06-15 15:08:17 -07002918# check for uses of printk_ratelimit
2919 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002920 WARN("PRINTK_RATELIMITED",
2921"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002922 }
2923
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002924# printk should use KERN_* levels. Note that follow on printk's on the
2925# same line do not need a level, so we use the current block context
2926# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002927# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002928# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002929 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002930 my $ok = 0;
2931 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2932 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002933 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002934 # with "\n" ignore it, else it is to blame
2935 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2936 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2937 $ok = 1;
2938 }
2939 last;
2940 }
2941 }
2942 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002943 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2944 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002945 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002946 }
2947
Joe Perches243f3802012-05-31 16:26:09 -07002948 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2949 my $orig = $1;
2950 my $level = lc($orig);
2951 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002952 my $level2 = $level;
2953 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002954 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07002955 "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 -07002956 }
2957
2958 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002959 if (WARN("PREFER_PR_LEVEL",
2960 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2961 $fix) {
2962 $fixed[$linenr - 1] =~
2963 s/\bpr_warning\b/pr_warn/;
2964 }
Joe Perches243f3802012-05-31 16:26:09 -07002965 }
2966
Joe Perchesdc139312013-02-21 16:44:13 -08002967 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2968 my $orig = $1;
2969 my $level = lc($orig);
2970 $level = "warn" if ($level eq "warning");
2971 $level = "dbg" if ($level eq "debug");
2972 WARN("PREFER_DEV_LEVEL",
2973 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2974 }
2975
Andy Whitcroft653d4872007-06-23 17:16:34 -07002976# function brace can't be on same line, except for #defines of do while,
2977# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002978 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2979 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002980 ERROR("OPEN_BRACE",
2981 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002982 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002983
Andy Whitcroft8905a672007-11-28 16:21:06 -08002984# open braces for enum, union and struct go on the same line.
2985 if ($line =~ /^.\s*{/ &&
2986 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002987 ERROR("OPEN_BRACE",
2988 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002989 }
2990
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002991# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002992 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2993 if (WARN("SPACING",
2994 "missing space after $1 definition\n" . $herecurr) &&
2995 $fix) {
2996 $fixed[$linenr - 1] =~
2997 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2998 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002999 }
3000
Joe Perches31070b52014-01-23 15:54:49 -08003001# Function pointer declarations
3002# check spacing between type, funcptr, and args
3003# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003004 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003005 my $declare = $1;
3006 my $pre_pointer_space = $2;
3007 my $post_pointer_space = $3;
3008 my $funcname = $4;
3009 my $post_funcname_space = $5;
3010 my $pre_args_space = $6;
3011
Joe Perches91f72e92014-04-03 14:49:12 -07003012# the $Declare variable will capture all spaces after the type
3013# so check it for a missing trailing missing space but pointer return types
3014# don't need a space so don't warn for those.
3015 my $post_declare_space = "";
3016 if ($declare =~ /(\s+)$/) {
3017 $post_declare_space = $1;
3018 $declare = rtrim($declare);
3019 }
3020 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003021 WARN("SPACING",
3022 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003023 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003024 }
3025
3026# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003027# This test is not currently implemented because these declarations are
3028# equivalent to
3029# int foo(int bar, ...)
3030# and this is form shouldn't/doesn't generate a checkpatch warning.
3031#
3032# elsif ($declare =~ /\s{2,}$/) {
3033# WARN("SPACING",
3034# "Multiple spaces after return type\n" . $herecurr);
3035# }
Joe Perches31070b52014-01-23 15:54:49 -08003036
3037# unnecessary space "type ( *funcptr)(args...)"
3038 if (defined $pre_pointer_space &&
3039 $pre_pointer_space =~ /^\s/) {
3040 WARN("SPACING",
3041 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3042 }
3043
3044# unnecessary space "type (* funcptr)(args...)"
3045 if (defined $post_pointer_space &&
3046 $post_pointer_space =~ /^\s/) {
3047 WARN("SPACING",
3048 "Unnecessary space before function pointer name\n" . $herecurr);
3049 }
3050
3051# unnecessary space "type (*funcptr )(args...)"
3052 if (defined $post_funcname_space &&
3053 $post_funcname_space =~ /^\s/) {
3054 WARN("SPACING",
3055 "Unnecessary space after function pointer name\n" . $herecurr);
3056 }
3057
3058# unnecessary space "type (*funcptr) (args...)"
3059 if (defined $pre_args_space &&
3060 $pre_args_space =~ /^\s/) {
3061 WARN("SPACING",
3062 "Unnecessary space before function pointer arguments\n" . $herecurr);
3063 }
3064
3065 if (show_type("SPACING") && $fix) {
3066 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003067 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003068 }
3069 }
3070
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003071# check for spacing round square brackets; allowed:
3072# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003073# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3074# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003075 while ($line =~ /(.*?\s)\[/g) {
3076 my ($where, $prefix) = ($-[1], $1);
3077 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003078 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003079 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003080 if (ERROR("BRACKET_SPACE",
3081 "space prohibited before open square bracket '['\n" . $herecurr) &&
3082 $fix) {
3083 $fixed[$linenr - 1] =~
3084 s/^(\+.*?)\s+\[/$1\[/;
3085 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003086 }
3087 }
3088
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003089# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003090 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003091 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003092 my $ctx_before = substr($line, 0, $-[1]);
3093 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003094
3095 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003096 if ($name =~ /^(?:
3097 if|for|while|switch|return|case|
3098 volatile|__volatile__|
3099 __attribute__|format|__extension__|
3100 asm|__asm__)$/x)
3101 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003102 # cpp #define statements have non-optional spaces, ie
3103 # if there is a space between the name and the open
3104 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003105 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003106
3107 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003108 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003109
3110 # If this whole things ends with a type its most
3111 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003112 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003113
3114 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003115 if (WARN("SPACING",
3116 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3117 $fix) {
3118 $fixed[$linenr - 1] =~
3119 s/\b$name\s+\(/$name\(/;
3120 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003121 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003122 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003123
Andy Whitcroft653d4872007-06-23 17:16:34 -07003124# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003125 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003126 my $fixed_line = "";
3127 my $line_fixed = 0;
3128
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003129 my $ops = qr{
3130 <<=|>>=|<=|>=|==|!=|
3131 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3132 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003133 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003134 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003135 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003136 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003137
3138## print("element count: <" . $#elements . ">\n");
3139## foreach my $el (@elements) {
3140## print("el: <$el>\n");
3141## }
3142
3143 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003144 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003145
Joe Perches3705ce52013-07-03 15:05:31 -07003146 foreach my $el (@elements) {
3147 push(@fix_elements, substr($rawline, $off, length($el)));
3148 $off += length($el);
3149 }
3150
3151 $off = 0;
3152
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003153 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003154 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003155
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003156 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003157
3158 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3159
3160## print("n: <$n> good: <$good>\n");
3161
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003162 $off += length($elements[$n]);
3163
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003164 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003165 my $ca = substr($opline, 0, $off);
3166 my $cc = '';
3167 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3168 $cc = substr($opline, $off + length($elements[$n + 1]));
3169 }
3170 my $cb = "$ca$;$cc";
3171
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003172 my $a = '';
3173 $a = 'V' if ($elements[$n] ne '');
3174 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003175 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003176 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3177 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003178 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003179
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003180 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003181
3182 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003183 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003184 $c = 'V' if ($elements[$n + 2] ne '');
3185 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003186 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003187 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3188 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003189 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003190 } else {
3191 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003192 }
3193
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003194 my $ctx = "${a}x${c}";
3195
3196 my $at = "(ctx:$ctx)";
3197
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003198 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003199 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003200
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003201 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003202 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003203
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003204 # Get the full operator variant.
3205 my $opv = $op . substr($curr_vars, $off, 1);
3206
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003207 # Ignore operators passed as parameters.
3208 if ($op_type ne 'V' &&
3209 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3210
Andy Whitcroftcf655042008-03-04 14:28:20 -08003211# # Ignore comments
3212# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003213
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003214 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003215 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003216 if ($ctx !~ /.x[WEBC]/ &&
3217 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003218 if (ERROR("SPACING",
3219 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003220 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003221 $line_fixed = 1;
3222 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003223 }
3224
3225 # // is a comment
3226 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003227
Joe Perchesb00e4812014-04-03 14:49:33 -07003228 # : when part of a bitfield
3229 } elsif ($opv eq ':B') {
3230 # skip the bitfield test for now
3231
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003232 # No spaces for:
3233 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003234 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003235 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003236 if (ERROR("SPACING",
3237 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003238 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003239 if (defined $fix_elements[$n + 2]) {
3240 $fix_elements[$n + 2] =~ s/^\s+//;
3241 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003242 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003243 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003244 }
3245
3246 # , must have a space on the right.
3247 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003248 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003249 if (ERROR("SPACING",
3250 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003251 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003252 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003253 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003254 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003255 }
3256
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003257 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003258 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003259 #warn "'*' is part of type\n";
3260
3261 # unary operators should have a space before and
3262 # none after. May be left adjacent to another
3263 # unary operator, or a cast
3264 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003265 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003266 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003267 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003268 if (ERROR("SPACING",
3269 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003270 if ($n != $last_after + 2) {
3271 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3272 $line_fixed = 1;
3273 }
Joe Perches3705ce52013-07-03 15:05:31 -07003274 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003275 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003276 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003277 # A unary '*' may be const
3278
3279 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003280 if (ERROR("SPACING",
3281 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003282 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003283 if (defined $fix_elements[$n + 2]) {
3284 $fix_elements[$n + 2] =~ s/^\s+//;
3285 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003286 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003287 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003288 }
3289
3290 # unary ++ and unary -- are allowed no space on one side.
3291 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003292 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003293 if (ERROR("SPACING",
3294 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003295 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003296 $line_fixed = 1;
3297 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003298 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003299 if ($ctx =~ /Wx[BE]/ ||
3300 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003301 if (ERROR("SPACING",
3302 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003303 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003304 $line_fixed = 1;
3305 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003306 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003307 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003308 if (ERROR("SPACING",
3309 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003310 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003311 if (defined $fix_elements[$n + 2]) {
3312 $fix_elements[$n + 2] =~ s/^\s+//;
3313 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003314 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003315 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003316 }
3317
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003318 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003319 } elsif ($op eq '<<' or $op eq '>>' or
3320 $op eq '&' or $op eq '^' or $op eq '|' or
3321 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003322 $op eq '*' or $op eq '/' or
3323 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003324 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003325 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003326 if (ERROR("SPACING",
3327 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003328 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3329 if (defined $fix_elements[$n + 2]) {
3330 $fix_elements[$n + 2] =~ s/^\s+//;
3331 }
Joe Perches3705ce52013-07-03 15:05:31 -07003332 $line_fixed = 1;
3333 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003334 }
3335
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003336 # A colon needs no spaces before when it is
3337 # terminating a case value or a label.
3338 } elsif ($opv eq ':C' || $opv eq ':L') {
3339 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003340 if (ERROR("SPACING",
3341 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003342 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003343 $line_fixed = 1;
3344 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003345 }
3346
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003347 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003348 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003349 my $ok = 0;
3350
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003351 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003352 if (($op eq '<' &&
3353 $cc =~ /^\S+\@\S+>/) ||
3354 ($op eq '>' &&
3355 $ca =~ /<\S+\@\S+$/))
3356 {
3357 $ok = 1;
3358 }
3359
Joe Perches84731622013-11-12 15:10:05 -08003360 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003361 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003362 my $msg_type = \&ERROR;
3363 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3364
3365 if (&{$msg_type}("SPACING",
3366 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003367 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3368 if (defined $fix_elements[$n + 2]) {
3369 $fix_elements[$n + 2] =~ s/^\s+//;
3370 }
Joe Perches3705ce52013-07-03 15:05:31 -07003371 $line_fixed = 1;
3372 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003373 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003374 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003375 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003376
3377## print("n: <$n> GOOD: <$good>\n");
3378
3379 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003380 }
Joe Perches3705ce52013-07-03 15:05:31 -07003381
3382 if (($#elements % 2) == 0) {
3383 $fixed_line = $fixed_line . $fix_elements[$#elements];
3384 }
3385
3386 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3387 $fixed[$linenr - 1] = $fixed_line;
3388 }
3389
3390
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003391 }
3392
Joe Perches786b6322013-07-03 15:05:32 -07003393# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003394 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003395 if (WARN("SPACING",
3396 "space prohibited before semicolon\n" . $herecurr) &&
3397 $fix) {
3398 1 while $fixed[$linenr - 1] =~
3399 s/^(\+.*\S)\s+;/$1;/;
3400 }
3401 }
3402
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003403# check for multiple assignments
3404 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003405 CHK("MULTIPLE_ASSIGNMENTS",
3406 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003407 }
3408
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003409## # check for multiple declarations, allowing for a function declaration
3410## # continuation.
3411## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3412## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3413##
3414## # Remove any bracketed sections to ensure we do not
3415## # falsly report the parameters of functions.
3416## my $ln = $line;
3417## while ($ln =~ s/\([^\(\)]*\)//g) {
3418## }
3419## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003420## WARN("MULTIPLE_DECLARATION",
3421## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003422## }
3423## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003424
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003425#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003426 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3427 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003428 if (ERROR("SPACING",
3429 "space required before the open brace '{'\n" . $herecurr) &&
3430 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003431 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003432 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003433 }
3434
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003435## # check for blank lines before declarations
3436## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3437## $prevrawline =~ /^.\s*$/) {
3438## WARN("SPACING",
3439## "No blank lines before declarations\n" . $hereprev);
3440## }
3441##
3442
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003443# closing brace should have a space following it when it has anything
3444# on the line
3445 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003446 if (ERROR("SPACING",
3447 "space required after that close brace '}'\n" . $herecurr) &&
3448 $fix) {
3449 $fixed[$linenr - 1] =~
3450 s/}((?!(?:,|;|\)))\S)/} $1/;
3451 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003452 }
3453
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003454# check spacing on square brackets
3455 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003456 if (ERROR("SPACING",
3457 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3458 $fix) {
3459 $fixed[$linenr - 1] =~
3460 s/\[\s+/\[/;
3461 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003462 }
3463 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003464 if (ERROR("SPACING",
3465 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3466 $fix) {
3467 $fixed[$linenr - 1] =~
3468 s/\s+\]/\]/;
3469 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003470 }
3471
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003472# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003473 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3474 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003475 if (ERROR("SPACING",
3476 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3477 $fix) {
3478 $fixed[$linenr - 1] =~
3479 s/\(\s+/\(/;
3480 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003481 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003482 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003483 $line !~ /for\s*\(.*;\s+\)/ &&
3484 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003485 if (ERROR("SPACING",
3486 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3487 $fix) {
3488 $fixed[$linenr - 1] =~
3489 s/\s+\)/\)/;
3490 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003491 }
3492
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003493#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003494 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003495 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003496 if (WARN("INDENTED_LABEL",
3497 "labels should not be indented\n" . $herecurr) &&
3498 $fix) {
3499 $fixed[$linenr - 1] =~
3500 s/^(.)\s+/$1/;
3501 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003502 }
3503
Joe Perches5b9553a2014-04-03 14:49:21 -07003504# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003505 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003506 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003507 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003508 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3509 my $value = $1;
3510 $value = deparenthesize($value);
3511 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3512 ERROR("RETURN_PARENTHESES",
3513 "return is not a function, parentheses are not required\n" . $herecurr);
3514 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003515 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003516 ERROR("SPACING",
3517 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003518 }
3519 }
Joe Perches507e5142013-11-12 15:10:13 -08003520
Joe Perchesb43ae212014-06-23 13:22:07 -07003521# unnecessary return in a void function
3522# at end-of-function, with the previous line a single leading tab, then return;
3523# and the line before that not a goto label target like "out:"
3524 if ($sline =~ /^[ \+]}\s*$/ &&
3525 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3526 $linenr >= 3 &&
3527 $lines[$linenr - 3] =~ /^[ +]/ &&
3528 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003529 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003530 "void function return statements are not generally useful\n" . $hereprev);
3531 }
Joe Perches9819cf22014-06-04 16:12:09 -07003532
Joe Perches189248d2014-01-23 15:54:47 -08003533# if statements using unnecessary parentheses - ie: if ((foo == bar))
3534 if ($^V && $^V ge 5.10.0 &&
3535 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3536 my $openparens = $1;
3537 my $count = $openparens =~ tr@\(@\(@;
3538 my $msg = "";
3539 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3540 my $comp = $4; #Not $1 because of $LvalOrFunc
3541 $msg = " - maybe == should be = ?" if ($comp eq "==");
3542 WARN("UNNECESSARY_PARENTHESES",
3543 "Unnecessary parentheses$msg\n" . $herecurr);
3544 }
3545 }
3546
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003547# Return of what appears to be an errno should normally be -'ve
3548 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3549 my $name = $1;
3550 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003551 WARN("USE_NEGATIVE_ERRNO",
3552 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003553 }
3554 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003555
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003556# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003557 if ($line =~ /\b(if|while|for|switch)\(/) {
3558 if (ERROR("SPACING",
3559 "space required before the open parenthesis '('\n" . $herecurr) &&
3560 $fix) {
3561 $fixed[$linenr - 1] =~
3562 s/\b(if|while|for|switch)\(/$1 \(/;
3563 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003564 }
3565
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003566# Check for illegal assignment in if conditional -- and check for trailing
3567# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003568 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003569 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3570 ctx_statement_block($linenr, $realcnt, 0)
3571 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003572 my ($stat_next) = ctx_statement_block($line_nr_next,
3573 $remain_next, $off_next);
3574 $stat_next =~ s/\n./\n /g;
3575 ##print "stat<$stat> stat_next<$stat_next>\n";
3576
3577 if ($stat_next =~ /^\s*while\b/) {
3578 # If the statement carries leading newlines,
3579 # then count those as offsets.
3580 my ($whitespace) =
3581 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3582 my $offset =
3583 statement_rawlines($whitespace) - 1;
3584
3585 $suppress_whiletrailers{$line_nr_next +
3586 $offset} = 1;
3587 }
3588 }
3589 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003590 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003591 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003592 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003593
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003594 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003595 ERROR("ASSIGN_IN_IF",
3596 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003597 }
3598
3599 # Find out what is on the end of the line after the
3600 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003601 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003602 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003603 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003604 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3605 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003606 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003607 # Find out how long the conditional actually is.
3608 my @newlines = ($c =~ /\n/gs);
3609 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003610 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003611
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003612 $stat_real = raw_line($linenr, $cond_lines)
3613 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003614 if (defined($stat_real) && $cond_lines > 1) {
3615 $stat_real = "[...]\n$stat_real";
3616 }
3617
Joe Perches000d1cc12011-07-25 17:13:25 -07003618 ERROR("TRAILING_STATEMENTS",
3619 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003620 }
3621 }
3622
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003623# Check for bitwise tests written as boolean
3624 if ($line =~ /
3625 (?:
3626 (?:\[|\(|\&\&|\|\|)
3627 \s*0[xX][0-9]+\s*
3628 (?:\&\&|\|\|)
3629 |
3630 (?:\&\&|\|\|)
3631 \s*0[xX][0-9]+\s*
3632 (?:\&\&|\|\||\)|\])
3633 )/x)
3634 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003635 WARN("HEXADECIMAL_BOOLEAN_TEST",
3636 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003637 }
3638
Andy Whitcroft8905a672007-11-28 16:21:06 -08003639# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003640 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3641 my $s = $1;
3642 $s =~ s/$;//g; # Remove any comments
3643 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003644 ERROR("TRAILING_STATEMENTS",
3645 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003646 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003647 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003648# if should not continue a brace
3649 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003650 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07003651 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003652 $herecurr);
3653 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003654# case and default should not have general statements after them
3655 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3656 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003657 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003658 \s*return\s+
3659 )/xg)
3660 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003661 ERROR("TRAILING_STATEMENTS",
3662 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003663 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003664
3665 # Check for }<nl>else {, these must be at the same
3666 # indent level to be relevant to each other.
3667 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3668 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003669 ERROR("ELSE_AFTER_BRACE",
3670 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003671 }
3672
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003673 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3674 $previndent == $indent) {
3675 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3676
3677 # Find out what is on the end of the line after the
3678 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003679 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003680 $s =~ s/\n.*//g;
3681
3682 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003683 ERROR("WHILE_AFTER_BRACE",
3684 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003685 }
3686 }
3687
Joe Perches95e2c602013-07-03 15:05:20 -07003688#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003689 while ($line =~ m{($Constant|$Lval)}g) {
3690 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003691
3692#gcc binary extension
3693 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003694 if (WARN("GCC_BINARY_CONSTANT",
3695 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3696 $fix) {
3697 my $hexval = sprintf("0x%x", oct($var));
3698 $fixed[$linenr - 1] =~
3699 s/\b$var\b/$hexval/;
3700 }
Joe Perches95e2c602013-07-03 15:05:20 -07003701 }
3702
3703#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003704 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003705 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003706#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003707 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003708#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003709 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003710 while ($var =~ m{($Ident)}g) {
3711 my $word = $1;
3712 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003713 if ($check) {
3714 seed_camelcase_includes();
3715 if (!$file && !$camelcase_file_seeded) {
3716 seed_camelcase_file($realfile);
3717 $camelcase_file_seeded = 1;
3718 }
3719 }
Joe Perches7e781f62013-09-11 14:23:55 -07003720 if (!defined $camelcase{$word}) {
3721 $camelcase{$word} = 1;
3722 CHK("CAMELCASE",
3723 "Avoid CamelCase: <$word>\n" . $herecurr);
3724 }
Joe Perches34456862013-07-03 15:05:34 -07003725 }
Joe Perches323c1262012-12-17 16:02:07 -08003726 }
3727 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003728
3729#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003730 if ($line =~ /\#\s*define.*\\\s+$/) {
3731 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3732 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3733 $fix) {
3734 $fixed[$linenr - 1] =~ s/\s+$//;
3735 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003736 }
3737
Andy Whitcroft653d4872007-06-23 17:16:34 -07003738#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003739 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003740 my $file = "$1.h";
3741 my $checkfile = "include/linux/$file";
3742 if (-f "$root/$checkfile" &&
3743 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003744 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003745 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003746 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003747 CHK("ARCH_INCLUDE_LINUX",
3748 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003749 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003750 WARN("INCLUDE_LINUX",
3751 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003752 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003753 }
3754 }
3755
Andy Whitcroft653d4872007-06-23 17:16:34 -07003756# multi-statement macros should be enclosed in a do while loop, grab the
3757# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003758# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07003759 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3760 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003761 my $ln = $linenr;
3762 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003763 my ($off, $dstat, $dcond, $rest);
3764 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003765 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003766 ctx_statement_block($linenr, $realcnt, 0);
3767 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003768 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003769 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003770
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003771 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003772 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003773 $dstat =~ s/\\\n.//g;
3774 $dstat =~ s/^\s*//s;
3775 $dstat =~ s/\s*$//s;
3776
3777 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003778 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3779 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003780 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003781 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003782 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003783
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003784 # Flatten any obvious string concatentation.
3785 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3786 $dstat =~ s/$Ident\s*("X*")/$1/)
3787 {
3788 }
3789
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003790 my $exceptions = qr{
3791 $Declare|
3792 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003793 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003794 DECLARE_PER_CPU|
3795 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003796 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003797 union|
3798 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003799 \.$Ident\s*=\s*|
3800 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003801 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003802 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003803 if ($dstat ne '' &&
3804 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3805 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003806 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07003807 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003808 $dstat !~ /$exceptions/ &&
3809 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003810 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003811 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003812 $dstat !~ /^for\s*$Constant$/ && # for (...)
3813 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3814 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003815 $dstat !~ /^\({/ && # ({...
3816 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003817 {
3818 $ctx =~ s/\n*$//;
3819 my $herectx = $here . "\n";
3820 my $cnt = statement_rawlines($ctx);
3821
3822 for (my $n = 0; $n < $cnt; $n++) {
3823 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003824 }
3825
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003826 if ($dstat =~ /;/) {
3827 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3828 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3829 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003830 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003831 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003832 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003833 }
Joe Perches5023d342012-12-17 16:01:47 -08003834
Joe Perches481eb482012-12-17 16:01:56 -08003835# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003836
3837 } else {
3838 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003839 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3840 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003841 $line =~ /^\+.*\\$/) {
3842 WARN("LINE_CONTINUATIONS",
3843 "Avoid unnecessary line continuations\n" . $herecurr);
3844 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003845 }
3846
Joe Perchesb13edf72012-07-30 14:41:24 -07003847# do {} while (0) macro tests:
3848# single-statement macros do not need to be enclosed in do while (0) loop,
3849# macro should not end with a semicolon
3850 if ($^V && $^V ge 5.10.0 &&
3851 $realfile !~ m@/vmlinux.lds.h$@ &&
3852 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3853 my $ln = $linenr;
3854 my $cnt = $realcnt;
3855 my ($off, $dstat, $dcond, $rest);
3856 my $ctx = '';
3857 ($dstat, $dcond, $ln, $cnt, $off) =
3858 ctx_statement_block($linenr, $realcnt, 0);
3859 $ctx = $dstat;
3860
3861 $dstat =~ s/\\\n.//g;
3862
3863 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3864 my $stmts = $2;
3865 my $semis = $3;
3866
3867 $ctx =~ s/\n*$//;
3868 my $cnt = statement_rawlines($ctx);
3869 my $herectx = $here . "\n";
3870
3871 for (my $n = 0; $n < $cnt; $n++) {
3872 $herectx .= raw_line($linenr, $n) . "\n";
3873 }
3874
Joe Perchesac8e97f2012-08-21 16:15:53 -07003875 if (($stmts =~ tr/;/;/) == 1 &&
3876 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003877 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3878 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3879 }
3880 if (defined $semis && $semis ne "") {
3881 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3882 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3883 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07003884 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
3885 $ctx =~ s/\n*$//;
3886 my $cnt = statement_rawlines($ctx);
3887 my $herectx = $here . "\n";
3888
3889 for (my $n = 0; $n < $cnt; $n++) {
3890 $herectx .= raw_line($linenr, $n) . "\n";
3891 }
3892
3893 WARN("TRAILING_SEMICOLON",
3894 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07003895 }
3896 }
3897
Mike Frysinger080ba922009-01-06 14:41:25 -08003898# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3899# all assignments may have only one of the following with an assignment:
3900# .
3901# ALIGN(...)
3902# VMLINUX_SYMBOL(...)
3903 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003904 WARN("MISSING_VMLINUX_SYMBOL",
3905 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003906 }
3907
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003908# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003909 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3910 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003911 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003912 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003913 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3914 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003915 my @allowed = ();
3916 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003917 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003918 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003919 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003920 for my $chunk (@chunks) {
3921 my ($cond, $block) = @{$chunk};
3922
Andy Whitcroft773647a2008-03-28 14:15:58 -07003923 # If the condition carries leading newlines, then count those as offsets.
3924 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3925 my $offset = statement_rawlines($whitespace) - 1;
3926
Joe Perchesaad4f612012-03-23 15:02:19 -07003927 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003928 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3929
3930 # We have looked at and allowed this specific line.
3931 $suppress_ifbraces{$ln + $offset} = 1;
3932
3933 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003934 $ln += statement_rawlines($block) - 1;
3935
Andy Whitcroft773647a2008-03-28 14:15:58 -07003936 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003937
3938 $seen++ if ($block =~ /^\s*{/);
3939
Joe Perchesaad4f612012-03-23 15:02:19 -07003940 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003941 if (statement_lines($cond) > 1) {
3942 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003943 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003944 }
3945 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003946 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003947 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003948 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003949 if (statement_block_size($block) > 1) {
3950 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003951 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003952 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003953 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003954 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003955 if ($seen) {
3956 my $sum_allowed = 0;
3957 foreach (@allowed) {
3958 $sum_allowed += $_;
3959 }
3960 if ($sum_allowed == 0) {
3961 WARN("BRACES",
3962 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3963 } elsif ($sum_allowed != $allow &&
3964 $seen != $allow) {
3965 CHK("BRACES",
3966 "braces {} should be used on all arms of this statement\n" . $herectx);
3967 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003968 }
3969 }
3970 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003971 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003972 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003973 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003974
Andy Whitcroftcf655042008-03-04 14:28:20 -08003975 # Check the pre-context.
3976 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3977 #print "APW: ALLOWED: pre<$1>\n";
3978 $allowed = 1;
3979 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003980
3981 my ($level, $endln, @chunks) =
3982 ctx_statement_full($linenr, $realcnt, $-[0]);
3983
Andy Whitcroftcf655042008-03-04 14:28:20 -08003984 # Check the condition.
3985 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003986 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003987 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003988 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003989 }
3990 if (statement_lines($cond) > 1) {
3991 #print "APW: ALLOWED: cond<$cond>\n";
3992 $allowed = 1;
3993 }
3994 if ($block =~/\b(?:if|for|while)\b/) {
3995 #print "APW: ALLOWED: block<$block>\n";
3996 $allowed = 1;
3997 }
3998 if (statement_block_size($block) > 1) {
3999 #print "APW: ALLOWED: lines block<$block>\n";
4000 $allowed = 1;
4001 }
4002 # Check the post-context.
4003 if (defined $chunks[1]) {
4004 my ($cond, $block) = @{$chunks[1]};
4005 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004006 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004007 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004008 if ($block =~ /^\s*\{/) {
4009 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4010 $allowed = 1;
4011 }
4012 }
4013 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004014 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004015 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004016
Andy Whitcroftf0556632008-10-15 22:02:23 -07004017 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004018 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004019 }
4020
Joe Perches000d1cc12011-07-25 17:13:25 -07004021 WARN("BRACES",
4022 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004023 }
4024 }
4025
Joe Perches0979ae62012-12-17 16:01:59 -08004026# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004027 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004028 CHK("BRACES",
4029 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4030 }
Joe Perches77b9a532013-07-03 15:05:29 -07004031 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004032 CHK("BRACES",
4033 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4034 }
4035
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004036# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004037 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4038 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004039 WARN("VOLATILE",
4040 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004041 }
4042
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004043# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004044 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004045 CHK("REDUNDANT_CODE",
4046 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004047 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004048 }
4049
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004050# check for needless "if (<foo>) fn(<foo>)" uses
4051 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4052 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4053 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4054 WARN('NEEDLESS_IF',
4055 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004056 }
4057 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004058
Joe Perchesebfdc402014-08-06 16:10:27 -07004059# check for unnecessary "Out of Memory" messages
4060 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4061 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4062 (defined $1 || defined $3) &&
4063 $linenr > 3) {
4064 my $testval = $2;
4065 my $testline = $lines[$linenr - 3];
4066
4067 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4068# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4069
4070 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4071 WARN("OOM_MESSAGE",
4072 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4073 }
4074 }
4075
Joe Perches8716de32013-09-11 14:24:05 -07004076# check for bad placement of section $InitAttribute (e.g.: __initdata)
4077 if ($line =~ /(\b$InitAttribute\b)/) {
4078 my $attr = $1;
4079 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4080 my $ptr = $1;
4081 my $var = $2;
4082 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4083 ERROR("MISPLACED_INIT",
4084 "$attr should be placed after $var\n" . $herecurr)) ||
4085 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4086 WARN("MISPLACED_INIT",
4087 "$attr should be placed after $var\n" . $herecurr))) &&
4088 $fix) {
4089 $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;
4090 }
4091 }
4092 }
4093
Joe Perchese970b8842013-11-12 15:10:10 -08004094# check for $InitAttributeData (ie: __initdata) with const
4095 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4096 my $attr = $1;
4097 $attr =~ /($InitAttributePrefix)(.*)/;
4098 my $attr_prefix = $1;
4099 my $attr_type = $2;
4100 if (ERROR("INIT_ATTRIBUTE",
4101 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4102 $fix) {
4103 $fixed[$linenr - 1] =~
4104 s/$InitAttributeData/${attr_prefix}initconst/;
4105 }
4106 }
4107
4108# check for $InitAttributeConst (ie: __initconst) without const
4109 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4110 my $attr = $1;
4111 if (ERROR("INIT_ATTRIBUTE",
4112 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4113 $fix) {
4114 my $lead = $fixed[$linenr - 1] =~
4115 /(^\+\s*(?:static\s+))/;
4116 $lead = rtrim($1);
4117 $lead = "$lead " if ($lead !~ /^\+$/);
4118 $lead = "${lead}const ";
4119 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
4120 }
4121 }
4122
Joe Perchesfbdb8132014-04-03 14:49:14 -07004123# don't use __constant_<foo> functions outside of include/uapi/
4124 if ($realfile !~ m@^include/uapi/@ &&
4125 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4126 my $constant_func = $1;
4127 my $func = $constant_func;
4128 $func =~ s/^__constant_//;
4129 if (WARN("CONSTANT_CONVERSION",
4130 "$constant_func should be $func\n" . $herecurr) &&
4131 $fix) {
4132 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4133 }
4134 }
4135
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004136# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004137 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004138 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004139 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004140 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004141 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004142 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4143 }
4144 if ($delay > 2000) {
4145 WARN("LONG_UDELAY",
4146 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004147 }
4148 }
4149
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004150# warn about unexpectedly long msleep's
4151 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4152 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004153 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004154 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004155 }
4156 }
4157
Joe Perches36ec1932013-07-03 15:05:25 -07004158# check for comparisons of jiffies
4159 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4160 WARN("JIFFIES_COMPARISON",
4161 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4162 }
4163
Joe Perches9d7a34a2013-07-03 15:05:26 -07004164# check for comparisons of get_jiffies_64()
4165 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4166 WARN("JIFFIES_COMPARISON",
4167 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4168 }
4169
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004170# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004171# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004172# print "#ifdef in C files should be avoided\n";
4173# print "$herecurr";
4174# $clean = 0;
4175# }
4176
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004177# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004178 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004179 if (ERROR("SPACING",
4180 "exactly one space required after that #$1\n" . $herecurr) &&
4181 $fix) {
4182 $fixed[$linenr - 1] =~
4183 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4184 }
4185
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004186 }
4187
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004188# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004189 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4190 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004191 my $which = $1;
4192 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004193 CHK("UNCOMMENTED_DEFINITION",
4194 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004195 }
4196 }
4197# check for memory barriers without a comment.
4198 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4199 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004200 WARN("MEMORY_BARRIER",
4201 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004202 }
4203 }
4204# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004205 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004206 CHK("ARCH_DEFINES",
4207 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004208 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004209
Tobias Klauserd4977c72010-05-24 14:33:30 -07004210# Check that the storage class is at the beginning of a declaration
4211 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004212 WARN("STORAGE_CLASS",
4213 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004214 }
4215
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004216# check the location of the inline attribute, that it is between
4217# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004218 if ($line =~ /\b$Type\s+$Inline\b/ ||
4219 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004220 ERROR("INLINE_LOCATION",
4221 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004222 }
4223
Andy Whitcroft8905a672007-11-28 16:21:06 -08004224# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004225 if ($realfile !~ m@\binclude/uapi/@ &&
4226 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004227 if (WARN("INLINE",
4228 "plain inline is preferred over $1\n" . $herecurr) &&
4229 $fix) {
4230 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4231
4232 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004233 }
4234
Joe Perches3d130fd2011-01-12 17:00:00 -08004235# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004236 if ($realfile !~ m@\binclude/uapi/@ &&
4237 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004238 WARN("PREFER_PACKED",
4239 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004240 }
4241
Joe Perches39b7e282011-07-25 17:13:24 -07004242# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004243 if ($realfile !~ m@\binclude/uapi/@ &&
4244 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004245 WARN("PREFER_ALIGNED",
4246 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004247 }
4248
Joe Perches5f14d3b2012-01-10 15:09:52 -08004249# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004250 if ($realfile !~ m@\binclude/uapi/@ &&
4251 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004252 if (WARN("PREFER_PRINTF",
4253 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4254 $fix) {
4255 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4256
4257 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004258 }
4259
Joe Perches6061d942012-03-23 15:02:16 -07004260# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004261 if ($realfile !~ m@\binclude/uapi/@ &&
4262 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004263 if (WARN("PREFER_SCANF",
4264 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4265 $fix) {
4266 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4267 }
Joe Perches6061d942012-03-23 15:02:16 -07004268 }
4269
Joe Perches8f53a9b2010-03-05 13:43:48 -08004270# check for sizeof(&)
4271 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004272 WARN("SIZEOF_ADDRESS",
4273 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004274 }
4275
Joe Perches66c80b62012-07-30 14:41:22 -07004276# check for sizeof without parenthesis
4277 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004278 if (WARN("SIZEOF_PARENTHESIS",
4279 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4280 $fix) {
4281 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4282 }
Joe Perches66c80b62012-07-30 14:41:22 -07004283 }
4284
Joe Perches428e2fd2011-05-24 17:13:39 -07004285# check for line continuations in quoted strings with odd counts of "
4286 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004287 WARN("LINE_CONTINUATIONS",
4288 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004289 }
4290
Joe Perches88982fe2012-12-17 16:02:00 -08004291# check for struct spinlock declarations
4292 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4293 WARN("USE_SPINLOCK_T",
4294 "struct spinlock should be spinlock_t\n" . $herecurr);
4295 }
4296
Joe Perchesa6962d72013-04-29 16:18:13 -07004297# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004298 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004299 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004300 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004301 if (WARN("PREFER_SEQ_PUTS",
4302 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4303 $fix) {
4304 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4305 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004306 }
4307 }
4308
Andy Whitcroft554e1652012-01-10 15:09:57 -08004309# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004310 if ($^V && $^V ge 5.10.0 &&
4311 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004312 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004313
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004314 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004315 my $ms_val = $7;
4316 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004317
Andy Whitcroft554e1652012-01-10 15:09:57 -08004318 if ($ms_size =~ /^(0x|)0$/i) {
4319 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004320 "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 -08004321 } elsif ($ms_size =~ /^(0x|)1$/i) {
4322 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004323 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4324 }
4325 }
4326
Joe Perches98a9bba2014-01-23 15:54:52 -08004327# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4328 if ($^V && $^V ge 5.10.0 &&
4329 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4330 if (WARN("PREFER_ETHER_ADDR_COPY",
4331 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4332 $fix) {
4333 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4334 }
4335 }
4336
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004337# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004338 if ($^V && $^V ge 5.10.0 &&
4339 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004340 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004341 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004342 my $call = $1;
4343 my $cast1 = deparenthesize($2);
4344 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004345 my $cast2 = deparenthesize($7);
4346 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004347 my $cast;
4348
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004349 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004350 $cast = "$cast1 or $cast2";
4351 } elsif ($cast1 ne "") {
4352 $cast = $cast1;
4353 } else {
4354 $cast = $cast2;
4355 }
4356 WARN("MINMAX",
4357 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004358 }
4359 }
4360
Joe Perches4a273192012-07-30 14:41:20 -07004361# check usleep_range arguments
4362 if ($^V && $^V ge 5.10.0 &&
4363 defined $stat &&
4364 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4365 my $min = $1;
4366 my $max = $7;
4367 if ($min eq $max) {
4368 WARN("USLEEP_RANGE",
4369 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4370 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4371 $min > $max) {
4372 WARN("USLEEP_RANGE",
4373 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4374 }
4375 }
4376
Joe Perches823b7942013-11-12 15:10:15 -08004377# check for naked sscanf
4378 if ($^V && $^V ge 5.10.0 &&
4379 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004380 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004381 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4382 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4383 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4384 my $lc = $stat =~ tr@\n@@;
4385 $lc = $lc + $linenr;
4386 my $stat_real = raw_line($linenr, 0);
4387 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4388 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4389 }
4390 WARN("NAKED_SSCANF",
4391 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4392 }
4393
Joe Perchesafc819a2014-06-04 16:12:08 -07004394# check for simple sscanf that should be kstrto<foo>
4395 if ($^V && $^V ge 5.10.0 &&
4396 defined $stat &&
4397 $line =~ /\bsscanf\b/) {
4398 my $lc = $stat =~ tr@\n@@;
4399 $lc = $lc + $linenr;
4400 my $stat_real = raw_line($linenr, 0);
4401 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4402 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4403 }
4404 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4405 my $format = $6;
4406 my $count = $format =~ tr@%@%@;
4407 if ($count == 1 &&
4408 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4409 WARN("SSCANF_TO_KSTRTO",
4410 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4411 }
4412 }
4413 }
4414
Joe Perches70dc8a42013-09-11 14:23:58 -07004415# check for new externs in .h files.
4416 if ($realfile =~ /\.h$/ &&
4417 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004418 if (CHK("AVOID_EXTERNS",
4419 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004420 $fix) {
4421 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4422 }
4423 }
4424
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004425# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004426 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004427 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004428 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004429 my $function_name = $1;
4430 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004431
4432 my $s = $stat;
4433 if (defined $cond) {
4434 substr($s, 0, length($cond), '');
4435 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004436 if ($s =~ /^\s*;/ &&
4437 $function_name ne 'uninitialized_var')
4438 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004439 WARN("AVOID_EXTERNS",
4440 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004441 }
4442
4443 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004444 WARN("FUNCTION_ARGUMENTS",
4445 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004446 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004447
4448 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4449 $stat =~ /^.\s*extern\s+/)
4450 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004451 WARN("AVOID_EXTERNS",
4452 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004453 }
4454
4455# checks for new __setup's
4456 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4457 my $name = $1;
4458
4459 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004460 CHK("UNDOCUMENTED_SETUP",
4461 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004462 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004463 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004464
4465# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004466 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004467 WARN("UNNECESSARY_CASTS",
4468 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004469 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004470
Joe Perchesa640d252013-07-03 15:05:21 -07004471# alloc style
4472# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4473 if ($^V && $^V ge 5.10.0 &&
4474 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4475 CHK("ALLOC_SIZEOF_STRUCT",
4476 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4477 }
4478
Joe Perches60a55362014-06-04 16:12:07 -07004479# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4480 if ($^V && $^V ge 5.10.0 &&
4481 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) {
4482 my $oldfunc = $3;
4483 my $a1 = $4;
4484 my $a2 = $10;
4485 my $newfunc = "kmalloc_array";
4486 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
4487 if ($a1 =~ /^sizeof\s*\S/ || $a2 =~ /^sizeof\s*\S/) {
4488 if (WARN("ALLOC_WITH_MULTIPLY",
4489 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4490 $fix) {
4491 my $r1 = $a1;
4492 my $r2 = $a2;
4493 if ($a1 =~ /^sizeof\s*\S/) {
4494 $r1 = $a2;
4495 $r2 = $a1;
4496 }
4497 $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;
4498
4499 }
4500 }
4501 }
4502
Joe Perches972fdea2013-04-29 16:18:12 -07004503# check for krealloc arg reuse
4504 if ($^V && $^V ge 5.10.0 &&
4505 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4506 WARN("KREALLOC_ARG_REUSE",
4507 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4508 }
4509
Joe Perches5ce59ae2013-02-21 16:44:18 -08004510# check for alloc argument mismatch
4511 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4512 WARN("ALLOC_ARRAY_ARGS",
4513 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4514 }
4515
Joe Perchescaf2a542011-01-12 16:59:56 -08004516# check for multiple semicolons
4517 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004518 if (WARN("ONE_SEMICOLON",
4519 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4520 $fix) {
4521 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4522 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004523 }
4524
Joe Perchesc34c09a2014-01-23 15:54:43 -08004525# check for case / default statements not preceeded by break/fallthrough/switch
4526 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4527 my $has_break = 0;
4528 my $has_statement = 0;
4529 my $count = 0;
4530 my $prevline = $linenr;
4531 while ($prevline > 1 && $count < 3 && !$has_break) {
4532 $prevline--;
4533 my $rline = $rawlines[$prevline - 1];
4534 my $fline = $lines[$prevline - 1];
4535 last if ($fline =~ /^\@\@/);
4536 next if ($fline =~ /^\-/);
4537 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4538 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4539 next if ($fline =~ /^.[\s$;]*$/);
4540 $has_statement = 1;
4541 $count++;
4542 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4543 }
4544 if (!$has_break && $has_statement) {
4545 WARN("MISSING_BREAK",
4546 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4547 }
4548 }
4549
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004550# check for switch/default statements without a break;
4551 if ($^V && $^V ge 5.10.0 &&
4552 defined $stat &&
4553 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4554 my $ctx = '';
4555 my $herectx = $here . "\n";
4556 my $cnt = statement_rawlines($stat);
4557 for (my $n = 0; $n < $cnt; $n++) {
4558 $herectx .= raw_line($linenr, $n) . "\n";
4559 }
4560 WARN("DEFAULT_NO_BREAK",
4561 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004562 }
4563
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004564# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004565 if ($line =~ /\b__FUNCTION__\b/) {
4566 if (WARN("USE_FUNC",
4567 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4568 $fix) {
4569 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4570 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004571 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004572
Joe Perches2c924882012-03-23 15:02:20 -07004573# check for use of yield()
4574 if ($line =~ /\byield\s*\(\s*\)/) {
4575 WARN("YIELD",
4576 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4577 }
4578
Joe Perches179f8f42013-07-03 15:05:30 -07004579# check for comparisons against true and false
4580 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4581 my $lead = $1;
4582 my $arg = $2;
4583 my $test = $3;
4584 my $otype = $4;
4585 my $trail = $5;
4586 my $op = "!";
4587
4588 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4589
4590 my $type = lc($otype);
4591 if ($type =~ /^(?:true|false)$/) {
4592 if (("$test" eq "==" && "$type" eq "true") ||
4593 ("$test" eq "!=" && "$type" eq "false")) {
4594 $op = "";
4595 }
4596
4597 CHK("BOOL_COMPARISON",
4598 "Using comparison to $otype is error prone\n" . $herecurr);
4599
4600## maybe suggesting a correct construct would better
4601## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4602
4603 }
4604 }
4605
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004606# check for semaphores initialized locked
4607 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004608 WARN("CONSIDER_COMPLETION",
4609 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004610 }
Joe Perches6712d852012-03-23 15:02:20 -07004611
Joe Perches67d0a072011-10-31 17:13:10 -07004612# recommend kstrto* over simple_strto* and strict_strto*
4613 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004614 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004615 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004616 }
Joe Perches6712d852012-03-23 15:02:20 -07004617
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004618# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07004619 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004620 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004621 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004622 }
Joe Perches6712d852012-03-23 15:02:20 -07004623
Emese Revfy79404842010-03-05 13:43:53 -08004624# check for various ops structs, ensure they are const.
4625 my $struct_ops = qr{acpi_dock_ops|
4626 address_space_operations|
4627 backlight_ops|
4628 block_device_operations|
4629 dentry_operations|
4630 dev_pm_ops|
4631 dma_map_ops|
4632 extent_io_ops|
4633 file_lock_operations|
4634 file_operations|
4635 hv_ops|
4636 ide_dma_ops|
4637 intel_dvo_dev_ops|
4638 item_operations|
4639 iwl_ops|
4640 kgdb_arch|
4641 kgdb_io|
4642 kset_uevent_ops|
4643 lock_manager_operations|
4644 microcode_ops|
4645 mtrr_ops|
4646 neigh_ops|
4647 nlmsvc_binding|
4648 pci_raw_ops|
4649 pipe_buf_operations|
4650 platform_hibernation_ops|
4651 platform_suspend_ops|
4652 proto_ops|
4653 rpc_pipe_ops|
4654 seq_operations|
4655 snd_ac97_build_ops|
4656 soc_pcmcia_socket_ops|
4657 stacktrace_ops|
4658 sysfs_ops|
4659 tty_operations|
4660 usb_mon_operations|
4661 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004662 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004663 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004664 WARN("CONST_STRUCT",
4665 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004666 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004667 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004668
4669# use of NR_CPUS is usually wrong
4670# ignore definitions of NR_CPUS and usage to define arrays as likely right
4671 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004672 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4673 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004674 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4675 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4676 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004677 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004678 WARN("NR_CPUS",
4679 "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 -07004680 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004681
Joe Perches52ea8502013-11-12 15:10:09 -08004682# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4683 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4684 ERROR("DEFINE_ARCH_HAS",
4685 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4686 }
4687
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004688# check for %L{u,d,i} in strings
4689 my $string;
4690 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4691 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004692 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004693 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004694 WARN("PRINTF_L",
4695 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004696 last;
4697 }
4698 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004699
4700# whine mightly about in_atomic
4701 if ($line =~ /\bin_atomic\s*\(/) {
4702 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004703 ERROR("IN_ATOMIC",
4704 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004705 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004706 WARN("IN_ATOMIC",
4707 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004708 }
4709 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004710
4711# check for lockdep_set_novalidate_class
4712 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4713 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4714 if ($realfile !~ m@^kernel/lockdep@ &&
4715 $realfile !~ m@^include/linux/lockdep@ &&
4716 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004717 ERROR("LOCKDEP",
4718 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004719 }
4720 }
Dave Jones88f88312011-01-12 16:59:59 -08004721
4722 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4723 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004724 WARN("EXPORTED_WORLD_WRITABLE",
4725 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004726 }
Joe Perches24358802014-04-03 14:49:13 -07004727
Joe Perches515a2352014-04-03 14:49:24 -07004728# Mode permission misuses where it seems decimal should be octal
4729# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4730 if ($^V && $^V ge 5.10.0 &&
4731 $line =~ /$mode_perms_search/) {
4732 foreach my $entry (@mode_permission_funcs) {
4733 my $func = $entry->[0];
4734 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004735
Joe Perches515a2352014-04-03 14:49:24 -07004736 my $skip_args = "";
4737 if ($arg_pos > 1) {
4738 $arg_pos--;
4739 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4740 }
4741 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4742 if ($line =~ /$test/) {
4743 my $val = $1;
4744 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004745
Joe Perches515a2352014-04-03 14:49:24 -07004746 if ($val !~ /^0$/ &&
4747 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4748 length($val) ne 4)) {
4749 ERROR("NON_OCTAL_PERMISSIONS",
4750 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4751 }
Joe Perches24358802014-04-03 14:49:13 -07004752 }
4753 }
4754 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004755 }
4756
4757 # If we have no input at all, then there is nothing to report on
4758 # so just keep quiet.
4759 if ($#rawlines == -1) {
4760 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004761 }
4762
Andy Whitcroft8905a672007-11-28 16:21:06 -08004763 # In mailback mode only produce a report in the negative, for
4764 # things that appear to be patches.
4765 if ($mailback && ($clean == 1 || !$is_patch)) {
4766 exit(0);
4767 }
4768
4769 # This is not a patch, and we are are in 'no-patch' mode so
4770 # just keep quiet.
4771 if (!$chk_patch && !$is_patch) {
4772 exit(0);
4773 }
4774
4775 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004776 ERROR("NOT_UNIFIED_DIFF",
4777 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004778 }
4779 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004780 ERROR("MISSING_SIGN_OFF",
4781 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004782 }
4783
Andy Whitcroft8905a672007-11-28 16:21:06 -08004784 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004785 if ($summary && !($clean == 1 && $quiet == 1)) {
4786 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004787 print "total: $cnt_error errors, $cnt_warn warnings, " .
4788 (($check)? "$cnt_chk checks, " : "") .
4789 "$cnt_lines lines checked\n";
4790 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004791 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004792
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004793 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004794
4795 if ($^V lt 5.10.0) {
4796 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4797 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4798 }
4799
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004800 # If there were whitespace errors which cleanpatch can fix
4801 # then suggest that.
4802 if ($rpt_cleaners) {
4803 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4804 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004805 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004806 }
4807 }
4808
Joe Perches91bfe482013-09-11 14:23:59 -07004809 hash_show_words(\%use_type, "Used");
4810 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004811
Joe Perches3705ce52013-07-03 15:05:31 -07004812 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004813 my $newfile = $filename;
4814 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004815 my $linecount = 0;
4816 my $f;
4817
4818 open($f, '>', $newfile)
4819 or die "$P: Can't open $newfile for write\n";
4820 foreach my $fixed_line (@fixed) {
4821 $linecount++;
4822 if ($file) {
4823 if ($linecount > 3) {
4824 $fixed_line =~ s/^\+//;
4825 print $f $fixed_line. "\n";
4826 }
4827 } else {
4828 print $f $fixed_line . "\n";
4829 }
4830 }
4831 close($f);
4832
4833 if (!$quiet) {
4834 print << "EOM";
4835Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4836
4837Do _NOT_ trust the results written to this file.
4838Do _NOT_ submit these changes without inspecting them for correctness.
4839
4840This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4841No warranties, expressed or implied...
4842
4843EOM
4844 }
4845 }
4846
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004847 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004848 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004849 }
4850 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004851 print << "EOM";
4852$vname has style problems, please review.
4853
4854If any of these errors are false positives, please report
4855them to the maintainer, see CHECKPATCH in MAINTAINERS.
4856EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004857 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004858
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004859 return $clean;
4860}