blob: 79273003d5e7da4911ab7a3308f7f25aeb513b4a [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;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070033my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $summary = 1;
35my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080036my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070037my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070038my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070039my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080040my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070041my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080042my %debug;
Joe Perches34456862013-07-03 15:05:34 -070043my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070044my %use_type = ();
45my @use = ();
46my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070047my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070048my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070049my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080050my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070051my $ignore_perl_version = 0;
52my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070053my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070054my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070055my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070056my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perches57230292015-06-25 15:03:03 -070057my $color = 1;
Joe Perchesdadf6802016-08-02 14:04:33 -070058my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070059
60sub help {
61 my ($exitcode) = @_;
62
63 print << "EOM";
64Usage: $P [OPTION]... [FILE]...
65Version: $V
66
67Options:
68 -q, --quiet quiet
69 --no-tree run without a kernel tree
70 --no-signoff do not check for 'Signed-off-by' line
71 --patch treat FILE as patchfile (default)
72 --emacs emacs compile window format
73 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070074 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070075 -g, --git treat FILE as a single commit or git revision range
76 single git commit with:
77 <rev>
78 <rev>^
79 <rev>~n
80 multiple git commits with:
81 <rev1>..<rev2>
82 <rev1>...<rev2>
83 <rev>-<count>
84 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070085 -f, --file treat FILE as regular source file
86 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070087 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070088 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070089 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070090 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080091 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070092 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070093 --root=PATH PATH to the kernel tree root
94 --no-summary suppress the per-file summary
95 --mailback only produce a report in case of warnings/errors
96 --summary-file include the filename in summary
97 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
98 'values', 'possible', 'type', and 'attr' (default
99 is all off)
100 --test-only=WORD report only warnings/errors containing WORD
101 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700102 --fix EXPERIMENTAL - may create horrible results
103 If correctable single-line errors exist, create
104 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
105 with potential errors corrected to the preferred
106 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800107 --fix-inplace EXPERIMENTAL - may create horrible results
108 Is the same as --fix, but overwrites the input
109 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700110 --ignore-perl-version override checking of perl version. expect
111 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700112 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700113 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700114 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700115 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700116 -h, --help, --version display this help and exit
117
118When FILE is - read standard input.
119EOM
120
121 exit($exitcode);
122}
123
Joe Perches3beb42e2016-05-20 17:04:14 -0700124sub uniq {
125 my %seen;
126 return grep { !$seen{$_}++ } @_;
127}
128
129sub list_types {
130 my ($exitcode) = @_;
131
132 my $count = 0;
133
134 local $/ = undef;
135
136 open(my $script, '<', abs_path($P)) or
137 die "$P: Can't read '$P' $!\n";
138
139 my $text = <$script>;
140 close($script);
141
142 my @types = ();
143 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
144 push (@types, $_);
145 }
146 @types = sort(uniq(@types));
147 print("#\tMessage type\n\n");
148 foreach my $type (@types) {
149 print(++$count . "\t" . $type . "\n");
150 }
151
152 exit($exitcode);
153}
154
Joe Perches000d1cc12011-07-25 17:13:25 -0700155my $conf = which_conf($configuration_file);
156if (-f $conf) {
157 my @conf_args;
158 open(my $conffile, '<', "$conf")
159 or warn "$P: Can't find a readable $configuration_file file $!\n";
160
161 while (<$conffile>) {
162 my $line = $_;
163
164 $line =~ s/\s*\n?$//g;
165 $line =~ s/^\s*//g;
166 $line =~ s/\s+/ /g;
167
168 next if ($line =~ m/^\s*#/);
169 next if ($line =~ m/^\s*$/);
170
171 my @words = split(" ", $line);
172 foreach my $word (@words) {
173 last if ($word =~ m/^#/);
174 push (@conf_args, $word);
175 }
176 }
177 close($conffile);
178 unshift(@ARGV, @conf_args) if @conf_args;
179}
180
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700181GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700182 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700183 'tree!' => \$tree,
184 'signoff!' => \$chk_signoff,
185 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700186 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800187 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700188 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700189 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700190 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700191 'subjective!' => \$check,
192 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700193 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700194 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700195 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700196 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800197 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700198 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700199 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800200 'summary!' => \$summary,
201 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800202 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700203 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800204 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700205 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800206 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700207 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700208 'codespell!' => \$codespell,
209 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700210 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700211 'h|help' => \$help,
212 'version' => \$help
213) or help(1);
214
215help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700216
Joe Perches3beb42e2016-05-20 17:04:14 -0700217list_types(0) if ($list_types);
218
Joe Perches9624b8d2014-01-23 15:54:44 -0800219$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700220$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800221
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700222my $exit = 0;
223
Dave Hansend62a2012013-09-11 14:23:56 -0700224if ($^V && $^V lt $minimum_perl_version) {
225 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
226 if (!$ignore_perl_version) {
227 exit(1);
228 }
229}
230
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700231if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700232 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700233 exit(1);
234}
235
Joe Perches91bfe482013-09-11 14:23:59 -0700236sub hash_save_array_words {
237 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700238
Joe Perches91bfe482013-09-11 14:23:59 -0700239 my @array = split(/,/, join(',', @$arrayRef));
240 foreach my $word (@array) {
241 $word =~ s/\s*\n?$//g;
242 $word =~ s/^\s*//g;
243 $word =~ s/\s+/ /g;
244 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700245
Joe Perches91bfe482013-09-11 14:23:59 -0700246 next if ($word =~ m/^\s*#/);
247 next if ($word =~ m/^\s*$/);
248
249 $hashRef->{$word}++;
250 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700251}
252
Joe Perches91bfe482013-09-11 14:23:59 -0700253sub hash_show_words {
254 my ($hashRef, $prefix) = @_;
255
Joe Perches3c816e42015-06-25 15:03:29 -0700256 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700257 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700258 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700259 print " $word";
260 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700261 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700262 }
263}
264
265hash_save_array_words(\%ignore_type, \@ignore);
266hash_save_array_words(\%use_type, \@use);
267
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800268my $dbg_values = 0;
269my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700270my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700271my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800272for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800273 ## no critic
274 eval "\${dbg_$key} = '$debug{$key}';";
275 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800276}
277
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700278my $rpt_cleaners = 0;
279
Andy Whitcroft8905a672007-11-28 16:21:06 -0800280if ($terse) {
281 $emacs = 1;
282 $quiet++;
283}
284
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700285if ($tree) {
286 if (defined $root) {
287 if (!top_of_kernel_tree($root)) {
288 die "$P: $root: --root does not point at a valid tree\n";
289 }
290 } else {
291 if (top_of_kernel_tree('.')) {
292 $root = '.';
293 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
294 top_of_kernel_tree($1)) {
295 $root = $1;
296 }
297 }
298
299 if (!defined $root) {
300 print "Must be run from the top-level dir. of a kernel tree\n";
301 exit(2);
302 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700303}
304
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305my $emitted_corrupt = 0;
306
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700307our $Ident = qr{
308 [A-Za-z_][A-Za-z\d_]*
309 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
310 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700311our $Storage = qr{extern|static|asmlinkage};
312our $Sparse = qr{
313 __user|
314 __kernel|
315 __force|
316 __iomem|
317 __must_check|
318 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800319 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700320 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800321 __rcu|
322 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700323 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800324our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
325our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
326our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
327our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
328our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700329
Wolfram Sang52131292010-03-05 13:43:51 -0800330# Notes to $Attribute:
331# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700332our $Attribute = qr{
333 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700334 __percpu|
335 __nocast|
336 __safe|
337 __bitwise__|
338 __packed__|
339 __packed2__|
340 __naked|
341 __maybe_unused|
342 __always_unused|
343 __noreturn|
344 __used|
345 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800346 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700347 __noclone|
348 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700349 __read_mostly|
350 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700351 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700352 ____cacheline_aligned|
353 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800354 ____cacheline_internodealigned_in_smp|
355 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700356 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700357our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700358our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
360our $Lval = qr{$Ident(?:$Member)*};
361
Joe Perches95e2c602013-07-03 15:05:20 -0700362our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
363our $Binary = qr{(?i)0b[01]+$Int_type?};
364our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
365our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700366our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800367our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800368our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
369our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
370our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800371our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700372our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800373our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700374our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700375our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700376our $Operators = qr{
377 <=|>=|==|!=|
378 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700379 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700380 }x;
381
Joe Perches91cb5192014-04-03 14:49:32 -0700382our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
383
Joe Perchesab7e23f2015-04-16 12:44:22 -0700384our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700386our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700387our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700389our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800390our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700391our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392
Joe Perches15662b32011-10-31 17:13:12 -0700393our $NON_ASCII_UTF8 = qr{
394 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700395 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
396 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
397 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
398 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
399 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
400 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
401}x;
402
Joe Perches15662b32011-10-31 17:13:12 -0700403our $UTF8 = qr{
404 [\x09\x0A\x0D\x20-\x7E] # ASCII
405 | $NON_ASCII_UTF8
406}x;
407
Joe Perchese6176fa2015-06-25 15:02:49 -0700408our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800409our $typeOtherOSTypedefs = qr{(?x:
410 u_(?:char|short|int|long) | # bsd
411 u(?:nchar|short|int|long) # sysv
412)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700413our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700414 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700415 atomic_t
416)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700417our $typeTypedefs = qr{(?x:
418 $typeC99Typedefs\b|
419 $typeOtherOSTypedefs\b|
420 $typeKernelTypedefs\b
421)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422
Joe Perches6d32f7a2015-11-06 16:31:37 -0800423our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
424
Joe Perches691e6692010-03-05 13:43:51 -0800425our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700426 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700427 (?:[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 -0700428 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700429 panic|
Joe Perches06668722013-11-12 15:10:07 -0800430 MODULE_[A-Z_]+|
431 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800432)};
433
Joe Perches20112472011-07-25 17:13:23 -0700434our $signature_tags = qr{(?xi:
435 Signed-off-by:|
436 Acked-by:|
437 Tested-by:|
438 Reviewed-by:|
439 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700440 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700441 To:|
442 Cc:
443)};
444
Joe Perches18130872014-08-06 16:11:22 -0700445our @typeListMisordered = (
446 qr{char\s+(?:un)?signed},
447 qr{int\s+(?:(?:un)?signed\s+)?short\s},
448 qr{int\s+short(?:\s+(?:un)?signed)},
449 qr{short\s+int(?:\s+(?:un)?signed)},
450 qr{(?:un)?signed\s+int\s+short},
451 qr{short\s+(?:un)?signed},
452 qr{long\s+int\s+(?:un)?signed},
453 qr{int\s+long\s+(?:un)?signed},
454 qr{long\s+(?:un)?signed\s+int},
455 qr{int\s+(?:un)?signed\s+long},
456 qr{int\s+(?:un)?signed},
457 qr{int\s+long\s+long\s+(?:un)?signed},
458 qr{long\s+long\s+int\s+(?:un)?signed},
459 qr{long\s+long\s+(?:un)?signed\s+int},
460 qr{long\s+long\s+(?:un)?signed},
461 qr{long\s+(?:un)?signed},
462);
463
Andy Whitcroft8905a672007-11-28 16:21:06 -0800464our @typeList = (
465 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700466 qr{(?:(?:un)?signed\s+)?char},
467 qr{(?:(?:un)?signed\s+)?short\s+int},
468 qr{(?:(?:un)?signed\s+)?short},
469 qr{(?:(?:un)?signed\s+)?int},
470 qr{(?:(?:un)?signed\s+)?long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long},
473 qr{(?:(?:un)?signed\s+)?long},
474 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475 qr{float},
476 qr{double},
477 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478 qr{struct\s+$Ident},
479 qr{union\s+$Ident},
480 qr{enum\s+$Ident},
481 qr{${Ident}_t},
482 qr{${Ident}_handler},
483 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700484 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800485);
Joe Perches938224b2016-01-20 14:59:15 -0800486
487our $C90_int_types = qr{(?x:
488 long\s+long\s+int\s+(?:un)?signed|
489 long\s+long\s+(?:un)?signed\s+int|
490 long\s+long\s+(?:un)?signed|
491 (?:(?:un)?signed\s+)?long\s+long\s+int|
492 (?:(?:un)?signed\s+)?long\s+long|
493 int\s+long\s+long\s+(?:un)?signed|
494 int\s+(?:(?:un)?signed\s+)?long\s+long|
495
496 long\s+int\s+(?:un)?signed|
497 long\s+(?:un)?signed\s+int|
498 long\s+(?:un)?signed|
499 (?:(?:un)?signed\s+)?long\s+int|
500 (?:(?:un)?signed\s+)?long|
501 int\s+long\s+(?:un)?signed|
502 int\s+(?:(?:un)?signed\s+)?long|
503
504 int\s+(?:un)?signed|
505 (?:(?:un)?signed\s+)?int
506)};
507
Alex Dowad485ff232015-06-25 15:02:52 -0700508our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700509our @typeListWithAttr = (
510 @typeList,
511 qr{struct\s+$InitAttribute\s+$Ident},
512 qr{union\s+$InitAttribute\s+$Ident},
513);
514
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700515our @modifierList = (
516 qr{fastcall},
517);
Alex Dowad485ff232015-06-25 15:02:52 -0700518our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800519
Joe Perches24358802014-04-03 14:49:13 -0700520our @mode_permission_funcs = (
521 ["module_param", 3],
522 ["module_param_(?:array|named|string)", 4],
523 ["module_param_array_named", 5],
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
525 ["proc_create(?:_data|)", 2],
526 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
527);
528
Joe Perches515a2352014-04-03 14:49:24 -0700529#Create a search pattern for all these functions to speed up a loop below
530our $mode_perms_search = "";
531foreach my $entry (@mode_permission_funcs) {
532 $mode_perms_search .= '|' if ($mode_perms_search ne "");
533 $mode_perms_search .= $entry->[0];
534}
535
Joe Perchesb392c642015-04-16 12:44:16 -0700536our $mode_perms_world_writable = qr{
537 S_IWUGO |
538 S_IWOTH |
539 S_IRWXUGO |
540 S_IALLUGO |
541 0[0-7][0-7][2367]
542}x;
543
Wolfram Sang7840a942010-08-09 17:20:57 -0700544our $allowed_asm_includes = qr{(?x:
545 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700546 memory|
547 time|
548 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700549)};
550# memory.h: ARM has a custom one
551
Kees Cook66b47b42014-10-13 15:51:57 -0700552# Load common spelling mistakes and build regular expression list.
553my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700554my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700555
Joe Perches36061e32014-12-10 15:51:43 -0800556if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800557 while (<$spelling>) {
558 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700559
Joe Perches36061e32014-12-10 15:51:43 -0800560 $line =~ s/\s*\n?$//g;
561 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700562
Joe Perches36061e32014-12-10 15:51:43 -0800563 next if ($line =~ m/^\s*#/);
564 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700565
Joe Perches36061e32014-12-10 15:51:43 -0800566 my ($suspect, $fix) = split(/\|\|/, $line);
567
Joe Perches36061e32014-12-10 15:51:43 -0800568 $spelling_fix{$suspect} = $fix;
569 }
570 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800571} else {
572 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700573}
Kees Cook66b47b42014-10-13 15:51:57 -0700574
Joe Perchesebfd7d62015-04-16 12:44:14 -0700575if ($codespell) {
576 if (open(my $spelling, '<', $codespellfile)) {
577 while (<$spelling>) {
578 my $line = $_;
579
580 $line =~ s/\s*\n?$//g;
581 $line =~ s/^\s*//g;
582
583 next if ($line =~ m/^\s*#/);
584 next if ($line =~ m/^\s*$/);
585 next if ($line =~ m/, disabled/i);
586
587 $line =~ s/,.*$//;
588
589 my ($suspect, $fix) = split(/->/, $line);
590
591 $spelling_fix{$suspect} = $fix;
592 }
593 close($spelling);
594 } else {
595 warn "No codespell typos will be found - file '$codespellfile': $!\n";
596 }
597}
598
599$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
600
Andy Whitcroft8905a672007-11-28 16:21:06 -0800601sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700602 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
603 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700604 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700605 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700606 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700607 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700608 (?:$typeTypedefs\b)|
609 (?:${all}\b)
610 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800611 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700612 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800613 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800614 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700615 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700616 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800617 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700618 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800619 }x;
Joe Perches18130872014-08-06 16:11:22 -0700620 $NonptrTypeMisordered = qr{
621 (?:$Modifier\s+|const\s+)*
622 (?:
623 (?:${Misordered}\b)
624 )
625 (?:\s+$Modifier|\s+const)*
626 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700627 $NonptrTypeWithAttr = qr{
628 (?:$Modifier\s+|const\s+)*
629 (?:
630 (?:typeof|__typeof__)\s*\([^\)]*\)|
631 (?:$typeTypedefs\b)|
632 (?:${allWithAttr}\b)
633 )
634 (?:\s+$Modifier|\s+const)*
635 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800636 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700637 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700638 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700639 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800640 }x;
Joe Perches18130872014-08-06 16:11:22 -0700641 $TypeMisordered = qr{
642 $NonptrTypeMisordered
643 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
644 (?:\s+$Inline|\s+$Modifier)*
645 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700646 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700647 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800648}
649build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700650
Joe Perches7d2367a2011-07-25 17:13:22 -0700651our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700652
653# Using $balanced_parens, $LvalOrFunc, or $FuncArg
654# requires at least perl version v5.10.0
655# Any use must be runtime checked with $^V
656
657our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700658our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800659our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700660
Joe Perchesf8422302014-08-06 16:11:31 -0700661our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700662 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700663 (?:$Storage\s+)?LIST_HEAD\s*\(|
664 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
665)};
666
Joe Perches7d2367a2011-07-25 17:13:22 -0700667sub deparenthesize {
668 my ($string) = @_;
669 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700670
671 while ($string =~ /^\s*\(.*\)\s*$/) {
672 $string =~ s@^\s*\(\s*@@;
673 $string =~ s@\s*\)\s*$@@;
674 }
675
Joe Perches7d2367a2011-07-25 17:13:22 -0700676 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700677
Joe Perches7d2367a2011-07-25 17:13:22 -0700678 return $string;
679}
680
Joe Perches34456862013-07-03 15:05:34 -0700681sub seed_camelcase_file {
682 my ($file) = @_;
683
684 return if (!(-f $file));
685
686 local $/;
687
688 open(my $include_file, '<', "$file")
689 or warn "$P: Can't read '$file' $!\n";
690 my $text = <$include_file>;
691 close($include_file);
692
693 my @lines = split('\n', $text);
694
695 foreach my $line (@lines) {
696 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
697 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
698 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800699 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
700 $camelcase{$1} = 1;
701 } 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 -0700702 $camelcase{$1} = 1;
703 }
704 }
705}
706
707my $camelcase_seeded = 0;
708sub seed_camelcase_includes {
709 return if ($camelcase_seeded);
710
711 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700712 my $camelcase_cache = "";
713 my @include_files = ();
714
715 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700716
Richard Genoud3645e322014-02-10 14:25:32 -0800717 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700718 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
719 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700720 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700721 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700722 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700723 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700724 @include_files = split('\n', $files);
725 foreach my $file (@include_files) {
726 my $date = POSIX::strftime("%Y%m%d%H%M",
727 localtime((stat $file)[9]));
728 $last_mod_date = $date if ($last_mod_date < $date);
729 }
730 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700731 }
Joe Perchesc707a812013-07-08 16:00:43 -0700732
733 if ($camelcase_cache ne "" && -f $camelcase_cache) {
734 open(my $camelcase_file, '<', "$camelcase_cache")
735 or warn "$P: Can't read '$camelcase_cache' $!\n";
736 while (<$camelcase_file>) {
737 chomp;
738 $camelcase{$_} = 1;
739 }
740 close($camelcase_file);
741
742 return;
743 }
744
Richard Genoud3645e322014-02-10 14:25:32 -0800745 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700746 $files = `git ls-files "include/*.h"`;
747 @include_files = split('\n', $files);
748 }
749
Joe Perches34456862013-07-03 15:05:34 -0700750 foreach my $file (@include_files) {
751 seed_camelcase_file($file);
752 }
Joe Perches351b2a12013-07-03 15:05:36 -0700753
Joe Perchesc707a812013-07-08 16:00:43 -0700754 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700755 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700756 open(my $camelcase_file, '>', "$camelcase_cache")
757 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700758 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
759 print $camelcase_file ("$_\n");
760 }
761 close($camelcase_file);
762 }
Joe Perches34456862013-07-03 15:05:34 -0700763}
764
Joe Perchesd311cd42014-08-06 16:10:57 -0700765sub git_commit_info {
766 my ($commit, $id, $desc) = @_;
767
768 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
769
770 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
771 $output =~ s/^\s*//gm;
772 my @lines = split("\n", $output);
773
Joe Perches0d7835f2015-02-13 14:38:35 -0800774 return ($id, $desc) if ($#lines < 0);
775
Joe Perchesd311cd42014-08-06 16:10:57 -0700776 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
777# Maybe one day convert this block of bash into something that returns
778# all matching commit ids, but it's very slow...
779#
780# echo "checking commits $1..."
781# git rev-list --remotes | grep -i "^$1" |
782# while read line ; do
783# git log --format='%H %s' -1 $line |
784# echo "commit $(cut -c 1-12,41-)"
785# done
786 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
787 } else {
788 $id = substr($lines[0], 0, 12);
789 $desc = substr($lines[0], 41);
790 }
791
792 return ($id, $desc);
793}
794
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795$chk_signoff = 0 if ($file);
796
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700797my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800798my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700799my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700800my @fixed_inserted = ();
801my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700802my $fixlinenr = -1;
803
Du, Changbin4a593c32016-05-20 17:04:16 -0700804# If input is git commits, extract all commits from the commit expressions.
805# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
806die "$P: No git repository found\n" if ($git && !-e ".git");
807
808if ($git) {
809 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700810 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700811 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700812 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
813 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700814 } elsif ($commit_expr =~ m/\.\./) {
815 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700816 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700817 $git_range = "-1 $commit_expr";
818 }
819 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
820 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700821 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
822 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700823 my $sha1 = $1;
824 my $subject = $2;
825 unshift(@commits, $sha1);
826 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700827 }
828 }
829 die "$P: no git commits after extraction!\n" if (@commits == 0);
830 @ARGV = @commits;
831}
832
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800835 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700836 if ($git) {
837 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
838 die "$P: $filename: git format-patch failed - $!\n";
839 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800840 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700841 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800842 } elsif ($filename eq '-') {
843 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700844 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800845 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700846 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700847 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800848 if ($filename eq '-') {
849 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700850 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700851 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800852 } else {
853 $vname = $filename;
854 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800855 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 chomp;
857 push(@rawlines, $_);
858 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800859 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700860
861 if ($#ARGV > 0 && $quiet == 0) {
862 print '-' x length($vname) . "\n";
863 print "$vname\n";
864 print '-' x length($vname) . "\n";
865 }
866
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800867 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700868 $exit = 1;
869 }
870 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800871 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700872 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700873 @fixed_inserted = ();
874 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700875 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700876 @modifierListFile = ();
877 @typeListFile = ();
878 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700879}
880
Joe Perchesd8469f12015-06-25 15:03:00 -0700881if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700882 hash_show_words(\%use_type, "Used");
883 hash_show_words(\%ignore_type, "Ignored");
884
Joe Perchesd8469f12015-06-25 15:03:00 -0700885 if ($^V lt 5.10.0) {
886 print << "EOM"
887
888NOTE: perl $^V is not modern enough to detect all possible issues.
889 An upgrade to at least perl v5.10.0 is suggested.
890EOM
891 }
892 if ($exit) {
893 print << "EOM"
894
895NOTE: If any of the errors are false positives, please report
896 them to the maintainer, see CHECKPATCH in MAINTAINERS.
897EOM
898 }
899}
900
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700901exit($exit);
902
903sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904 my ($root) = @_;
905
906 my @tree_check = (
907 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
908 "README", "Documentation", "arch", "include", "drivers",
909 "fs", "init", "ipc", "kernel", "lib", "scripts",
910 );
911
912 foreach my $check (@tree_check) {
913 if (! -e $root . '/' . $check) {
914 return 0;
915 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700916 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700917 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700918}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700919
Joe Perches20112472011-07-25 17:13:23 -0700920sub parse_email {
921 my ($formatted_email) = @_;
922
923 my $name = "";
924 my $address = "";
925 my $comment = "";
926
927 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
928 $name = $1;
929 $address = $2;
930 $comment = $3 if defined $3;
931 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
932 $address = $1;
933 $comment = $2 if defined $2;
934 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
935 $address = $1;
936 $comment = $2 if defined $2;
937 $formatted_email =~ s/$address.*$//;
938 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700939 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700940 $name =~ s/^\"|\"$//g;
941 # If there's a name left after stripping spaces and
942 # leading quotes, and the address doesn't have both
943 # leading and trailing angle brackets, the address
944 # is invalid. ie:
945 # "joe smith joe@smith.com" bad
946 # "joe smith <joe@smith.com" bad
947 if ($name ne "" && $address !~ /^<[^>]+>$/) {
948 $name = "";
949 $address = "";
950 $comment = "";
951 }
952 }
953
Joe Perches3705ce52013-07-03 15:05:31 -0700954 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700955 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700956 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700957 $address =~ s/^\<|\>$//g;
958
959 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
960 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
961 $name = "\"$name\"";
962 }
963
964 return ($name, $address, $comment);
965}
966
967sub format_email {
968 my ($name, $address) = @_;
969
970 my $formatted_email;
971
Joe Perches3705ce52013-07-03 15:05:31 -0700972 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700973 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700974 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700975
976 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
977 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
978 $name = "\"$name\"";
979 }
980
981 if ("$name" eq "") {
982 $formatted_email = "$address";
983 } else {
984 $formatted_email = "$name <$address>";
985 }
986
987 return $formatted_email;
988}
989
Joe Perchesd311cd42014-08-06 16:10:57 -0700990sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700991 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700992
Joe Perchesbd474ca2014-08-06 16:11:10 -0700993 foreach my $path (split(/:/, $ENV{PATH})) {
994 if (-e "$path/$bin") {
995 return "$path/$bin";
996 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700997 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700998
Joe Perchesbd474ca2014-08-06 16:11:10 -0700999 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001000}
1001
Joe Perches000d1cc12011-07-25 17:13:25 -07001002sub which_conf {
1003 my ($conf) = @_;
1004
1005 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1006 if (-e "$path/$conf") {
1007 return "$path/$conf";
1008 }
1009 }
1010
1011 return "";
1012}
1013
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001014sub expand_tabs {
1015 my ($str) = @_;
1016
1017 my $res = '';
1018 my $n = 0;
1019 for my $c (split(//, $str)) {
1020 if ($c eq "\t") {
1021 $res .= ' ';
1022 $n++;
1023 for (; ($n % 8) != 0; $n++) {
1024 $res .= ' ';
1025 }
1026 next;
1027 }
1028 $res .= $c;
1029 $n++;
1030 }
1031
1032 return $res;
1033}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001034sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001035 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001036 return $res;
1037}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001038
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001039sub line_stats {
1040 my ($line) = @_;
1041
1042 # Drop the diff line leader and expand tabs
1043 $line =~ s/^.//;
1044 $line = expand_tabs($line);
1045
1046 # Pick the indent from the front of the line.
1047 my ($white) = ($line =~ /^(\s*)/);
1048
1049 return (length($line), length($white));
1050}
1051
Andy Whitcroft773647a2008-03-28 14:15:58 -07001052my $sanitise_quote = '';
1053
1054sub sanitise_line_reset {
1055 my ($in_comment) = @_;
1056
1057 if ($in_comment) {
1058 $sanitise_quote = '*/';
1059 } else {
1060 $sanitise_quote = '';
1061 }
1062}
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001063sub sanitise_line {
1064 my ($line) = @_;
1065
1066 my $res = '';
1067 my $l = '';
1068
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001069 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070 my $off = 0;
1071 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001072
Andy Whitcroft773647a2008-03-28 14:15:58 -07001073 # Always copy over the diff marker.
1074 $res = substr($line, 0, 1);
1075
1076 for ($off = 1; $off < length($line); $off++) {
1077 $c = substr($line, $off, 1);
1078
1079 # Comments we are wacking completly including the begin
1080 # and end, all to $;.
1081 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1082 $sanitise_quote = '*/';
1083
1084 substr($res, $off, 2, "$;$;");
1085 $off++;
1086 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001087 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001088 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001089 $sanitise_quote = '';
1090 substr($res, $off, 2, "$;$;");
1091 $off++;
1092 next;
1093 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001094 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1095 $sanitise_quote = '//';
1096
1097 substr($res, $off, 2, $sanitise_quote);
1098 $off++;
1099 next;
1100 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001101
1102 # A \ in a string means ignore the next character.
1103 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1104 $c eq "\\") {
1105 substr($res, $off, 2, 'XX');
1106 $off++;
1107 next;
1108 }
1109 # Regular quotes.
1110 if ($c eq "'" || $c eq '"') {
1111 if ($sanitise_quote eq '') {
1112 $sanitise_quote = $c;
1113
1114 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001115 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001116 } elsif ($sanitise_quote eq $c) {
1117 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001118 }
1119 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001120
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001121 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001122 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1123 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001124 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1125 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001126 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1127 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001128 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001129 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001130 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001131 }
1132
Daniel Walker113f04a2009-09-21 17:04:35 -07001133 if ($sanitise_quote eq '//') {
1134 $sanitise_quote = '';
1135 }
1136
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001137 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001138 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001139 my $clean = 'X' x length($1);
1140 $res =~ s@\<.*\>@<$clean>@;
1141
1142 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001143 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001144 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001145 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001146 }
1147
Joe Perchesdadf6802016-08-02 14:04:33 -07001148 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1149 my $match = $1;
1150 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1151 }
1152
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001153 return $res;
1154}
1155
Joe Perchesa6962d72013-04-29 16:18:13 -07001156sub get_quoted_string {
1157 my ($line, $rawline) = @_;
1158
Joe Perches33acb542015-06-25 15:02:54 -07001159 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001160 return substr($rawline, $-[0], $+[0] - $-[0]);
1161}
1162
Andy Whitcroft8905a672007-11-28 16:21:06 -08001163sub ctx_statement_block {
1164 my ($linenr, $remain, $off) = @_;
1165 my $line = $linenr - 1;
1166 my $blk = '';
1167 my $soff = $off;
1168 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001169 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001170
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001171 my $loff = 0;
1172
Andy Whitcroft8905a672007-11-28 16:21:06 -08001173 my $type = '';
1174 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001175 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001176 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001177 my $c;
1178 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001179
1180 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001181 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001182 @stack = (['', 0]) if ($#stack == -1);
1183
Andy Whitcroft773647a2008-03-28 14:15:58 -07001184 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001185 # If we are about to drop off the end, pull in more
1186 # context.
1187 if ($off >= $len) {
1188 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001189 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001190 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001191 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001192 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001193 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001194 $len = length($blk);
1195 $line++;
1196 last;
1197 }
1198 # Bail if there is no further context.
1199 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001200 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001201 last;
1202 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001203 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1204 $level++;
1205 $type = '#';
1206 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001207 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001208 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001209 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001210 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001211
Andy Whitcroft773647a2008-03-28 14:15:58 -07001212 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001213
1214 # Handle nested #if/#else.
1215 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1216 push(@stack, [ $type, $level ]);
1217 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1218 ($type, $level) = @{$stack[$#stack - 1]};
1219 } elsif ($remainder =~ /^#\s*endif\b/) {
1220 ($type, $level) = @{pop(@stack)};
1221 }
1222
Andy Whitcroft8905a672007-11-28 16:21:06 -08001223 # Statement ends at the ';' or a close '}' at the
1224 # outermost level.
1225 if ($level == 0 && $c eq ';') {
1226 last;
1227 }
1228
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001229 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001230 if ($level == 0 && $coff_set == 0 &&
1231 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1232 $remainder =~ /^(else)(?:\s|{)/ &&
1233 $remainder !~ /^else\s+if\b/) {
1234 $coff = $off + length($1) - 1;
1235 $coff_set = 1;
1236 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1237 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001238 }
1239
Andy Whitcroft8905a672007-11-28 16:21:06 -08001240 if (($type eq '' || $type eq '(') && $c eq '(') {
1241 $level++;
1242 $type = '(';
1243 }
1244 if ($type eq '(' && $c eq ')') {
1245 $level--;
1246 $type = ($level != 0)? '(' : '';
1247
1248 if ($level == 0 && $coff < $soff) {
1249 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001250 $coff_set = 1;
1251 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001252 }
1253 }
1254 if (($type eq '' || $type eq '{') && $c eq '{') {
1255 $level++;
1256 $type = '{';
1257 }
1258 if ($type eq '{' && $c eq '}') {
1259 $level--;
1260 $type = ($level != 0)? '{' : '';
1261
1262 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001263 if (substr($blk, $off + 1, 1) eq ';') {
1264 $off++;
1265 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001266 last;
1267 }
1268 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001269 # Preprocessor commands end at the newline unless escaped.
1270 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1271 $level--;
1272 $type = '';
1273 $off++;
1274 last;
1275 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001276 $off++;
1277 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001278 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001279 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001280 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001281 $line++;
1282 $remain--;
1283 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001284
1285 my $statement = substr($blk, $soff, $off - $soff + 1);
1286 my $condition = substr($blk, $soff, $coff - $soff + 1);
1287
1288 #warn "STATEMENT<$statement>\n";
1289 #warn "CONDITION<$condition>\n";
1290
Andy Whitcroft773647a2008-03-28 14:15:58 -07001291 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001292
1293 return ($statement, $condition,
1294 $line, $remain + 1, $off - $loff + 1, $level);
1295}
1296
Andy Whitcroftcf655042008-03-04 14:28:20 -08001297sub statement_lines {
1298 my ($stmt) = @_;
1299
1300 # Strip the diff line prefixes and rip blank lines at start and end.
1301 $stmt =~ s/(^|\n)./$1/g;
1302 $stmt =~ s/^\s*//;
1303 $stmt =~ s/\s*$//;
1304
1305 my @stmt_lines = ($stmt =~ /\n/g);
1306
1307 return $#stmt_lines + 2;
1308}
1309
1310sub statement_rawlines {
1311 my ($stmt) = @_;
1312
1313 my @stmt_lines = ($stmt =~ /\n/g);
1314
1315 return $#stmt_lines + 2;
1316}
1317
1318sub statement_block_size {
1319 my ($stmt) = @_;
1320
1321 $stmt =~ s/(^|\n)./$1/g;
1322 $stmt =~ s/^\s*{//;
1323 $stmt =~ s/}\s*$//;
1324 $stmt =~ s/^\s*//;
1325 $stmt =~ s/\s*$//;
1326
1327 my @stmt_lines = ($stmt =~ /\n/g);
1328 my @stmt_statements = ($stmt =~ /;/g);
1329
1330 my $stmt_lines = $#stmt_lines + 2;
1331 my $stmt_statements = $#stmt_statements + 1;
1332
1333 if ($stmt_lines > $stmt_statements) {
1334 return $stmt_lines;
1335 } else {
1336 return $stmt_statements;
1337 }
1338}
1339
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001340sub ctx_statement_full {
1341 my ($linenr, $remain, $off) = @_;
1342 my ($statement, $condition, $level);
1343
1344 my (@chunks);
1345
Andy Whitcroftcf655042008-03-04 14:28:20 -08001346 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001347 ($statement, $condition, $linenr, $remain, $off, $level) =
1348 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001349 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001350 push(@chunks, [ $condition, $statement ]);
1351 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1352 return ($level, $linenr, @chunks);
1353 }
1354
1355 # Pull in the following conditional/block pairs and see if they
1356 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001357 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001358 ($statement, $condition, $linenr, $remain, $off, $level) =
1359 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001360 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001361 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001362 #print "C: push\n";
1363 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001364 }
1365
1366 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001367}
1368
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001369sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001370 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001371 my $line;
1372 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001373 my $blk = '';
1374 my @o;
1375 my @c;
1376 my @res = ();
1377
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001378 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001379 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001380 for ($line = $start; $remain > 0; $line++) {
1381 next if ($rawlines[$line] =~ /^-/);
1382 $remain--;
1383
1384 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001385
1386 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001387 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001388 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001389 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001390 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001391 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001392 $level = pop(@stack);
1393 }
1394
Andy Whitcroft01464f32010-10-26 14:23:19 -07001395 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001396 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1397 if ($off > 0) {
1398 $off--;
1399 next;
1400 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001401
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001402 if ($c eq $close && $level > 0) {
1403 $level--;
1404 last if ($level == 0);
1405 } elsif ($c eq $open) {
1406 $level++;
1407 }
1408 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001409
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001410 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001411 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001412 }
1413
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001414 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001415 }
1416
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001417 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001418}
1419sub ctx_block_outer {
1420 my ($linenr, $remain) = @_;
1421
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001422 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1423 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001424}
1425sub ctx_block {
1426 my ($linenr, $remain) = @_;
1427
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001428 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1429 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001430}
1431sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001432 my ($linenr, $remain, $off) = @_;
1433
1434 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1435 return @r;
1436}
1437sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001438 my ($linenr, $remain) = @_;
1439
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001440 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001441}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001442sub ctx_statement_level {
1443 my ($linenr, $remain, $off) = @_;
1444
1445 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1446}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001447
1448sub ctx_locate_comment {
1449 my ($first_line, $end_line) = @_;
1450
1451 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001452 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001453 return $current_comment if (defined $current_comment);
1454
1455 # Look through the context and try and figure out if there is a
1456 # comment.
1457 my $in_comment = 0;
1458 $current_comment = '';
1459 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001460 my $line = $rawlines[$linenr - 1];
1461 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001462 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1463 $in_comment = 1;
1464 }
1465 if ($line =~ m@/\*@) {
1466 $in_comment = 1;
1467 }
1468 if (!$in_comment && $current_comment ne '') {
1469 $current_comment = '';
1470 }
1471 $current_comment .= $line . "\n" if ($in_comment);
1472 if ($line =~ m@\*/@) {
1473 $in_comment = 0;
1474 }
1475 }
1476
1477 chomp($current_comment);
1478 return($current_comment);
1479}
1480sub ctx_has_comment {
1481 my ($first_line, $end_line) = @_;
1482 my $cmt = ctx_locate_comment($first_line, $end_line);
1483
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001484 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001485 ##print "CMMT: $cmt\n";
1486
1487 return ($cmt ne '');
1488}
1489
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001490sub raw_line {
1491 my ($linenr, $cnt) = @_;
1492
1493 my $offset = $linenr - 1;
1494 $cnt++;
1495
1496 my $line;
1497 while ($cnt) {
1498 $line = $rawlines[$offset++];
1499 next if (defined($line) && $line =~ /^-/);
1500 $cnt--;
1501 }
1502
1503 return $line;
1504}
1505
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001506sub cat_vet {
1507 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001508 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001509
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001510 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001511 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1512 $res .= $1;
1513 if ($2 ne '') {
1514 $coded = sprintf("^%c", unpack('C', $2) + 64);
1515 $res .= $coded;
1516 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001517 }
1518 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001519
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001520 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001521}
1522
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001523my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001524my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001525my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001526my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001527
1528sub annotate_reset {
1529 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001530 $av_pending = '_';
1531 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001532 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001533}
1534
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001535sub annotate_values {
1536 my ($stream, $type) = @_;
1537
1538 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001539 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001540 my $cur = $stream;
1541
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001542 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001543
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001544 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001545 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001546 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001547 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001548 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001549 print "WS($1)\n" if ($dbg_values > 1);
1550 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001551 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001552 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001553 }
1554
Florian Micklerc023e4732011-01-12 16:59:58 -08001555 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001556 print "CAST($1)\n" if ($dbg_values > 1);
1557 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001558 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001559
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001560 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001561 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001562 $type = 'T';
1563
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001564 } elsif ($cur =~ /^($Modifier)\s*/) {
1565 print "MODIFIER($1)\n" if ($dbg_values > 1);
1566 $type = 'T';
1567
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001568 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001569 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001570 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001571 push(@av_paren_type, $type);
1572 if ($2 ne '') {
1573 $av_pending = 'N';
1574 }
1575 $type = 'E';
1576
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001577 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001578 print "UNDEF($1)\n" if ($dbg_values > 1);
1579 $av_preprocessor = 1;
1580 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001581
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001582 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001583 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001584 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001585
1586 push(@av_paren_type, $type);
1587 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001588 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001589
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001590 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001591 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1592 $av_preprocessor = 1;
1593
1594 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1595
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001596 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001597
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001598 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001599 print "PRE_END($1)\n" if ($dbg_values > 1);
1600
1601 $av_preprocessor = 1;
1602
1603 # Assume all arms of the conditional end as this
1604 # one does, and continue as if the #endif was not here.
1605 pop(@av_paren_type);
1606 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001607 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001608
1609 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001610 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001611
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001612 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1613 print "ATTR($1)\n" if ($dbg_values > 1);
1614 $av_pending = $type;
1615 $type = 'N';
1616
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001617 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001618 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001619 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001620 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001621 }
1622 $type = 'N';
1623
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001624 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001625 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001626 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001627 $type = 'N';
1628
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001629 } elsif ($cur =~/^(case)/o) {
1630 print "CASE($1)\n" if ($dbg_values > 1);
1631 $av_pend_colon = 'C';
1632 $type = 'N';
1633
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001634 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001636 $type = 'N';
1637
1638 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001639 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001640 push(@av_paren_type, $av_pending);
1641 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001642 $type = 'N';
1643
1644 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001645 my $new_type = pop(@av_paren_type);
1646 if ($new_type ne '_') {
1647 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001648 print "PAREN('$1') -> $type\n"
1649 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001650 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001651 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652 }
1653
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001654 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001655 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001656 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001657 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001658
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001659 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1660 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001661 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001662 } elsif ($type eq 'E') {
1663 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001664 }
1665 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1666 $type = 'V';
1667
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001668 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001670 $type = 'V';
1671
1672 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001673 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001674 $type = 'N';
1675
Andy Whitcroftcf655042008-03-04 14:28:20 -08001676 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001677 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001678 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001679 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001680
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001681 } elsif ($cur =~/^(,)/) {
1682 print "COMMA($1)\n" if ($dbg_values > 1);
1683 $type = 'C';
1684
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001685 } elsif ($cur =~ /^(\?)/o) {
1686 print "QUESTION($1)\n" if ($dbg_values > 1);
1687 $type = 'N';
1688
1689 } elsif ($cur =~ /^(:)/o) {
1690 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1691
1692 substr($var, length($res), 1, $av_pend_colon);
1693 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1694 $type = 'E';
1695 } else {
1696 $type = 'N';
1697 }
1698 $av_pend_colon = 'O';
1699
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001700 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001701 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001702 $type = 'N';
1703
Andy Whitcroft0d413862008-10-15 22:02:16 -07001704 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001705 my $variant;
1706
1707 print "OPV($1)\n" if ($dbg_values > 1);
1708 if ($type eq 'V') {
1709 $variant = 'B';
1710 } else {
1711 $variant = 'U';
1712 }
1713
1714 substr($var, length($res), 1, $variant);
1715 $type = 'N';
1716
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719 if ($1 ne '++' && $1 ne '--') {
1720 $type = 'N';
1721 }
1722
1723 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001724 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001725 }
1726 if (defined $1) {
1727 $cur = substr($cur, length($1));
1728 $res .= $type x length($1);
1729 }
1730 }
1731
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001732 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001733}
1734
Andy Whitcroft8905a672007-11-28 16:21:06 -08001735sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001736 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001737 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001738 ^(?:
1739 $Modifier|
1740 $Storage|
1741 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001742 DEFINE_\S+
1743 )$|
1744 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001745 goto|
1746 return|
1747 case|
1748 else|
1749 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001750 do|
1751 \#|
1752 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001753 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001754 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001755 )}x;
1756 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1757 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001758 # Check for modifiers.
1759 $possible =~ s/\s*$Storage\s*//g;
1760 $possible =~ s/\s*$Sparse\s*//g;
1761 if ($possible =~ /^\s*$/) {
1762
1763 } elsif ($possible =~ /\s/) {
1764 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001765 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001766 if ($modifier !~ $notPermitted) {
1767 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001768 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001769 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001770 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001771
1772 } else {
1773 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001774 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001775 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001776 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001777 } else {
1778 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001779 }
1780}
1781
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001782my $prefix = '';
1783
Joe Perches000d1cc12011-07-25 17:13:25 -07001784sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001785 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001786
Joe Perchescbec18a2014-04-03 14:49:19 -07001787 return defined $use_type{$type} if (scalar keys %use_type > 0);
1788
1789 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001790}
1791
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001792sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001793 my ($level, $type, $msg) = @_;
1794
1795 if (!show_type($type) ||
1796 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001797 return 0;
1798 }
Joe Perches57230292015-06-25 15:03:03 -07001799 my $output = '';
1800 if (-t STDOUT && $color) {
1801 if ($level eq 'ERROR') {
1802 $output .= RED;
1803 } elsif ($level eq 'WARNING') {
1804 $output .= YELLOW;
1805 } else {
1806 $output .= GREEN;
1807 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001808 }
Joe Perches57230292015-06-25 15:03:03 -07001809 $output .= $prefix . $level . ':';
1810 if ($show_types) {
1811 $output .= BLUE if (-t STDOUT && $color);
1812 $output .= "$type:";
1813 }
1814 $output .= RESET if (-t STDOUT && $color);
1815 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001816
1817 if ($showfile) {
1818 my @lines = split("\n", $output, -1);
1819 splice(@lines, 1, 1);
1820 $output = join("\n", @lines);
1821 }
Joe Perches57230292015-06-25 15:03:03 -07001822 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001823
Joe Perches57230292015-06-25 15:03:03 -07001824 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001825
1826 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001827}
Joe Perchescbec18a2014-04-03 14:49:19 -07001828
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001829sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001830 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001831}
Joe Perches000d1cc12011-07-25 17:13:25 -07001832
Joe Perchesd752fcc2014-08-06 16:11:05 -07001833sub fixup_current_range {
1834 my ($lineRef, $offset, $length) = @_;
1835
1836 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1837 my $o = $1;
1838 my $l = $2;
1839 my $no = $o + $offset;
1840 my $nl = $l + $length;
1841 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1842 }
1843}
1844
1845sub fix_inserted_deleted_lines {
1846 my ($linesRef, $insertedRef, $deletedRef) = @_;
1847
1848 my $range_last_linenr = 0;
1849 my $delta_offset = 0;
1850
1851 my $old_linenr = 0;
1852 my $new_linenr = 0;
1853
1854 my $next_insert = 0;
1855 my $next_delete = 0;
1856
1857 my @lines = ();
1858
1859 my $inserted = @{$insertedRef}[$next_insert++];
1860 my $deleted = @{$deletedRef}[$next_delete++];
1861
1862 foreach my $old_line (@{$linesRef}) {
1863 my $save_line = 1;
1864 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001865 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001866 $delta_offset = 0;
1867 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1868 $range_last_linenr = $new_linenr;
1869 fixup_current_range(\$line, $delta_offset, 0);
1870 }
1871
1872 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1873 $deleted = @{$deletedRef}[$next_delete++];
1874 $save_line = 0;
1875 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1876 }
1877
1878 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1879 push(@lines, ${$inserted}{'LINE'});
1880 $inserted = @{$insertedRef}[$next_insert++];
1881 $new_linenr++;
1882 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1883 }
1884
1885 if ($save_line) {
1886 push(@lines, $line);
1887 $new_linenr++;
1888 }
1889
1890 $old_linenr++;
1891 }
1892
1893 return @lines;
1894}
1895
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001896sub fix_insert_line {
1897 my ($linenr, $line) = @_;
1898
1899 my $inserted = {
1900 LINENR => $linenr,
1901 LINE => $line,
1902 };
1903 push(@fixed_inserted, $inserted);
1904}
1905
1906sub fix_delete_line {
1907 my ($linenr, $line) = @_;
1908
1909 my $deleted = {
1910 LINENR => $linenr,
1911 LINE => $line,
1912 };
1913
1914 push(@fixed_deleted, $deleted);
1915}
1916
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001917sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001918 my ($type, $msg) = @_;
1919
1920 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001921 our $clean = 0;
1922 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001923 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001924 }
Joe Perches3705ce52013-07-03 15:05:31 -07001925 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001926}
1927sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001928 my ($type, $msg) = @_;
1929
1930 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001931 our $clean = 0;
1932 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001933 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001934 }
Joe Perches3705ce52013-07-03 15:05:31 -07001935 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001936}
1937sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001938 my ($type, $msg) = @_;
1939
1940 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001941 our $clean = 0;
1942 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001943 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001944 }
Joe Perches3705ce52013-07-03 15:05:31 -07001945 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001946}
1947
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001948sub check_absolute_file {
1949 my ($absolute, $herecurr) = @_;
1950 my $file = $absolute;
1951
1952 ##print "absolute<$absolute>\n";
1953
1954 # See if any suffix of this path is a path within the tree.
1955 while ($file =~ s@^[^/]*/@@) {
1956 if (-f "$root/$file") {
1957 ##print "file<$file>\n";
1958 last;
1959 }
1960 }
1961 if (! -f _) {
1962 return 0;
1963 }
1964
1965 # It is, so see if the prefix is acceptable.
1966 my $prefix = $absolute;
1967 substr($prefix, -length($file)) = '';
1968
1969 ##print "prefix<$prefix>\n";
1970 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001971 WARN("USE_RELATIVE_PATH",
1972 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001973 }
1974}
1975
Joe Perches3705ce52013-07-03 15:05:31 -07001976sub trim {
1977 my ($string) = @_;
1978
Joe Perchesb34c6482013-09-11 14:24:01 -07001979 $string =~ s/^\s+|\s+$//g;
1980
1981 return $string;
1982}
1983
1984sub ltrim {
1985 my ($string) = @_;
1986
1987 $string =~ s/^\s+//;
1988
1989 return $string;
1990}
1991
1992sub rtrim {
1993 my ($string) = @_;
1994
1995 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001996
1997 return $string;
1998}
1999
Joe Perches52ea8502013-11-12 15:10:09 -08002000sub string_find_replace {
2001 my ($string, $find, $replace) = @_;
2002
2003 $string =~ s/$find/$replace/g;
2004
2005 return $string;
2006}
2007
Joe Perches3705ce52013-07-03 15:05:31 -07002008sub tabify {
2009 my ($leading) = @_;
2010
2011 my $source_indent = 8;
2012 my $max_spaces_before_tab = $source_indent - 1;
2013 my $spaces_to_tab = " " x $source_indent;
2014
2015 #convert leading spaces to tabs
2016 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2017 #Remove spaces before a tab
2018 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2019
2020 return "$leading";
2021}
2022
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002023sub pos_last_openparen {
2024 my ($line) = @_;
2025
2026 my $pos = 0;
2027
2028 my $opens = $line =~ tr/\(/\(/;
2029 my $closes = $line =~ tr/\)/\)/;
2030
2031 my $last_openparen = 0;
2032
2033 if (($opens == 0) || ($closes >= $opens)) {
2034 return -1;
2035 }
2036
2037 my $len = length($line);
2038
2039 for ($pos = 0; $pos < $len; $pos++) {
2040 my $string = substr($line, $pos);
2041 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2042 $pos += length($1) - 1;
2043 } elsif (substr($line, $pos, 1) eq '(') {
2044 $last_openparen = $pos;
2045 } elsif (index($string, '(') == -1) {
2046 last;
2047 }
2048 }
2049
Joe Perches91cb5192014-04-03 14:49:32 -07002050 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002051}
2052
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002053sub process {
2054 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002055
2056 my $linenr=0;
2057 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002058 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002059 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002060 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002061
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002062 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002063 my $indent;
2064 my $previndent=0;
2065 my $stashindent=0;
2066
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002067 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002068 my $signoff = 0;
2069 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002070 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002071 my $in_commit_log = 0; #Scanning lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002072 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002073 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002074 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002075 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002076 my $non_utf8_charset = 0;
2077
Joe Perches365dd4e2014-08-06 16:10:42 -07002078 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002079 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002080
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002081 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002082 our $cnt_lines = 0;
2083 our $cnt_error = 0;
2084 our $cnt_warn = 0;
2085 our $cnt_chk = 0;
2086
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002087 # Trace the real file/line as we go.
2088 my $realfile = '';
2089 my $realline = 0;
2090 my $realcnt = 0;
2091 my $here = '';
2092 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002093 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002094 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002095 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002096
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002097 my $prev_values = 'E';
2098
2099 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002100 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002101 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002102 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002103 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002104
Joe Perches7e51f192013-09-11 14:23:57 -07002105 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002106
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002107 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002108 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002109 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002110 my @setup_docs = ();
2111 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002112
Joe Perchesd8b07712013-11-12 15:10:06 -08002113 my $camelcase_file_seeded = 0;
2114
Andy Whitcroft773647a2008-03-28 14:15:58 -07002115 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002116 my $line;
2117 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002118 $linenr++;
2119 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002120
Joe Perches3705ce52013-07-03 15:05:31 -07002121 push(@fixed, $rawline) if ($fix);
2122
Andy Whitcroft773647a2008-03-28 14:15:58 -07002123 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002124 $setup_docs = 0;
2125 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2126 $setup_docs = 1;
2127 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002128 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002129 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002130 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2131 $realline=$1-1;
2132 if (defined $2) {
2133 $realcnt=$3+1;
2134 } else {
2135 $realcnt=1+1;
2136 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002137 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002138
2139 # Guestimate if this is a continuing comment. Run
2140 # the context looking for a comment "edge". If this
2141 # edge is a close comment then we must be in a comment
2142 # at context start.
2143 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002144 my $cnt = $realcnt;
2145 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2146 next if (defined $rawlines[$ln - 1] &&
2147 $rawlines[$ln - 1] =~ /^-/);
2148 $cnt--;
2149 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002150 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002151 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2152 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2153 ($edge) = $1;
2154 last;
2155 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002156 }
2157 if (defined $edge && $edge eq '*/') {
2158 $in_comment = 1;
2159 }
2160
2161 # Guestimate if this is a continuing comment. If this
2162 # is the start of a diff block and this line starts
2163 # ' *' then it is very likely a comment.
2164 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002165 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002166 {
2167 $in_comment = 1;
2168 }
2169
2170 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2171 sanitise_line_reset($in_comment);
2172
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002173 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002174 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002175 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002176 $line = sanitise_line($rawline);
2177 }
2178 push(@lines, $line);
2179
2180 if ($realcnt > 1) {
2181 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2182 } else {
2183 $realcnt = 0;
2184 }
2185
2186 #print "==>$rawline\n";
2187 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002188
2189 if ($setup_docs && $line =~ /^\+/) {
2190 push(@setup_docs, $line);
2191 }
2192 }
2193
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002194 $prefix = '';
2195
Andy Whitcroft773647a2008-03-28 14:15:58 -07002196 $realcnt = 0;
2197 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002198 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002199 foreach my $line (@lines) {
2200 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002201 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002202 my $sline = $line; #copy of $line
2203 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002204
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002205 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002206
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002207#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002208 if (!$in_commit_log &&
2209 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002210 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002211 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002212 $realline=$1-1;
2213 if (defined $2) {
2214 $realcnt=$3+1;
2215 } else {
2216 $realcnt=1+1;
2217 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002218 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002219 $prev_values = 'E';
2220
Andy Whitcroft773647a2008-03-28 14:15:58 -07002221 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002222 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002223 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002224 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002225 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002226
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002227# track the line number as we move through the hunk, note that
2228# new versions of GNU diff omit the leading space on completely
2229# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002230 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002231 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002232 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002233
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002234 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002235 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002236
2237 # Track the previous line.
2238 ($prevline, $stashline) = ($stashline, $line);
2239 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002240 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2241
Andy Whitcroft773647a2008-03-28 14:15:58 -07002242 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002243
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002244 } elsif ($realcnt == 1) {
2245 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002246 }
2247
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002248 my $hunk_line = ($realcnt != 0);
2249
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002250 $here = "#$linenr: " if (!$file);
2251 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002252
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002253 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002254 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002255 if ($line =~ /^diff --git.*?(\S+)$/) {
2256 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002257 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002258 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002259 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002260 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002261 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002262 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002263 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002264
2265 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002266 if (!$file && $tree && $p1_prefix ne '' &&
2267 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002268 WARN("PATCH_PREFIX",
2269 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002270 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002271
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002272 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002273 ERROR("MODIFIED_INCLUDE_ASM",
2274 "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 -07002275 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002276 $found_file = 1;
2277 }
2278
Joe Perches34d88152015-06-25 15:03:05 -07002279#make up the handle for any error we report on this line
2280 if ($showfile) {
2281 $prefix = "$realfile:$realline: "
2282 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002283 if ($file) {
2284 $prefix = "$filename:$realline: ";
2285 } else {
2286 $prefix = "$filename:$linenr: ";
2287 }
Joe Perches34d88152015-06-25 15:03:05 -07002288 }
2289
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002290 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002291 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002292 $check = 1;
2293 } else {
2294 $check = $check_orig;
2295 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002296 next;
2297 }
2298
Randy Dunlap389834b2007-06-08 13:47:03 -07002299 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002300
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002301 my $hereline = "$here\n$rawline\n";
2302 my $herecurr = "$here\n$rawline\n";
2303 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002304
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002305 $cnt_lines++ if ($realcnt != 0);
2306
Joe Perchese518e9a2015-06-25 15:03:27 -07002307# Check if the commit log has what seems like a diff which can confuse patch
2308 if ($in_commit_log && !$commit_log_has_diff &&
2309 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2310 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2311 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2312 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2313 ERROR("DIFF_IN_COMMIT_MSG",
2314 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2315 $commit_log_has_diff = 1;
2316 }
2317
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002318# Check for incorrect file permissions
2319 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2320 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002321 if ($realfile !~ m@scripts/@ &&
2322 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002323 ERROR("EXECUTE_PERMISSIONS",
2324 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002325 }
2326 }
2327
Joe Perches20112472011-07-25 17:13:23 -07002328# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002329 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002330 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002331 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002332 }
2333
Joe Perchese0d975b2014-12-10 15:51:49 -08002334# Check if MAINTAINERS is being updated. If so, there's probably no need to
2335# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2336 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2337 $reported_maintainer_file = 1;
2338 }
2339
Joe Perches20112472011-07-25 17:13:23 -07002340# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002341 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002342 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002343 my $space_before = $1;
2344 my $sign_off = $2;
2345 my $space_after = $3;
2346 my $email = $4;
2347 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2348
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002349 if ($sign_off !~ /$signature_tags/) {
2350 WARN("BAD_SIGN_OFF",
2351 "Non-standard signature: $sign_off\n" . $herecurr);
2352 }
Joe Perches20112472011-07-25 17:13:23 -07002353 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002354 if (WARN("BAD_SIGN_OFF",
2355 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2356 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002357 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002358 "$ucfirst_sign_off $email";
2359 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002360 }
Joe Perches20112472011-07-25 17:13:23 -07002361 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002362 if (WARN("BAD_SIGN_OFF",
2363 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2364 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002365 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002366 "$ucfirst_sign_off $email";
2367 }
2368
Joe Perches20112472011-07-25 17:13:23 -07002369 }
2370 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002371 if (WARN("BAD_SIGN_OFF",
2372 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2373 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002374 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002375 "$ucfirst_sign_off $email";
2376 }
Joe Perches20112472011-07-25 17:13:23 -07002377 }
2378
2379 my ($email_name, $email_address, $comment) = parse_email($email);
2380 my $suggested_email = format_email(($email_name, $email_address));
2381 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002382 ERROR("BAD_SIGN_OFF",
2383 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002384 } else {
2385 my $dequoted = $suggested_email;
2386 $dequoted =~ s/^"//;
2387 $dequoted =~ s/" </ </;
2388 # Don't force email to have quotes
2389 # Allow just an angle bracketed address
2390 if ("$dequoted$comment" ne $email &&
2391 "<$email_address>$comment" ne $email &&
2392 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002393 WARN("BAD_SIGN_OFF",
2394 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002395 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002396 }
Joe Perches7e51f192013-09-11 14:23:57 -07002397
2398# Check for duplicate signatures
2399 my $sig_nospace = $line;
2400 $sig_nospace =~ s/\s//g;
2401 $sig_nospace = lc($sig_nospace);
2402 if (defined $signatures{$sig_nospace}) {
2403 WARN("BAD_SIGN_OFF",
2404 "Duplicate signature\n" . $herecurr);
2405 } else {
2406 $signatures{$sig_nospace} = 1;
2407 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002408 }
2409
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002410# Check email subject for common tools that don't need to be mentioned
2411 if ($in_header_lines &&
2412 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2413 WARN("EMAIL_SUBJECT",
2414 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2415 }
2416
Joe Perches9b3189eb2014-06-04 16:12:10 -07002417# Check for old stable address
2418 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2419 ERROR("STABLE_ADDRESS",
2420 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2421 }
2422
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002423# Check for unwanted Gerrit info
2424 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2425 ERROR("GERRIT_CHANGE_ID",
2426 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2427 }
2428
Joe Perches369c8dd2015-11-06 16:31:34 -08002429# Check if the commit log is in a possible stack dump
2430 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2431 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2432 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2433 # timestamp
2434 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2435 # stack dump address
2436 $commit_log_possible_stack_dump = 1;
2437 }
2438
Joe Perches2a076f42015-04-16 12:44:28 -07002439# Check for line lengths > 75 in commit log, warn once
2440 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002441 length($line) > 75 &&
2442 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2443 # file delta changes
2444 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2445 # filename then :
2446 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2447 # A Fixes: or Link: line
2448 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002449 WARN("COMMIT_LOG_LONG_LINE",
2450 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2451 $commit_log_long_line = 1;
2452 }
2453
Joe Perchesbf4daf12015-09-09 15:37:50 -07002454# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002455 if ($in_commit_log && $commit_log_possible_stack_dump &&
2456 $line =~ /^\s*$/) {
2457 $commit_log_possible_stack_dump = 0;
2458 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002459
Joe Perches0d7835f2015-02-13 14:38:35 -08002460# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002461 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perches879be4f2016-06-03 14:55:49 -07002462 $line !~ /^\s*(?:Link|Patchwork|http|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002463 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perches369c8dd2015-11-06 16:31:34 -08002464 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2465 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2466 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002467 my $init_char = "c";
2468 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002469 my $short = 1;
2470 my $long = 0;
2471 my $case = 1;
2472 my $space = 1;
2473 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002474 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002475 my $id = '0123456789ab';
2476 my $orig_desc = "commit description";
2477 my $description = "";
2478
Joe Perchesfe043ea2015-09-09 15:37:25 -07002479 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2480 $init_char = $1;
2481 $orig_commit = lc($2);
2482 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2483 $orig_commit = lc($1);
2484 }
2485
Joe Perches0d7835f2015-02-13 14:38:35 -08002486 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2487 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2488 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2489 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2490 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2491 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002492 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002493 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2494 defined $rawlines[$linenr] &&
2495 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2496 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002497 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002498 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2499 defined $rawlines[$linenr] &&
2500 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2501 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2502 $orig_desc = $1;
2503 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2504 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002505 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002506 }
2507
2508 ($id, $description) = git_commit_info($orig_commit,
2509 $id, $orig_desc);
2510
Joe Perches19c146a2015-02-13 14:39:00 -08002511 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002512 ERROR("GIT_COMMIT_ID",
2513 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2514 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002515 }
2516
Joe Perches13f19372014-08-06 16:10:59 -07002517# Check for added, moved or deleted files
2518 if (!$reported_maintainer_file && !$in_commit_log &&
2519 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2520 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2521 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2522 (defined($1) || defined($2))))) {
2523 $reported_maintainer_file = 1;
2524 WARN("FILE_PATH_CHANGES",
2525 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2526 }
2527
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002528# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002529 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002530 ERROR("CORRUPTED_PATCH",
2531 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002532 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002533 }
2534
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002535# Check for absolute kernel paths.
2536 if ($tree) {
2537 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2538 my $file = $1;
2539
2540 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2541 check_absolute_file($1, $herecurr)) {
2542 #
2543 } else {
2544 check_absolute_file($file, $herecurr);
2545 }
2546 }
2547 }
2548
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002549# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2550 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002551 $rawline !~ m/^$UTF8*$/) {
2552 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2553
2554 my $blank = copy_spacing($rawline);
2555 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2556 my $hereptr = "$hereline$ptr\n";
2557
Joe Perches34d99212011-07-25 17:13:26 -07002558 CHK("INVALID_UTF8",
2559 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002560 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002561
Joe Perches15662b32011-10-31 17:13:12 -07002562# Check if it's the start of a commit log
2563# (not a header line and we haven't seen the patch filename)
2564 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002565 !($rawline =~ /^\s+\S/ ||
2566 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002567 $in_header_lines = 0;
2568 $in_commit_log = 1;
2569 }
2570
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002571# Check if there is UTF-8 in a commit log when a mail header has explicitly
2572# declined it, i.e defined some charset where it is missing.
2573 if ($in_header_lines &&
2574 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2575 $1 !~ /utf-8/i) {
2576 $non_utf8_charset = 1;
2577 }
2578
2579 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002580 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002581 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002582 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2583 }
2584
Kees Cook66b47b42014-10-13 15:51:57 -07002585# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002586 if (defined($misspellings) &&
2587 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002588 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002589 my $typo = $1;
2590 my $typo_fix = $spelling_fix{lc($typo)};
2591 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2592 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2593 my $msg_type = \&WARN;
2594 $msg_type = \&CHK if ($file);
2595 if (&{$msg_type}("TYPO_SPELLING",
2596 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2597 $fix) {
2598 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2599 }
2600 }
2601 }
2602
Andy Whitcroft306708542008-10-15 22:02:28 -07002603# ignore non-hunk lines and lines being removed
2604 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002605
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002606#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002607 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002608 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002609 if (ERROR("DOS_LINE_ENDINGS",
2610 "DOS line endings\n" . $herevet) &&
2611 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002612 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002613 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002614 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2615 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002616 if (ERROR("TRAILING_WHITESPACE",
2617 "trailing whitespace\n" . $herevet) &&
2618 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002619 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002620 }
2621
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002622 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002623 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002624
Josh Triplett4783f892013-11-12 15:10:12 -08002625# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002626 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002627 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2628 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002629 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2630 my $msg_type = \&ERROR;
2631 $msg_type = \&CHK if ($file);
2632 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002633 "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 -08002634 }
2635
Andi Kleen33549572010-05-24 14:33:29 -07002636# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002637# Only applies when adding the entry originally, after that we do not have
2638# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002639 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002640 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002641 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002642 my $cnt = $realcnt;
2643 my $ln = $linenr + 1;
2644 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002645 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002646 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002647 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002648 $f = $lines[$ln - 1];
2649 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2650 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002651
2652 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002653 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002654
Joe Perches8d73e0e2014-08-06 16:10:46 -07002655 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002656 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002657 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002658 $length = -1;
2659 }
2660
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002661 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002662 $f =~ s/#.*//;
2663 $f =~ s/^\s+//;
2664 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002665 if ($f =~ /^\s*config\s/) {
2666 $is_end = 1;
2667 last;
2668 }
Andi Kleen33549572010-05-24 14:33:29 -07002669 $length++;
2670 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002671 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2672 WARN("CONFIG_DESCRIPTION",
2673 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2674 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002675 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002676 }
2677
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002678# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2679 if ($realfile =~ /Kconfig/ &&
2680 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2681 WARN("CONFIG_EXPERIMENTAL",
2682 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2683 }
2684
Christoph Jaeger327953e2015-02-13 14:38:29 -08002685# discourage the use of boolean for type definition attributes of Kconfig options
2686 if ($realfile =~ /Kconfig/ &&
2687 $line =~ /^\+\s*\bboolean\b/) {
2688 WARN("CONFIG_TYPE_BOOLEAN",
2689 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2690 }
2691
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002692 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2693 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2694 my $flag = $1;
2695 my $replacement = {
2696 'EXTRA_AFLAGS' => 'asflags-y',
2697 'EXTRA_CFLAGS' => 'ccflags-y',
2698 'EXTRA_CPPFLAGS' => 'cppflags-y',
2699 'EXTRA_LDFLAGS' => 'ldflags-y',
2700 };
2701
2702 WARN("DEPRECATED_VARIABLE",
2703 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2704 }
2705
Rob Herringbff5da42014-01-23 15:54:51 -08002706# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002707 if (defined $root &&
2708 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2709 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2710
Rob Herringbff5da42014-01-23 15:54:51 -08002711 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2712
Florian Vaussardcc933192014-04-03 14:49:27 -07002713 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2714 my $vp_file = $dt_path . "vendor-prefixes.txt";
2715
Rob Herringbff5da42014-01-23 15:54:51 -08002716 foreach my $compat (@compats) {
2717 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002718 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2719 my $compat3 = $compat;
2720 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2721 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002722 if ( $? >> 8 ) {
2723 WARN("UNDOCUMENTED_DT_STRING",
2724 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2725 }
2726
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002727 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2728 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002729 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002730 if ( $? >> 8 ) {
2731 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002732 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002733 }
2734 }
2735 }
2736
Andy Whitcroft5368df202008-10-15 22:02:27 -07002737# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002738 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002739
Joe Perches47e0c882015-06-25 15:02:57 -07002740# line length limit (with some exclusions)
2741#
2742# There are a few types of lines that may extend beyond $max_line_length:
2743# logging functions like pr_info that end in a string
2744# lines with a single string
2745# #defines that are a single string
2746#
2747# There are 3 different line length message types:
2748# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2749# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2750# LONG_LINE all other lines longer than $max_line_length
2751#
2752# if LONG_LINE is ignored, the other 2 types are also ignored
2753#
2754
Joe Perchesb4749e92015-07-17 16:24:01 -07002755 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002756 my $msg_type = "LONG_LINE";
2757
2758 # Check the allowed long line types first
2759
2760 # logging functions that end in a string that starts
2761 # before $max_line_length
2762 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2763 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2764 $msg_type = "";
2765
2766 # lines with only strings (w/ possible termination)
2767 # #defines with only strings
2768 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2769 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2770 $msg_type = "";
2771
Joe Perchesd560a5f2016-08-02 14:04:31 -07002772 # EFI_GUID is another special case
2773 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2774 $msg_type = "";
2775
Joe Perches47e0c882015-06-25 15:02:57 -07002776 # Otherwise set the alternate message types
2777
2778 # a comment starts before $max_line_length
2779 } elsif ($line =~ /($;[\s$;]*)$/ &&
2780 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2781 $msg_type = "LONG_LINE_COMMENT"
2782
2783 # a quoted string starts before $max_line_length
2784 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2785 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2786 $msg_type = "LONG_LINE_STRING"
2787 }
2788
2789 if ($msg_type ne "" &&
2790 (show_type("LONG_LINE") || show_type($msg_type))) {
2791 WARN($msg_type,
2792 "line over $max_line_length characters\n" . $herecurr);
2793 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002794 }
2795
Andy Whitcroft8905a672007-11-28 16:21:06 -08002796# check for adding lines without a newline.
2797 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002798 WARN("MISSING_EOF_NEWLINE",
2799 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002800 }
2801
Mike Frysinger42e41c52009-09-21 17:04:40 -07002802# Blackfin: use hi/lo macros
2803 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2804 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2805 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002806 ERROR("LO_MACRO",
2807 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002808 }
2809 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2810 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002811 ERROR("HI_MACRO",
2812 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002813 }
2814 }
2815
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002816# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002817 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002818
2819# at the beginning of a line any tabs must come first and anything
2820# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002821 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2822 $rawline =~ /^\+\s* \s*/) {
2823 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002824 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002825 if (ERROR("CODE_INDENT",
2826 "code indent should use tabs where possible\n" . $herevet) &&
2827 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002828 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002829 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002830 }
2831
Alberto Panizzo08e44362010-03-05 13:43:54 -08002832# check for space before tabs.
2833 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2834 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002835 if (WARN("SPACE_BEFORE_TAB",
2836 "please, no space before tabs\n" . $herevet) &&
2837 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002838 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002839 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002840 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002841 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002842 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002843 }
2844
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002845# check for && or || at the start of a line
2846 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2847 CHK("LOGICAL_CONTINUATIONS",
2848 "Logical continuations should be on the previous line\n" . $hereprev);
2849 }
2850
Joe Perchesa91e8992016-05-20 17:04:05 -07002851# check indentation starts on a tab stop
2852 if ($^V && $^V ge 5.10.0 &&
2853 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2854 my $indent = length($1);
2855 if ($indent % 8) {
2856 if (WARN("TABSTOP",
2857 "Statements should start on a tabstop\n" . $herecurr) &&
2858 $fix) {
2859 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2860 }
2861 }
2862 }
2863
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002864# check multi-line statement indentation matches previous line
2865 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002866 $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 -07002867 $prevline =~ /^\+(\t*)(.*)$/;
2868 my $oldindent = $1;
2869 my $rest = $2;
2870
2871 my $pos = pos_last_openparen($rest);
2872 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002873 $line =~ /^(\+| )([ \t]*)/;
2874 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002875
2876 my $goodtabindent = $oldindent .
2877 "\t" x ($pos / 8) .
2878 " " x ($pos % 8);
2879 my $goodspaceindent = $oldindent . " " x $pos;
2880
2881 if ($newindent ne $goodtabindent &&
2882 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002883
2884 if (CHK("PARENTHESIS_ALIGNMENT",
2885 "Alignment should match open parenthesis\n" . $hereprev) &&
2886 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002887 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002888 s/^\+[ \t]*/\+$goodtabindent/;
2889 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002890 }
2891 }
2892 }
2893
Joe Perches6ab3a972015-04-16 12:44:05 -07002894# check for space after cast like "(int) foo" or "(struct foo) bar"
2895# avoid checking a few false positives:
2896# "sizeof(<type>)" or "__alignof__(<type>)"
2897# function pointer declarations like "(*foo)(int) = bar;"
2898# structure definitions like "(struct foo) { 0 };"
2899# multiline macros that define functions
2900# known attributes or the __attribute__ keyword
2901 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2902 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002903 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002904 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002905 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002906 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002907 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002908 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002909 }
2910
Joe Perches86406b12015-09-09 15:37:41 -07002911# Block comment styles
2912# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002913 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002914 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002915 $rawline =~ /^\+[ \t]*\*/ &&
2916 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002917 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2918 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2919 }
2920
Joe Perches86406b12015-09-09 15:37:41 -07002921# Block comments use * on subsequent lines
2922 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2923 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002924 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002925 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002926 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002927 WARN("BLOCK_COMMENT_STYLE",
2928 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002929 }
2930
Joe Perches86406b12015-09-09 15:37:41 -07002931# Block comments use */ on trailing lines
2932 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002933 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2934 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2935 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002936 WARN("BLOCK_COMMENT_STYLE",
2937 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002938 }
2939
Joe Perches7f619192014-08-06 16:10:39 -07002940# check for missing blank lines after struct/union declarations
2941# with exceptions for various attributes and macros
2942 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2943 $line =~ /^\+/ &&
2944 !($line =~ /^\+\s*$/ ||
2945 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2946 $line =~ /^\+\s*MODULE_/i ||
2947 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2948 $line =~ /^\+[a-z_]*init/ ||
2949 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2950 $line =~ /^\+\s*DECLARE/ ||
2951 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002952 if (CHK("LINE_SPACING",
2953 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2954 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002955 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002956 }
Joe Perches7f619192014-08-06 16:10:39 -07002957 }
2958
Joe Perches365dd4e2014-08-06 16:10:42 -07002959# check for multiple consecutive blank lines
2960 if ($prevline =~ /^[\+ ]\s*$/ &&
2961 $line =~ /^\+\s*$/ &&
2962 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002963 if (CHK("LINE_SPACING",
2964 "Please don't use multiple blank lines\n" . $hereprev) &&
2965 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002966 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002967 }
2968
Joe Perches365dd4e2014-08-06 16:10:42 -07002969 $last_blank_line = $linenr;
2970 }
2971
Joe Perches3b617e32014-04-03 14:49:28 -07002972# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002973 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2974 # actual declarations
2975 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002976 # function pointer declarations
2977 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002978 # foo bar; where foo is some local typedef or #define
2979 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2980 # known declaration macros
2981 $prevline =~ /^\+\s+$declaration_macros/) &&
2982 # for "else if" which can look like "$Ident $Ident"
2983 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2984 # other possible extensions of declaration lines
2985 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2986 # not starting a section or a macro "\" extended line
2987 $prevline =~ /(?:\{\s*|\\)$/) &&
2988 # looks like a declaration
2989 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002990 # function pointer declarations
2991 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002992 # foo bar; where foo is some local typedef or #define
2993 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2994 # known declaration macros
2995 $sline =~ /^\+\s+$declaration_macros/ ||
2996 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002997 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002998 # start or end of block or continuation of declaration
2999 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3000 # bitfield continuation
3001 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3002 # other possible extensions of declaration lines
3003 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3004 # indentation of previous and current line are the same
3005 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003006 if (WARN("LINE_SPACING",
3007 "Missing a blank line after declarations\n" . $hereprev) &&
3008 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003009 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003010 }
Joe Perches3b617e32014-04-03 14:49:28 -07003011 }
3012
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003013# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003014# Exceptions:
3015# 1) within comments
3016# 2) indented preprocessor commands
3017# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003018 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003019 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003020 if (WARN("LEADING_SPACE",
3021 "please, no spaces at the start of a line\n" . $herevet) &&
3022 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003023 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003024 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003025 }
3026
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003027# check we are in a valid C source file if not then ignore this hunk
3028 next if ($realfile !~ /\.(h|c)$/);
3029
Joe Perches032a4c02014-08-06 16:10:29 -07003030# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003031# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003032# if the previous line is a break or return and is indented 1 tab more...
3033 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3034 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003035 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3036 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3037 defined $lines[$linenr] &&
3038 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003039 WARN("UNNECESSARY_ELSE",
3040 "else is not generally useful after a break or return\n" . $hereprev);
3041 }
3042 }
3043
Joe Perchesc00df192014-08-06 16:11:01 -07003044# check indentation of a line with a break;
3045# if the previous line is a goto or return and is indented the same # of tabs
3046 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3047 my $tabs = $1;
3048 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3049 WARN("UNNECESSARY_BREAK",
3050 "break is not useful after a goto or return\n" . $hereprev);
3051 }
3052 }
3053
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003054# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3055 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3056 WARN("CONFIG_EXPERIMENTAL",
3057 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3058 }
3059
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003060# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003061 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003062 WARN("CVS_KEYWORD",
3063 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003064 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003065
Mike Frysinger42e41c52009-09-21 17:04:40 -07003066# Blackfin: don't use __builtin_bfin_[cs]sync
3067 if ($line =~ /__builtin_bfin_csync/) {
3068 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003069 ERROR("CSYNC",
3070 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003071 }
3072 if ($line =~ /__builtin_bfin_ssync/) {
3073 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003074 ERROR("SSYNC",
3075 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003076 }
3077
Joe Perches56e77d72013-02-21 16:44:14 -08003078# check for old HOTPLUG __dev<foo> section markings
3079 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3080 WARN("HOTPLUG_SECTION",
3081 "Using $1 is unnecessary\n" . $herecurr);
3082 }
3083
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003084# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003085 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3086 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003087#print "LINE<$line>\n";
3088 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003089 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003090 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003091 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003092 $stat =~ s/\n./\n /g;
3093 $cond =~ s/\n./\n /g;
3094
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003095#print "linenr<$linenr> <$stat>\n";
3096 # If this statement has no statement boundaries within
3097 # it there is no point in retrying a statement scan
3098 # until we hit end of it.
3099 my $frag = $stat; $frag =~ s/;+\s*$//;
3100 if ($frag !~ /(?:{|;)/) {
3101#print "skip<$line_nr_next>\n";
3102 $suppress_statement = $line_nr_next;
3103 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003104
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003105 # Find the real next line.
3106 $realline_next = $line_nr_next;
3107 if (defined $realline_next &&
3108 (!defined $lines[$realline_next - 1] ||
3109 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3110 $realline_next++;
3111 }
3112
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003113 my $s = $stat;
3114 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003115
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003116 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003117 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003118
3119 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003120 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003121
Andy Whitcroft463f2862009-09-21 17:04:34 -07003122 } elsif ($s =~ /^.\s*else\b/s) {
3123
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003124 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003125 } 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 -07003126 my $type = $1;
3127 $type =~ s/\s+/ /g;
3128 possible($type, "A:" . $s);
3129
Andy Whitcroft8905a672007-11-28 16:21:06 -08003130 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003131 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003132 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003133 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003134
3135 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003136 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003137 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003138 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003139
3140 # Check for any sort of function declaration.
3141 # int foo(something bar, other baz);
3142 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003143 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 -08003144 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003145
Andy Whitcroftcf655042008-03-04 14:28:20 -08003146 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003147 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003148 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003149
Andy Whitcroft8905a672007-11-28 16:21:06 -08003150 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003151 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003152
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003153 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003154 }
3155 }
3156 }
3157
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003158 }
3159
Andy Whitcroft653d4872007-06-23 17:16:34 -07003160#
3161# Checks which may be anchored in the context.
3162#
3163
3164# Check for switch () and associated case and default
3165# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003166 if ($line=~/\bswitch\s*\(.*\)/) {
3167 my $err = '';
3168 my $sep = '';
3169 my @ctx = ctx_block_outer($linenr, $realcnt);
3170 shift(@ctx);
3171 for my $ctx (@ctx) {
3172 my ($clen, $cindent) = line_stats($ctx);
3173 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3174 $indent != $cindent) {
3175 $err .= "$sep$ctx\n";
3176 $sep = '';
3177 } else {
3178 $sep = "[...]\n";
3179 }
3180 }
3181 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003182 ERROR("SWITCH_CASE_INDENT_LEVEL",
3183 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003184 }
3185 }
3186
3187# if/while/etc brace do not go on next line, unless defining a do while loop,
3188# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003189 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003190 my $pre_ctx = "$1$2";
3191
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003192 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003193
3194 if ($line =~ /^\+\t{6,}/) {
3195 WARN("DEEP_INDENTATION",
3196 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3197 }
3198
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003199 my $ctx_cnt = $realcnt - $#ctx - 1;
3200 my $ctx = join("\n", @ctx);
3201
Andy Whitcroft548596d2008-07-23 21:29:01 -07003202 my $ctx_ln = $linenr;
3203 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003204
Andy Whitcroft548596d2008-07-23 21:29:01 -07003205 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3206 defined $lines[$ctx_ln - 1] &&
3207 $lines[$ctx_ln - 1] =~ /^-/)) {
3208 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3209 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003210 $ctx_ln++;
3211 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003212
Andy Whitcroft53210162008-07-23 21:29:03 -07003213 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3214 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003215
Joe Perchesd752fcc2014-08-06 16:11:05 -07003216 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003217 ERROR("OPEN_BRACE",
3218 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003219 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003220 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003221 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3222 $ctx =~ /\)\s*\;\s*$/ &&
3223 defined $lines[$ctx_ln - 1])
3224 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003225 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3226 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003227 WARN("TRAILING_SEMICOLON",
3228 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003229 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003230 }
3231 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003232 }
3233
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003234# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003235 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003236 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3237 ctx_statement_block($linenr, $realcnt, 0)
3238 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003239 my ($s, $c) = ($stat, $cond);
3240
3241 substr($s, 0, length($c), '');
3242
Joe Perches9f5af482015-09-09 15:37:30 -07003243 # remove inline comments
3244 $s =~ s/$;/ /g;
3245 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003246
3247 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003248 my @newlines = ($c =~ /\n/gs);
3249 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003250
Joe Perches9f5af482015-09-09 15:37:30 -07003251 # Make sure we remove the line prefixes as we have
3252 # none on the first line, and are going to readd them
3253 # where necessary.
3254 $s =~ s/\n./\n/gs;
3255 while ($s =~ /\n\s+\\\n/) {
3256 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3257 }
3258
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003259 # We want to check the first line inside the block
3260 # starting at the end of the conditional, so remove:
3261 # 1) any blank line termination
3262 # 2) any opening brace { on end of the line
3263 # 3) any do (...) {
3264 my $continuation = 0;
3265 my $check = 0;
3266 $s =~ s/^.*\bdo\b//;
3267 $s =~ s/^\s*{//;
3268 if ($s =~ s/^\s*\\//) {
3269 $continuation = 1;
3270 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003271 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003272 $check = 1;
3273 $cond_lines++;
3274 }
3275
3276 # Also ignore a loop construct at the end of a
3277 # preprocessor statement.
3278 if (($prevline =~ /^.\s*#\s*define\s/ ||
3279 $prevline =~ /\\\s*$/) && $continuation == 0) {
3280 $check = 0;
3281 }
3282
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003283 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003284 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003285 while ($cond_ptr != $cond_lines) {
3286 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003287
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003288 # If we see an #else/#elif then the code
3289 # is not linear.
3290 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3291 $check = 0;
3292 }
3293
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003294 # Ignore:
3295 # 1) blank lines, they should be at 0,
3296 # 2) preprocessor lines, and
3297 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003298 if ($continuation ||
3299 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003300 $s =~ /^\s*#\s*?/ ||
3301 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003302 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003303 if ($s =~ s/^.*?\n//) {
3304 $cond_lines++;
3305 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003306 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003307 }
3308
3309 my (undef, $sindent) = line_stats("+" . $s);
3310 my $stat_real = raw_line($linenr, $cond_lines);
3311
3312 # Check if either of these lines are modified, else
3313 # this is not this patch's fault.
3314 if (!defined($stat_real) ||
3315 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3316 $check = 0;
3317 }
3318 if (defined($stat_real) && $cond_lines > 1) {
3319 $stat_real = "[...]\n$stat_real";
3320 }
3321
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003322 #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 -07003323
Joe Perches9f5af482015-09-09 15:37:30 -07003324 if ($check && $s ne '' &&
3325 (($sindent % 8) != 0 ||
3326 ($sindent < $indent) ||
3327 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003328 WARN("SUSPECT_CODE_INDENT",
3329 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003330 }
3331 }
3332
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003333 # Track the 'values' across context and added lines.
3334 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003335 my ($curr_values, $curr_vars) =
3336 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003337 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003338 if ($dbg_values) {
3339 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003340 print "$linenr > .$outline\n";
3341 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003342 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003343 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003344 $prev_values = substr($curr_values, -1);
3345
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003346#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003347 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003348
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003349# check for declarations of signed or unsigned without int
Joe Perches207a8e82016-03-15 14:58:06 -07003350 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003351 my $type = $1;
3352 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003353 $var = "" if (!defined $var);
3354 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003355 my $sign = $1;
3356 my $pointer = $2;
3357
3358 $pointer = "" if (!defined $pointer);
3359
3360 if (WARN("UNSPECIFIED_INT",
3361 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3362 $fix) {
3363 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003364 my $comp_pointer = $pointer;
3365 $comp_pointer =~ s/\s//g;
3366 $decl .= $comp_pointer;
3367 $decl = rtrim($decl) if ($var eq "");
3368 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003369 }
3370 }
3371 }
3372
Andy Whitcroft653d4872007-06-23 17:16:34 -07003373# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003374 if ($dbg_type) {
3375 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003376 ERROR("TEST_TYPE",
3377 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003378 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003379 ERROR("TEST_NOT_TYPE",
3380 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003381 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003382 next;
3383 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003384# TEST: allow direct testing of the attribute matcher.
3385 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003386 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003387 ERROR("TEST_ATTR",
3388 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003389 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003390 ERROR("TEST_NOT_ATTR",
3391 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003392 }
3393 next;
3394 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003395
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003396# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003397 if ($line =~ /^.\s*{/ &&
3398 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003399 if (ERROR("OPEN_BRACE",
3400 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003401 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3402 fix_delete_line($fixlinenr - 1, $prevrawline);
3403 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003404 my $fixedline = $prevrawline;
3405 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003406 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003407 $fixedline = $line;
3408 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003409 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003410 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003411 }
3412
Andy Whitcroft653d4872007-06-23 17:16:34 -07003413#
3414# Checks which are anchored on the added line.
3415#
3416
3417# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003418 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003419 my $path = $1;
3420 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003421 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003422 "malformed #include filename\n" . $herecurr);
3423 }
3424 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3425 ERROR("UAPI_INCLUDE",
3426 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003427 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003428 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003429
3430# no C99 // comments
3431 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003432 if (ERROR("C99_COMMENTS",
3433 "do not use C99 // comments\n" . $herecurr) &&
3434 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003435 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003436 if ($line =~ /\/\/(.*)$/) {
3437 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003438 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003439 }
3440 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003441 }
3442 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003443 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003444 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003445
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003446# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3447# the whole statement.
3448#print "APW <$lines[$realline_next - 1]>\n";
3449 if (defined $realline_next &&
3450 exists $lines[$realline_next - 1] &&
3451 !defined $suppress_export{$realline_next} &&
3452 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3453 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003454 # Handle definitions which produce identifiers with
3455 # a prefix:
3456 # XXX(foo);
3457 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003458 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003459 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003460 $name =~ /^${Ident}_$2/) {
3461#print "FOO C name<$name>\n";
3462 $suppress_export{$realline_next} = 1;
3463
3464 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003465 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003466 ^.DEFINE_$Ident\(\Q$name\E\)|
3467 ^.DECLARE_$Ident\(\Q$name\E\)|
3468 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003469 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3470 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003471 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003472#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3473 $suppress_export{$realline_next} = 2;
3474 } else {
3475 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003476 }
3477 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003478 if (!defined $suppress_export{$linenr} &&
3479 $prevline =~ /^.\s*$/ &&
3480 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3481 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3482#print "FOO B <$lines[$linenr - 1]>\n";
3483 $suppress_export{$linenr} = 2;
3484 }
3485 if (defined $suppress_export{$linenr} &&
3486 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003487 WARN("EXPORT_SYMBOL",
3488 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003489 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003490
Joe Eloff5150bda2010-08-09 17:21:00 -07003491# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003492 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003493 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003494 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003495 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003496 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003497 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003498 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003499# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003500 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003501 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003502 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003503 $herecurr) &&
3504 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003505 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003506 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003507 }
3508
Joe Perches18130872014-08-06 16:11:22 -07003509# check for misordered declarations of char/short/int/long with signed/unsigned
3510 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3511 my $tmp = trim($1);
3512 WARN("MISORDERED_TYPE",
3513 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3514 }
3515
Joe Perchescb710ec2010-10-26 14:23:20 -07003516# check for static const char * arrays.
3517 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003518 WARN("STATIC_CONST_CHAR_ARRAY",
3519 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003520 $herecurr);
3521 }
3522
3523# check for static char foo[] = "bar" declarations.
3524 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003525 WARN("STATIC_CONST_CHAR_ARRAY",
3526 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003527 $herecurr);
3528 }
3529
Joe Perchesab7e23f2015-04-16 12:44:22 -07003530# check for const <foo> const where <foo> is not a pointer or array type
3531 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3532 my $found = $1;
3533 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3534 WARN("CONST_CONST",
3535 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3536 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3537 WARN("CONST_CONST",
3538 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3539 }
3540 }
3541
Joe Perches9b0fa602014-04-03 14:49:18 -07003542# check for non-global char *foo[] = {"bar", ...} declarations.
3543 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3544 WARN("STATIC_CONST_CHAR_ARRAY",
3545 "char * array declaration might be better as static const\n" .
3546 $herecurr);
3547 }
3548
Joe Perchesb598b672015-04-16 12:44:36 -07003549# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3550 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3551 my $array = $1;
3552 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3553 my $array_div = $1;
3554 if (WARN("ARRAY_SIZE",
3555 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3556 $fix) {
3557 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3558 }
3559 }
3560 }
3561
Joe Perchesb36190c2014-01-27 17:07:18 -08003562# check for function declarations without arguments like "int foo()"
3563 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3564 if (ERROR("FUNCTION_WITHOUT_ARGS",
3565 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3566 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003567 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003568 }
3569 }
3570
Joe Perches92e112f2013-12-13 11:36:22 -07003571# check for uses of DEFINE_PCI_DEVICE_TABLE
3572 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3573 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3574 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3575 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003576 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
Joe Perches92e112f2013-12-13 11:36:22 -07003577 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003578 }
3579
Andy Whitcroft653d4872007-06-23 17:16:34 -07003580# check for new typedefs, only function parameters and sparse annotations
3581# make sense.
3582 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003583 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003584 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003585 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003586 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003587 WARN("NEW_TYPEDEFS",
3588 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003589 }
3590
3591# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003592 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003593 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3594 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003595 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003596
Andy Whitcroft65863862009-01-06 14:41:21 -08003597 # Should start with a space.
3598 $to =~ s/^(\S)/ $1/;
3599 # Should not end with a space.
3600 $to =~ s/\s+$//;
3601 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003602 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003603 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003604
Joe Perches3705ce52013-07-03 15:05:31 -07003605## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003606 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003607 if (ERROR("POINTER_LOCATION",
3608 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3609 $fix) {
3610 my $sub_from = $ident;
3611 my $sub_to = $ident;
3612 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003613 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003614 s@\Q$sub_from\E@$sub_to@;
3615 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003616 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003617 }
3618 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3619 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003620 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003621
Andy Whitcroft65863862009-01-06 14:41:21 -08003622 # Should start with a space.
3623 $to =~ s/^(\S)/ $1/;
3624 # Should not end with a space.
3625 $to =~ s/\s+$//;
3626 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003627 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003628 }
3629 # Modifiers should have spaces.
3630 $to =~ s/(\b$Modifier$)/$1 /;
3631
Joe Perches3705ce52013-07-03 15:05:31 -07003632## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003633 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003634 if (ERROR("POINTER_LOCATION",
3635 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3636 $fix) {
3637
3638 my $sub_from = $match;
3639 my $sub_to = $match;
3640 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003641 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003642 s@\Q$sub_from\E@$sub_to@;
3643 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003644 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003645 }
3646
Joe Perches9d3e3c72015-09-09 15:37:27 -07003647# avoid BUG() or BUG_ON()
3648 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3649 my $msg_type = \&WARN;
3650 $msg_type = \&CHK if ($file);
3651 &{$msg_type}("AVOID_BUG",
3652 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3653 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003654
Joe Perches9d3e3c72015-09-09 15:37:27 -07003655# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003656 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003657 WARN("LINUX_VERSION_CODE",
3658 "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 -08003659 }
3660
Joe Perches17441222011-06-15 15:08:17 -07003661# check for uses of printk_ratelimit
3662 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003663 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003664 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003665 }
3666
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003667# printk should use KERN_* levels. Note that follow on printk's on the
3668# same line do not need a level, so we use the current block context
3669# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003670# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003671# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003672 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003673 my $ok = 0;
3674 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3675 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003676 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003677 # with "\n" ignore it, else it is to blame
3678 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3679 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3680 $ok = 1;
3681 }
3682 last;
3683 }
3684 }
3685 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003686 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3687 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003688 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003689 }
3690
Joe Perches243f3802012-05-31 16:26:09 -07003691 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3692 my $orig = $1;
3693 my $level = lc($orig);
3694 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003695 my $level2 = $level;
3696 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003697 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003698 "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 -07003699 }
3700
3701 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003702 if (WARN("PREFER_PR_LEVEL",
3703 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3704 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003705 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003706 s/\bpr_warning\b/pr_warn/;
3707 }
Joe Perches243f3802012-05-31 16:26:09 -07003708 }
3709
Joe Perchesdc139312013-02-21 16:44:13 -08003710 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3711 my $orig = $1;
3712 my $level = lc($orig);
3713 $level = "warn" if ($level eq "warning");
3714 $level = "dbg" if ($level eq "debug");
3715 WARN("PREFER_DEV_LEVEL",
3716 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3717 }
3718
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003719# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3720# number of false positives, but assembly files are not checked, so at
3721# least the arch entry code will not trigger this warning.
3722 if ($line =~ /\bENOSYS\b/) {
3723 WARN("ENOSYS",
3724 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3725 }
3726
Andy Whitcroft653d4872007-06-23 17:16:34 -07003727# function brace can't be on same line, except for #defines of do while,
3728# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003729 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003730 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003731 if (ERROR("OPEN_BRACE",
3732 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3733 $fix) {
3734 fix_delete_line($fixlinenr, $rawline);
3735 my $fixed_line = $rawline;
3736 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3737 my $line1 = $1;
3738 my $line2 = $2;
3739 fix_insert_line($fixlinenr, ltrim($line1));
3740 fix_insert_line($fixlinenr, "\+{");
3741 if ($line2 !~ /^\s*$/) {
3742 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3743 }
3744 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003745 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003746
Andy Whitcroft8905a672007-11-28 16:21:06 -08003747# open braces for enum, union and struct go on the same line.
3748 if ($line =~ /^.\s*{/ &&
3749 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003750 if (ERROR("OPEN_BRACE",
3751 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3752 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3753 fix_delete_line($fixlinenr - 1, $prevrawline);
3754 fix_delete_line($fixlinenr, $rawline);
3755 my $fixedline = rtrim($prevrawline) . " {";
3756 fix_insert_line($fixlinenr, $fixedline);
3757 $fixedline = $rawline;
3758 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3759 if ($fixedline !~ /^\+\s*$/) {
3760 fix_insert_line($fixlinenr, $fixedline);
3761 }
3762 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003763 }
3764
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003765# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003766 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3767 if (WARN("SPACING",
3768 "missing space after $1 definition\n" . $herecurr) &&
3769 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003770 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003771 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3772 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003773 }
3774
Joe Perches31070b52014-01-23 15:54:49 -08003775# Function pointer declarations
3776# check spacing between type, funcptr, and args
3777# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003778 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003779 my $declare = $1;
3780 my $pre_pointer_space = $2;
3781 my $post_pointer_space = $3;
3782 my $funcname = $4;
3783 my $post_funcname_space = $5;
3784 my $pre_args_space = $6;
3785
Joe Perches91f72e92014-04-03 14:49:12 -07003786# the $Declare variable will capture all spaces after the type
3787# so check it for a missing trailing missing space but pointer return types
3788# don't need a space so don't warn for those.
3789 my $post_declare_space = "";
3790 if ($declare =~ /(\s+)$/) {
3791 $post_declare_space = $1;
3792 $declare = rtrim($declare);
3793 }
3794 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003795 WARN("SPACING",
3796 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003797 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003798 }
3799
3800# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003801# This test is not currently implemented because these declarations are
3802# equivalent to
3803# int foo(int bar, ...)
3804# and this is form shouldn't/doesn't generate a checkpatch warning.
3805#
3806# elsif ($declare =~ /\s{2,}$/) {
3807# WARN("SPACING",
3808# "Multiple spaces after return type\n" . $herecurr);
3809# }
Joe Perches31070b52014-01-23 15:54:49 -08003810
3811# unnecessary space "type ( *funcptr)(args...)"
3812 if (defined $pre_pointer_space &&
3813 $pre_pointer_space =~ /^\s/) {
3814 WARN("SPACING",
3815 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3816 }
3817
3818# unnecessary space "type (* funcptr)(args...)"
3819 if (defined $post_pointer_space &&
3820 $post_pointer_space =~ /^\s/) {
3821 WARN("SPACING",
3822 "Unnecessary space before function pointer name\n" . $herecurr);
3823 }
3824
3825# unnecessary space "type (*funcptr )(args...)"
3826 if (defined $post_funcname_space &&
3827 $post_funcname_space =~ /^\s/) {
3828 WARN("SPACING",
3829 "Unnecessary space after function pointer name\n" . $herecurr);
3830 }
3831
3832# unnecessary space "type (*funcptr) (args...)"
3833 if (defined $pre_args_space &&
3834 $pre_args_space =~ /^\s/) {
3835 WARN("SPACING",
3836 "Unnecessary space before function pointer arguments\n" . $herecurr);
3837 }
3838
3839 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003840 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003841 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003842 }
3843 }
3844
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003845# check for spacing round square brackets; allowed:
3846# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003847# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3848# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003849 while ($line =~ /(.*?\s)\[/g) {
3850 my ($where, $prefix) = ($-[1], $1);
3851 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003852 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003853 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003854 if (ERROR("BRACKET_SPACE",
3855 "space prohibited before open square bracket '['\n" . $herecurr) &&
3856 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003857 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003858 s/^(\+.*?)\s+\[/$1\[/;
3859 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003860 }
3861 }
3862
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003863# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003864 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003865 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003866 my $ctx_before = substr($line, 0, $-[1]);
3867 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003868
3869 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003870 if ($name =~ /^(?:
3871 if|for|while|switch|return|case|
3872 volatile|__volatile__|
3873 __attribute__|format|__extension__|
3874 asm|__asm__)$/x)
3875 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003876 # cpp #define statements have non-optional spaces, ie
3877 # if there is a space between the name and the open
3878 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003879 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003880
3881 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003882 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003883
3884 # If this whole things ends with a type its most
3885 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003886 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003887
3888 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003889 if (WARN("SPACING",
3890 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3891 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003892 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003893 s/\b$name\s+\(/$name\(/;
3894 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003895 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003896 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003897
Andy Whitcroft653d4872007-06-23 17:16:34 -07003898# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003899 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003900 my $fixed_line = "";
3901 my $line_fixed = 0;
3902
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003903 my $ops = qr{
3904 <<=|>>=|<=|>=|==|!=|
3905 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3906 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003907 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003908 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003909 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003910 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003911
3912## print("element count: <" . $#elements . ">\n");
3913## foreach my $el (@elements) {
3914## print("el: <$el>\n");
3915## }
3916
3917 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003918 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003919
Joe Perches3705ce52013-07-03 15:05:31 -07003920 foreach my $el (@elements) {
3921 push(@fix_elements, substr($rawline, $off, length($el)));
3922 $off += length($el);
3923 }
3924
3925 $off = 0;
3926
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003927 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003928 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003929
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003930 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003931
3932 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3933
3934## print("n: <$n> good: <$good>\n");
3935
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003936 $off += length($elements[$n]);
3937
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003938 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003939 my $ca = substr($opline, 0, $off);
3940 my $cc = '';
3941 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3942 $cc = substr($opline, $off + length($elements[$n + 1]));
3943 }
3944 my $cb = "$ca$;$cc";
3945
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003946 my $a = '';
3947 $a = 'V' if ($elements[$n] ne '');
3948 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003949 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003950 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3951 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003952 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003953
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003954 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003955
3956 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003957 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003958 $c = 'V' if ($elements[$n + 2] ne '');
3959 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003960 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003961 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3962 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003963 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003964 } else {
3965 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003966 }
3967
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003968 my $ctx = "${a}x${c}";
3969
3970 my $at = "(ctx:$ctx)";
3971
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003972 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003973 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003974
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003975 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003976 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003977
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003978 # Get the full operator variant.
3979 my $opv = $op . substr($curr_vars, $off, 1);
3980
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003981 # Ignore operators passed as parameters.
3982 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003983 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003984
Andy Whitcroftcf655042008-03-04 14:28:20 -08003985# # Ignore comments
3986# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003987
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003988 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003989 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003990 if ($ctx !~ /.x[WEBC]/ &&
3991 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003992 if (ERROR("SPACING",
3993 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003994 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003995 $line_fixed = 1;
3996 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003997 }
3998
3999 # // is a comment
4000 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004001
Joe Perchesb00e4812014-04-03 14:49:33 -07004002 # : when part of a bitfield
4003 } elsif ($opv eq ':B') {
4004 # skip the bitfield test for now
4005
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004006 # No spaces for:
4007 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004008 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004009 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004010 if (ERROR("SPACING",
4011 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004012 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004013 if (defined $fix_elements[$n + 2]) {
4014 $fix_elements[$n + 2] =~ s/^\s+//;
4015 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004016 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004017 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004018 }
4019
Joe Perches23810972014-12-10 15:51:32 -08004020 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004021 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004022 my $rtrim_before = 0;
4023 my $space_after = 0;
4024 if ($ctx =~ /Wx./) {
4025 if (ERROR("SPACING",
4026 "space prohibited before that '$op' $at\n" . $hereptr)) {
4027 $line_fixed = 1;
4028 $rtrim_before = 1;
4029 }
4030 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004031 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004032 if (ERROR("SPACING",
4033 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004034 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004035 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004036 $space_after = 1;
4037 }
4038 }
4039 if ($rtrim_before || $space_after) {
4040 if ($rtrim_before) {
4041 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4042 } else {
4043 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4044 }
4045 if ($space_after) {
4046 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004047 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004048 }
4049
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004050 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004051 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004052 #warn "'*' is part of type\n";
4053
4054 # unary operators should have a space before and
4055 # none after. May be left adjacent to another
4056 # unary operator, or a cast
4057 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004058 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004059 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004060 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004061 if (ERROR("SPACING",
4062 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004063 if ($n != $last_after + 2) {
4064 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4065 $line_fixed = 1;
4066 }
Joe Perches3705ce52013-07-03 15:05:31 -07004067 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004068 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004069 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004070 # A unary '*' may be const
4071
4072 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004073 if (ERROR("SPACING",
4074 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004075 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004076 if (defined $fix_elements[$n + 2]) {
4077 $fix_elements[$n + 2] =~ s/^\s+//;
4078 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004079 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004080 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004081 }
4082
4083 # unary ++ and unary -- are allowed no space on one side.
4084 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004085 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004086 if (ERROR("SPACING",
4087 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004088 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004089 $line_fixed = 1;
4090 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004091 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004092 if ($ctx =~ /Wx[BE]/ ||
4093 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004094 if (ERROR("SPACING",
4095 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004096 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004097 $line_fixed = 1;
4098 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004099 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004100 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004101 if (ERROR("SPACING",
4102 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004103 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004104 if (defined $fix_elements[$n + 2]) {
4105 $fix_elements[$n + 2] =~ s/^\s+//;
4106 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004107 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004108 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004109 }
4110
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004111 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004112 } elsif ($op eq '<<' or $op eq '>>' or
4113 $op eq '&' or $op eq '^' or $op eq '|' or
4114 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004115 $op eq '*' or $op eq '/' or
4116 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004117 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004118 if ($check) {
4119 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4120 if (CHK("SPACING",
4121 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4122 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4123 $fix_elements[$n + 2] =~ s/^\s+//;
4124 $line_fixed = 1;
4125 }
4126 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4127 if (CHK("SPACING",
4128 "space preferred before that '$op' $at\n" . $hereptr)) {
4129 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4130 $line_fixed = 1;
4131 }
4132 }
4133 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004134 if (ERROR("SPACING",
4135 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004136 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4137 if (defined $fix_elements[$n + 2]) {
4138 $fix_elements[$n + 2] =~ s/^\s+//;
4139 }
Joe Perches3705ce52013-07-03 15:05:31 -07004140 $line_fixed = 1;
4141 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004142 }
4143
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004144 # A colon needs no spaces before when it is
4145 # terminating a case value or a label.
4146 } elsif ($opv eq ':C' || $opv eq ':L') {
4147 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004148 if (ERROR("SPACING",
4149 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004150 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004151 $line_fixed = 1;
4152 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004153 }
4154
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004155 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004156 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004157 my $ok = 0;
4158
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004159 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004160 if (($op eq '<' &&
4161 $cc =~ /^\S+\@\S+>/) ||
4162 ($op eq '>' &&
4163 $ca =~ /<\S+\@\S+$/))
4164 {
4165 $ok = 1;
4166 }
4167
Joe Perchese0df7e12015-04-16 12:44:53 -07004168 # for asm volatile statements
4169 # ignore a colon with another
4170 # colon immediately before or after
4171 if (($op eq ':') &&
4172 ($ca =~ /:$/ || $cc =~ /^:/)) {
4173 $ok = 1;
4174 }
4175
Joe Perches84731622013-11-12 15:10:05 -08004176 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004177 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004178 my $msg_type = \&ERROR;
4179 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4180
4181 if (&{$msg_type}("SPACING",
4182 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004183 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4184 if (defined $fix_elements[$n + 2]) {
4185 $fix_elements[$n + 2] =~ s/^\s+//;
4186 }
Joe Perches3705ce52013-07-03 15:05:31 -07004187 $line_fixed = 1;
4188 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004189 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004190 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004191 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004192
4193## print("n: <$n> GOOD: <$good>\n");
4194
4195 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004196 }
Joe Perches3705ce52013-07-03 15:05:31 -07004197
4198 if (($#elements % 2) == 0) {
4199 $fixed_line = $fixed_line . $fix_elements[$#elements];
4200 }
4201
Joe Perches194f66f2014-08-06 16:11:03 -07004202 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4203 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004204 }
4205
4206
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004207 }
4208
Joe Perches786b6322013-07-03 15:05:32 -07004209# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004210 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004211 if (WARN("SPACING",
4212 "space prohibited before semicolon\n" . $herecurr) &&
4213 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004214 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004215 s/^(\+.*\S)\s+;/$1;/;
4216 }
4217 }
4218
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004219# check for multiple assignments
4220 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004221 CHK("MULTIPLE_ASSIGNMENTS",
4222 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004223 }
4224
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004225## # check for multiple declarations, allowing for a function declaration
4226## # continuation.
4227## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4228## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4229##
4230## # Remove any bracketed sections to ensure we do not
4231## # falsly report the parameters of functions.
4232## my $ln = $line;
4233## while ($ln =~ s/\([^\(\)]*\)//g) {
4234## }
4235## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004236## WARN("MULTIPLE_DECLARATION",
4237## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004238## }
4239## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004240
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004241#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004242 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004243 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004244 if (ERROR("SPACING",
4245 "space required before the open brace '{'\n" . $herecurr) &&
4246 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004247 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004248 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004249 }
4250
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004251## # check for blank lines before declarations
4252## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4253## $prevrawline =~ /^.\s*$/) {
4254## WARN("SPACING",
4255## "No blank lines before declarations\n" . $hereprev);
4256## }
4257##
4258
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004259# closing brace should have a space following it when it has anything
4260# on the line
4261 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004262 if (ERROR("SPACING",
4263 "space required after that close brace '}'\n" . $herecurr) &&
4264 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004265 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004266 s/}((?!(?:,|;|\)))\S)/} $1/;
4267 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004268 }
4269
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004270# check spacing on square brackets
4271 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004272 if (ERROR("SPACING",
4273 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4274 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004275 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004276 s/\[\s+/\[/;
4277 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004278 }
4279 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004280 if (ERROR("SPACING",
4281 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4282 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004283 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004284 s/\s+\]/\]/;
4285 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004286 }
4287
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004288# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004289 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4290 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004291 if (ERROR("SPACING",
4292 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4293 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004294 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004295 s/\(\s+/\(/;
4296 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004297 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004298 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004299 $line !~ /for\s*\(.*;\s+\)/ &&
4300 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004301 if (ERROR("SPACING",
4302 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4303 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004304 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004305 s/\s+\)/\)/;
4306 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004307 }
4308
Joe Perchese2826fd2014-08-06 16:10:48 -07004309# check unnecessary parentheses around addressof/dereference single $Lvals
4310# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4311
4312 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004313 my $var = $1;
4314 if (CHK("UNNECESSARY_PARENTHESES",
4315 "Unnecessary parentheses around $var\n" . $herecurr) &&
4316 $fix) {
4317 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4318 }
4319 }
4320
4321# check for unnecessary parentheses around function pointer uses
4322# ie: (foo->bar)(); should be foo->bar();
4323# but not "if (foo->bar) (" to avoid some false positives
4324 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4325 my $var = $2;
4326 if (CHK("UNNECESSARY_PARENTHESES",
4327 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4328 $fix) {
4329 my $var2 = deparenthesize($var);
4330 $var2 =~ s/\s//g;
4331 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4332 }
4333 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004334
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004335#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004336 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004337 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004338 if (WARN("INDENTED_LABEL",
4339 "labels should not be indented\n" . $herecurr) &&
4340 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004341 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004342 s/^(.)\s+/$1/;
4343 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004344 }
4345
Joe Perches5b9553a2014-04-03 14:49:21 -07004346# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004347 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004348 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004349 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004350 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4351 my $value = $1;
4352 $value = deparenthesize($value);
4353 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4354 ERROR("RETURN_PARENTHESES",
4355 "return is not a function, parentheses are not required\n" . $herecurr);
4356 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004357 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004358 ERROR("SPACING",
4359 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004360 }
4361 }
Joe Perches507e5142013-11-12 15:10:13 -08004362
Joe Perchesb43ae212014-06-23 13:22:07 -07004363# unnecessary return in a void function
4364# at end-of-function, with the previous line a single leading tab, then return;
4365# and the line before that not a goto label target like "out:"
4366 if ($sline =~ /^[ \+]}\s*$/ &&
4367 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4368 $linenr >= 3 &&
4369 $lines[$linenr - 3] =~ /^[ +]/ &&
4370 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004371 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004372 "void function return statements are not generally useful\n" . $hereprev);
4373 }
Joe Perches9819cf22014-06-04 16:12:09 -07004374
Joe Perches189248d2014-01-23 15:54:47 -08004375# if statements using unnecessary parentheses - ie: if ((foo == bar))
4376 if ($^V && $^V ge 5.10.0 &&
4377 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4378 my $openparens = $1;
4379 my $count = $openparens =~ tr@\(@\(@;
4380 my $msg = "";
4381 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4382 my $comp = $4; #Not $1 because of $LvalOrFunc
4383 $msg = " - maybe == should be = ?" if ($comp eq "==");
4384 WARN("UNNECESSARY_PARENTHESES",
4385 "Unnecessary parentheses$msg\n" . $herecurr);
4386 }
4387 }
4388
Joe Perchesc5595fa2015-09-09 15:37:58 -07004389# comparisons with a constant or upper case identifier on the left
4390# avoid cases like "foo + BAR < baz"
4391# only fix matches surrounded by parentheses to avoid incorrect
4392# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4393 if ($^V && $^V ge 5.10.0 &&
4394 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4395 my $lead = $1;
4396 my $const = $2;
4397 my $comp = $3;
4398 my $to = $4;
4399 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004400 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004401 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4402 WARN("CONSTANT_COMPARISON",
4403 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4404 $fix) {
4405 if ($comp eq "<") {
4406 $newcomp = ">";
4407 } elsif ($comp eq "<=") {
4408 $newcomp = ">=";
4409 } elsif ($comp eq ">") {
4410 $newcomp = "<";
4411 } elsif ($comp eq ">=") {
4412 $newcomp = "<=";
4413 }
4414 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4415 }
4416 }
4417
Joe Perchesf34e4a42015-04-16 12:44:19 -07004418# Return of what appears to be an errno should normally be negative
4419 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004420 my $name = $1;
4421 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004422 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004423 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004424 }
4425 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004426
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004427# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004428 if ($line =~ /\b(if|while|for|switch)\(/) {
4429 if (ERROR("SPACING",
4430 "space required before the open parenthesis '('\n" . $herecurr) &&
4431 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004432 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004433 s/\b(if|while|for|switch)\(/$1 \(/;
4434 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004435 }
4436
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004437# Check for illegal assignment in if conditional -- and check for trailing
4438# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004439 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004440 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4441 ctx_statement_block($linenr, $realcnt, 0)
4442 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004443 my ($stat_next) = ctx_statement_block($line_nr_next,
4444 $remain_next, $off_next);
4445 $stat_next =~ s/\n./\n /g;
4446 ##print "stat<$stat> stat_next<$stat_next>\n";
4447
4448 if ($stat_next =~ /^\s*while\b/) {
4449 # If the statement carries leading newlines,
4450 # then count those as offsets.
4451 my ($whitespace) =
4452 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4453 my $offset =
4454 statement_rawlines($whitespace) - 1;
4455
4456 $suppress_whiletrailers{$line_nr_next +
4457 $offset} = 1;
4458 }
4459 }
4460 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004461 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004462 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004463 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004464
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004465 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004466 ERROR("ASSIGN_IN_IF",
4467 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004468 }
4469
4470 # Find out what is on the end of the line after the
4471 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004472 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004473 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004474 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004475 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4476 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004477 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004478 # Find out how long the conditional actually is.
4479 my @newlines = ($c =~ /\n/gs);
4480 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004481 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004482
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004483 $stat_real = raw_line($linenr, $cond_lines)
4484 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004485 if (defined($stat_real) && $cond_lines > 1) {
4486 $stat_real = "[...]\n$stat_real";
4487 }
4488
Joe Perches000d1cc12011-07-25 17:13:25 -07004489 ERROR("TRAILING_STATEMENTS",
4490 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004491 }
4492 }
4493
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004494# Check for bitwise tests written as boolean
4495 if ($line =~ /
4496 (?:
4497 (?:\[|\(|\&\&|\|\|)
4498 \s*0[xX][0-9]+\s*
4499 (?:\&\&|\|\|)
4500 |
4501 (?:\&\&|\|\|)
4502 \s*0[xX][0-9]+\s*
4503 (?:\&\&|\|\||\)|\])
4504 )/x)
4505 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004506 WARN("HEXADECIMAL_BOOLEAN_TEST",
4507 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004508 }
4509
Andy Whitcroft8905a672007-11-28 16:21:06 -08004510# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004511 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4512 my $s = $1;
4513 $s =~ s/$;//g; # Remove any comments
4514 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004515 ERROR("TRAILING_STATEMENTS",
4516 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004517 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004518 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004519# if should not continue a brace
4520 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004521 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004522 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004523 $herecurr);
4524 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004525# case and default should not have general statements after them
4526 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4527 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004528 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004529 \s*return\s+
4530 )/xg)
4531 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004532 ERROR("TRAILING_STATEMENTS",
4533 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004534 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004535
4536 # Check for }<nl>else {, these must be at the same
4537 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004538 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4539 $previndent == $indent) {
4540 if (ERROR("ELSE_AFTER_BRACE",
4541 "else should follow close brace '}'\n" . $hereprev) &&
4542 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4543 fix_delete_line($fixlinenr - 1, $prevrawline);
4544 fix_delete_line($fixlinenr, $rawline);
4545 my $fixedline = $prevrawline;
4546 $fixedline =~ s/}\s*$//;
4547 if ($fixedline !~ /^\+\s*$/) {
4548 fix_insert_line($fixlinenr, $fixedline);
4549 }
4550 $fixedline = $rawline;
4551 $fixedline =~ s/^(.\s*)else/$1} else/;
4552 fix_insert_line($fixlinenr, $fixedline);
4553 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004554 }
4555
Joe Perches8b8856f2014-08-06 16:11:14 -07004556 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4557 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004558 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4559
4560 # Find out what is on the end of the line after the
4561 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004562 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004563 $s =~ s/\n.*//g;
4564
4565 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004566 if (ERROR("WHILE_AFTER_BRACE",
4567 "while should follow close brace '}'\n" . $hereprev) &&
4568 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4569 fix_delete_line($fixlinenr - 1, $prevrawline);
4570 fix_delete_line($fixlinenr, $rawline);
4571 my $fixedline = $prevrawline;
4572 my $trailing = $rawline;
4573 $trailing =~ s/^\+//;
4574 $trailing = trim($trailing);
4575 $fixedline =~ s/}\s*$/} $trailing/;
4576 fix_insert_line($fixlinenr, $fixedline);
4577 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004578 }
4579 }
4580
Joe Perches95e2c602013-07-03 15:05:20 -07004581#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004582 while ($line =~ m{($Constant|$Lval)}g) {
4583 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004584
4585#gcc binary extension
4586 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004587 if (WARN("GCC_BINARY_CONSTANT",
4588 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4589 $fix) {
4590 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004591 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004592 s/\b$var\b/$hexval/;
4593 }
Joe Perches95e2c602013-07-03 15:05:20 -07004594 }
4595
4596#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004597 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004598 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004599#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004600 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004601#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004602 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4603#Ignore some three character SI units explicitly, like MiB and KHz
4604 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004605 while ($var =~ m{($Ident)}g) {
4606 my $word = $1;
4607 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004608 if ($check) {
4609 seed_camelcase_includes();
4610 if (!$file && !$camelcase_file_seeded) {
4611 seed_camelcase_file($realfile);
4612 $camelcase_file_seeded = 1;
4613 }
4614 }
Joe Perches7e781f62013-09-11 14:23:55 -07004615 if (!defined $camelcase{$word}) {
4616 $camelcase{$word} = 1;
4617 CHK("CAMELCASE",
4618 "Avoid CamelCase: <$word>\n" . $herecurr);
4619 }
Joe Perches34456862013-07-03 15:05:34 -07004620 }
Joe Perches323c1262012-12-17 16:02:07 -08004621 }
4622 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004623
4624#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004625 if ($line =~ /\#\s*define.*\\\s+$/) {
4626 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4627 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4628 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004629 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004630 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004631 }
4632
Fabian Frederick0e212e02015-04-16 12:44:25 -07004633# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4634# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004635 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004636 my $file = "$1.h";
4637 my $checkfile = "include/linux/$file";
4638 if (-f "$root/$checkfile" &&
4639 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004640 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004641 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004642 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4643 if ($asminclude > 0) {
4644 if ($realfile =~ m{^arch/}) {
4645 CHK("ARCH_INCLUDE_LINUX",
4646 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4647 } else {
4648 WARN("INCLUDE_LINUX",
4649 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4650 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004651 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004652 }
4653 }
4654
Andy Whitcroft653d4872007-06-23 17:16:34 -07004655# multi-statement macros should be enclosed in a do while loop, grab the
4656# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004657# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004658 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4659 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004660 my $ln = $linenr;
4661 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004662 my ($off, $dstat, $dcond, $rest);
4663 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004664 my $has_flow_statement = 0;
4665 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004666 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004667 ctx_statement_block($linenr, $realcnt, 0);
4668 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004669 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004670 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004671
Joe Perches08a28432014-10-13 15:51:55 -07004672 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004673 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004674
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004675 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004676 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004677 $dstat =~ s/\\\n.//g;
4678 $dstat =~ s/^\s*//s;
4679 $dstat =~ s/\s*$//s;
4680
4681 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004682 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4683 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004684 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004685 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004686 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004687
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004688 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004689 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4690 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004691 {
4692 }
4693
Joe Perches42e15292016-03-15 14:58:01 -07004694 # Make asm volatile uses seem like a generic function
4695 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4696
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004697 my $exceptions = qr{
4698 $Declare|
4699 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004700 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004701 DECLARE_PER_CPU|
4702 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004703 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004704 union|
4705 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004706 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004707 ^\"|\"$|
4708 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004709 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004710 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004711 if ($dstat ne '' &&
4712 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4713 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004714 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004715 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004716 $dstat !~ /$exceptions/ &&
4717 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004718 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004719 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004720 $dstat !~ /^for\s*$Constant$/ && # for (...)
4721 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4722 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004723 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004724 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004725 {
4726 $ctx =~ s/\n*$//;
4727 my $herectx = $here . "\n";
4728 my $cnt = statement_rawlines($ctx);
4729
4730 for (my $n = 0; $n < $cnt; $n++) {
4731 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004732 }
4733
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004734 if ($dstat =~ /;/) {
4735 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4736 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4737 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004738 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004739 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004740 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004741 }
Joe Perches5023d342012-12-17 16:01:47 -08004742
Joe Perches08a28432014-10-13 15:51:55 -07004743# check for macros with flow control, but without ## concatenation
4744# ## concatenation is commonly a macro that defines a function so ignore those
4745 if ($has_flow_statement && !$has_arg_concat) {
4746 my $herectx = $here . "\n";
4747 my $cnt = statement_rawlines($ctx);
4748
4749 for (my $n = 0; $n < $cnt; $n++) {
4750 $herectx .= raw_line($linenr, $n) . "\n";
4751 }
4752 WARN("MACRO_WITH_FLOW_CONTROL",
4753 "Macros with flow control statements should be avoided\n" . "$herectx");
4754 }
4755
Joe Perches481eb482012-12-17 16:01:56 -08004756# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004757
4758 } else {
4759 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004760 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4761 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004762 $line =~ /^\+.*\\$/) {
4763 WARN("LINE_CONTINUATIONS",
4764 "Avoid unnecessary line continuations\n" . $herecurr);
4765 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004766 }
4767
Joe Perchesb13edf72012-07-30 14:41:24 -07004768# do {} while (0) macro tests:
4769# single-statement macros do not need to be enclosed in do while (0) loop,
4770# macro should not end with a semicolon
4771 if ($^V && $^V ge 5.10.0 &&
4772 $realfile !~ m@/vmlinux.lds.h$@ &&
4773 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4774 my $ln = $linenr;
4775 my $cnt = $realcnt;
4776 my ($off, $dstat, $dcond, $rest);
4777 my $ctx = '';
4778 ($dstat, $dcond, $ln, $cnt, $off) =
4779 ctx_statement_block($linenr, $realcnt, 0);
4780 $ctx = $dstat;
4781
4782 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004783 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004784
4785 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4786 my $stmts = $2;
4787 my $semis = $3;
4788
4789 $ctx =~ s/\n*$//;
4790 my $cnt = statement_rawlines($ctx);
4791 my $herectx = $here . "\n";
4792
4793 for (my $n = 0; $n < $cnt; $n++) {
4794 $herectx .= raw_line($linenr, $n) . "\n";
4795 }
4796
Joe Perchesac8e97f2012-08-21 16:15:53 -07004797 if (($stmts =~ tr/;/;/) == 1 &&
4798 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004799 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4800 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4801 }
4802 if (defined $semis && $semis ne "") {
4803 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4804 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4805 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004806 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4807 $ctx =~ s/\n*$//;
4808 my $cnt = statement_rawlines($ctx);
4809 my $herectx = $here . "\n";
4810
4811 for (my $n = 0; $n < $cnt; $n++) {
4812 $herectx .= raw_line($linenr, $n) . "\n";
4813 }
4814
4815 WARN("TRAILING_SEMICOLON",
4816 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004817 }
4818 }
4819
Mike Frysinger080ba922009-01-06 14:41:25 -08004820# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4821# all assignments may have only one of the following with an assignment:
4822# .
4823# ALIGN(...)
4824# VMLINUX_SYMBOL(...)
4825 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004826 WARN("MISSING_VMLINUX_SYMBOL",
4827 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004828 }
4829
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004830# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004831 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4832 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004833 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004834 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004835 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4836 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004837 my @allowed = ();
4838 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004839 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004840 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004841 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004842 for my $chunk (@chunks) {
4843 my ($cond, $block) = @{$chunk};
4844
Andy Whitcroft773647a2008-03-28 14:15:58 -07004845 # If the condition carries leading newlines, then count those as offsets.
4846 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4847 my $offset = statement_rawlines($whitespace) - 1;
4848
Joe Perchesaad4f612012-03-23 15:02:19 -07004849 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004850 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4851
4852 # We have looked at and allowed this specific line.
4853 $suppress_ifbraces{$ln + $offset} = 1;
4854
4855 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004856 $ln += statement_rawlines($block) - 1;
4857
Andy Whitcroft773647a2008-03-28 14:15:58 -07004858 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004859
4860 $seen++ if ($block =~ /^\s*{/);
4861
Joe Perchesaad4f612012-03-23 15:02:19 -07004862 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004863 if (statement_lines($cond) > 1) {
4864 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004865 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004866 }
4867 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004868 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004869 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004870 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004871 if (statement_block_size($block) > 1) {
4872 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004873 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004874 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004875 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004876 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004877 if ($seen) {
4878 my $sum_allowed = 0;
4879 foreach (@allowed) {
4880 $sum_allowed += $_;
4881 }
4882 if ($sum_allowed == 0) {
4883 WARN("BRACES",
4884 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4885 } elsif ($sum_allowed != $allow &&
4886 $seen != $allow) {
4887 CHK("BRACES",
4888 "braces {} should be used on all arms of this statement\n" . $herectx);
4889 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004890 }
4891 }
4892 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004893 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004894 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004895 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004896
Andy Whitcroftcf655042008-03-04 14:28:20 -08004897 # Check the pre-context.
4898 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4899 #print "APW: ALLOWED: pre<$1>\n";
4900 $allowed = 1;
4901 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004902
4903 my ($level, $endln, @chunks) =
4904 ctx_statement_full($linenr, $realcnt, $-[0]);
4905
Andy Whitcroftcf655042008-03-04 14:28:20 -08004906 # Check the condition.
4907 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004908 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004909 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004910 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004911 }
4912 if (statement_lines($cond) > 1) {
4913 #print "APW: ALLOWED: cond<$cond>\n";
4914 $allowed = 1;
4915 }
4916 if ($block =~/\b(?:if|for|while)\b/) {
4917 #print "APW: ALLOWED: block<$block>\n";
4918 $allowed = 1;
4919 }
4920 if (statement_block_size($block) > 1) {
4921 #print "APW: ALLOWED: lines block<$block>\n";
4922 $allowed = 1;
4923 }
4924 # Check the post-context.
4925 if (defined $chunks[1]) {
4926 my ($cond, $block) = @{$chunks[1]};
4927 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004928 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004929 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004930 if ($block =~ /^\s*\{/) {
4931 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4932 $allowed = 1;
4933 }
4934 }
4935 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004936 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004937 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004938
Andy Whitcroftf0556632008-10-15 22:02:23 -07004939 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004940 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004941 }
4942
Joe Perches000d1cc12011-07-25 17:13:25 -07004943 WARN("BRACES",
4944 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004945 }
4946 }
4947
Joe Perches0979ae62012-12-17 16:01:59 -08004948# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004949 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004950 if (CHK("BRACES",
4951 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4952 $fix && $prevrawline =~ /^\+/) {
4953 fix_delete_line($fixlinenr - 1, $prevrawline);
4954 }
Joe Perches0979ae62012-12-17 16:01:59 -08004955 }
Joe Perches77b9a532013-07-03 15:05:29 -07004956 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004957 if (CHK("BRACES",
4958 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4959 $fix) {
4960 fix_delete_line($fixlinenr, $rawline);
4961 }
Joe Perches0979ae62012-12-17 16:01:59 -08004962 }
4963
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004964# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004965 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4966 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004967 WARN("VOLATILE",
4968 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004969 }
4970
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004971# Check for user-visible strings broken across lines, which breaks the ability
4972# to grep for the string. Make exceptions when the previous string ends in a
4973# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4974# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004975 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004976 $prevline =~ /"\s*$/ &&
4977 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4978 if (WARN("SPLIT_STRING",
4979 "quoted string split across lines\n" . $hereprev) &&
4980 $fix &&
4981 $prevrawline =~ /^\+.*"\s*$/ &&
4982 $last_coalesced_string_linenr != $linenr - 1) {
4983 my $extracted_string = get_quoted_string($line, $rawline);
4984 my $comma_close = "";
4985 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4986 $comma_close = $1;
4987 }
4988
4989 fix_delete_line($fixlinenr - 1, $prevrawline);
4990 fix_delete_line($fixlinenr, $rawline);
4991 my $fixedline = $prevrawline;
4992 $fixedline =~ s/"\s*$//;
4993 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4994 fix_insert_line($fixlinenr - 1, $fixedline);
4995 $fixedline = $rawline;
4996 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4997 if ($fixedline !~ /\+\s*$/) {
4998 fix_insert_line($fixlinenr, $fixedline);
4999 }
5000 $last_coalesced_string_linenr = $linenr;
5001 }
5002 }
5003
5004# check for missing a space in a string concatenation
5005 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5006 WARN('MISSING_SPACE',
5007 "break quoted strings at a space character\n" . $hereprev);
5008 }
5009
5010# check for spaces before a quoted newline
5011 if ($rawline =~ /^.*\".*\s\\n/) {
5012 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5013 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5014 $fix) {
5015 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5016 }
5017
5018 }
5019
Joe Perchesf17dba42014-10-13 15:51:51 -07005020# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005021 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005022 CHK("CONCATENATED_STRING",
5023 "Concatenated strings should use spaces between elements\n" . $herecurr);
5024 }
5025
Joe Perches90ad30e2014-12-10 15:51:59 -08005026# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005027 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005028 WARN("STRING_FRAGMENTS",
5029 "Consecutive strings are generally better as a single string\n" . $herecurr);
5030 }
5031
Joe Perches6e300752015-09-09 15:37:47 -07005032# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005033 my $string;
5034 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5035 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5036 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005037 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005038 WARN("PRINTF_L",
5039 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5040 last;
5041 }
Joe Perches6e300752015-09-09 15:37:47 -07005042 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5043 ERROR("PRINTF_0xDECIMAL",
5044 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5045 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005046 }
5047
5048# check for line continuations in quoted strings with odd counts of "
5049 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5050 WARN("LINE_CONTINUATIONS",
5051 "Avoid line continuations in quoted strings\n" . $herecurr);
5052 }
5053
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005054# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005055 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005056 CHK("REDUNDANT_CODE",
5057 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005058 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005059 }
5060
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005061# check for needless "if (<foo>) fn(<foo>)" uses
5062 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005063 my $tested = quotemeta($1);
5064 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5065 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5066 my $func = $1;
5067 if (WARN('NEEDLESS_IF',
5068 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5069 $fix) {
5070 my $do_fix = 1;
5071 my $leading_tabs = "";
5072 my $new_leading_tabs = "";
5073 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5074 $leading_tabs = $1;
5075 } else {
5076 $do_fix = 0;
5077 }
5078 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5079 $new_leading_tabs = $1;
5080 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5081 $do_fix = 0;
5082 }
5083 } else {
5084 $do_fix = 0;
5085 }
5086 if ($do_fix) {
5087 fix_delete_line($fixlinenr - 1, $prevrawline);
5088 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5089 }
5090 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005091 }
5092 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005093
Joe Perchesebfdc402014-08-06 16:10:27 -07005094# check for unnecessary "Out of Memory" messages
5095 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5096 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5097 (defined $1 || defined $3) &&
5098 $linenr > 3) {
5099 my $testval = $2;
5100 my $testline = $lines[$linenr - 3];
5101
5102 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5103# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5104
5105 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5106 WARN("OOM_MESSAGE",
5107 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5108 }
5109 }
5110
Joe Perchesf78d98f2014-10-13 15:52:01 -07005111# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005112 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005113 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5114 my $level = $1;
5115 if (WARN("UNNECESSARY_KERN_LEVEL",
5116 "Possible unnecessary $level\n" . $herecurr) &&
5117 $fix) {
5118 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5119 }
5120 }
5121
Joe Perchesabb08a52014-12-10 15:51:46 -08005122# check for mask then right shift without a parentheses
5123 if ($^V && $^V ge 5.10.0 &&
5124 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5125 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5126 WARN("MASK_THEN_SHIFT",
5127 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5128 }
5129
Joe Perchesb75ac612014-12-10 15:52:02 -08005130# check for pointer comparisons to NULL
5131 if ($^V && $^V ge 5.10.0) {
5132 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5133 my $val = $1;
5134 my $equal = "!";
5135 $equal = "" if ($4 eq "!=");
5136 if (CHK("COMPARISON_TO_NULL",
5137 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5138 $fix) {
5139 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5140 }
5141 }
5142 }
5143
Joe Perches8716de32013-09-11 14:24:05 -07005144# check for bad placement of section $InitAttribute (e.g.: __initdata)
5145 if ($line =~ /(\b$InitAttribute\b)/) {
5146 my $attr = $1;
5147 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5148 my $ptr = $1;
5149 my $var = $2;
5150 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5151 ERROR("MISPLACED_INIT",
5152 "$attr should be placed after $var\n" . $herecurr)) ||
5153 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5154 WARN("MISPLACED_INIT",
5155 "$attr should be placed after $var\n" . $herecurr))) &&
5156 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005157 $fixed[$fixlinenr] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
Joe Perches8716de32013-09-11 14:24:05 -07005158 }
5159 }
5160 }
5161
Joe Perchese970b8842013-11-12 15:10:10 -08005162# check for $InitAttributeData (ie: __initdata) with const
5163 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5164 my $attr = $1;
5165 $attr =~ /($InitAttributePrefix)(.*)/;
5166 my $attr_prefix = $1;
5167 my $attr_type = $2;
5168 if (ERROR("INIT_ATTRIBUTE",
5169 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5170 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005171 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005172 s/$InitAttributeData/${attr_prefix}initconst/;
5173 }
5174 }
5175
5176# check for $InitAttributeConst (ie: __initconst) without const
5177 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5178 my $attr = $1;
5179 if (ERROR("INIT_ATTRIBUTE",
5180 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5181 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005182 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005183 /(^\+\s*(?:static\s+))/;
5184 $lead = rtrim($1);
5185 $lead = "$lead " if ($lead !~ /^\+$/);
5186 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005187 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005188 }
5189 }
5190
Joe Perchesc17893c2015-04-16 12:44:42 -07005191# check for __read_mostly with const non-pointer (should just be const)
5192 if ($line =~ /\b__read_mostly\b/ &&
5193 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5194 if (ERROR("CONST_READ_MOSTLY",
5195 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5196 $fix) {
5197 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5198 }
5199 }
5200
Joe Perchesfbdb8132014-04-03 14:49:14 -07005201# don't use __constant_<foo> functions outside of include/uapi/
5202 if ($realfile !~ m@^include/uapi/@ &&
5203 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5204 my $constant_func = $1;
5205 my $func = $constant_func;
5206 $func =~ s/^__constant_//;
5207 if (WARN("CONSTANT_CONVERSION",
5208 "$constant_func should be $func\n" . $herecurr) &&
5209 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005210 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005211 }
5212 }
5213
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005214# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005215 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005216 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005217 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005218 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005219 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005220 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5221 }
5222 if ($delay > 2000) {
5223 WARN("LONG_UDELAY",
5224 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005225 }
5226 }
5227
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005228# warn about unexpectedly long msleep's
5229 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5230 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005231 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005232 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005233 }
5234 }
5235
Joe Perches36ec1932013-07-03 15:05:25 -07005236# check for comparisons of jiffies
5237 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5238 WARN("JIFFIES_COMPARISON",
5239 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5240 }
5241
Joe Perches9d7a34a2013-07-03 15:05:26 -07005242# check for comparisons of get_jiffies_64()
5243 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5244 WARN("JIFFIES_COMPARISON",
5245 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5246 }
5247
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005248# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005249# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005250# print "#ifdef in C files should be avoided\n";
5251# print "$herecurr";
5252# $clean = 0;
5253# }
5254
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005255# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005256 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005257 if (ERROR("SPACING",
5258 "exactly one space required after that #$1\n" . $herecurr) &&
5259 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005260 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005261 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5262 }
5263
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005264 }
5265
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005266# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005267 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5268 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005269 my $which = $1;
5270 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005271 CHK("UNCOMMENTED_DEFINITION",
5272 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005273 }
5274 }
5275# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005276
5277 my $barriers = qr{
5278 mb|
5279 rmb|
5280 wmb|
5281 read_barrier_depends
5282 }x;
5283 my $barrier_stems = qr{
5284 mb__before_atomic|
5285 mb__after_atomic|
5286 store_release|
5287 load_acquire|
5288 store_mb|
5289 (?:$barriers)
5290 }x;
5291 my $all_barriers = qr{
5292 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005293 smp_(?:$barrier_stems)|
5294 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005295 }x;
5296
5297 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005298 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005299 WARN("MEMORY_BARRIER",
5300 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005301 }
5302 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005303
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005304 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5305
5306 if ($realfile !~ m@^include/asm-generic/@ &&
5307 $realfile !~ m@/barrier\.h$@ &&
5308 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5309 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5310 WARN("MEMORY_BARRIER",
5311 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5312 }
5313
Joe Perchescb426e92015-06-25 15:02:46 -07005314# check for waitqueue_active without a comment.
5315 if ($line =~ /\bwaitqueue_active\s*\(/) {
5316 if (!ctx_has_comment($first_line, $linenr)) {
5317 WARN("WAITQUEUE_ACTIVE",
5318 "waitqueue_active without comment\n" . $herecurr);
5319 }
5320 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005321
5322# Check for expedited grace periods that interrupt non-idle non-nohz
5323# online CPUs. These expedited can therefore degrade real-time response
5324# if used carelessly, and should be avoided where not absolutely
5325# needed. It is always OK to use synchronize_rcu_expedited() and
5326# synchronize_sched_expedited() at boot time (before real-time applications
5327# start) and in error situations where real-time response is compromised in
5328# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5329# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5330# Of course, nothing comes for free, and srcu_read_lock() and
5331# srcu_read_unlock() do contain full memory barriers in payment for
5332# synchronize_srcu_expedited() non-interruption properties.
5333 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5334 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5335 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5336
5337 }
5338
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005339# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005340 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005341 CHK("ARCH_DEFINES",
5342 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005343 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005344
Tobias Klauserd4977c72010-05-24 14:33:30 -07005345# Check that the storage class is at the beginning of a declaration
5346 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005347 WARN("STORAGE_CLASS",
5348 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005349 }
5350
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005351# check the location of the inline attribute, that it is between
5352# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005353 if ($line =~ /\b$Type\s+$Inline\b/ ||
5354 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005355 ERROR("INLINE_LOCATION",
5356 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005357 }
5358
Andy Whitcroft8905a672007-11-28 16:21:06 -08005359# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005360 if ($realfile !~ m@\binclude/uapi/@ &&
5361 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005362 if (WARN("INLINE",
5363 "plain inline is preferred over $1\n" . $herecurr) &&
5364 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005365 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005366
5367 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005368 }
5369
Joe Perches3d130fd2011-01-12 17:00:00 -08005370# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005371 if ($realfile !~ m@\binclude/uapi/@ &&
5372 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005373 WARN("PREFER_PACKED",
5374 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005375 }
5376
Joe Perches39b7e282011-07-25 17:13:24 -07005377# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005378 if ($realfile !~ m@\binclude/uapi/@ &&
5379 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005380 WARN("PREFER_ALIGNED",
5381 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005382 }
5383
Joe Perches5f14d3b2012-01-10 15:09:52 -08005384# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005385 if ($realfile !~ m@\binclude/uapi/@ &&
5386 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005387 if (WARN("PREFER_PRINTF",
5388 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5389 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005390 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005391
5392 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005393 }
5394
Joe Perches6061d942012-03-23 15:02:16 -07005395# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005396 if ($realfile !~ m@\binclude/uapi/@ &&
5397 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005398 if (WARN("PREFER_SCANF",
5399 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5400 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005401 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005402 }
Joe Perches6061d942012-03-23 15:02:16 -07005403 }
5404
Joe Perches619a9082014-12-10 15:51:35 -08005405# Check for __attribute__ weak, or __weak declarations (may have link issues)
5406 if ($^V && $^V ge 5.10.0 &&
5407 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5408 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5409 $line =~ /\b__weak\b/)) {
5410 ERROR("WEAK_DECLARATION",
5411 "Using weak declarations can have unintended link defects\n" . $herecurr);
5412 }
5413
Joe Perchese6176fa2015-06-25 15:02:49 -07005414# check for c99 types like uint8_t used outside of uapi/
5415 if ($realfile !~ m@\binclude/uapi/@ &&
5416 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5417 my $type = $1;
5418 if ($type =~ /\b($typeC99Typedefs)\b/) {
5419 $type = $1;
5420 my $kernel_type = 'u';
5421 $kernel_type = 's' if ($type =~ /^_*[si]/);
5422 $type =~ /(\d+)/;
5423 $kernel_type .= $1;
5424 if (CHK("PREFER_KERNEL_TYPES",
5425 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5426 $fix) {
5427 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5428 }
5429 }
5430 }
5431
Joe Perches938224b2016-01-20 14:59:15 -08005432# check for cast of C90 native int or longer types constants
5433 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5434 my $cast = $1;
5435 my $const = $2;
5436 if (WARN("TYPECAST_INT_CONSTANT",
5437 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5438 $fix) {
5439 my $suffix = "";
5440 my $newconst = $const;
5441 $newconst =~ s/${Int_type}$//;
5442 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5443 if ($cast =~ /\blong\s+long\b/) {
5444 $suffix .= 'LL';
5445 } elsif ($cast =~ /\blong\b/) {
5446 $suffix .= 'L';
5447 }
5448 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5449 }
5450 }
5451
Joe Perches8f53a9b2010-03-05 13:43:48 -08005452# check for sizeof(&)
5453 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005454 WARN("SIZEOF_ADDRESS",
5455 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005456 }
5457
Joe Perches66c80b62012-07-30 14:41:22 -07005458# check for sizeof without parenthesis
5459 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005460 if (WARN("SIZEOF_PARENTHESIS",
5461 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5462 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005463 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005464 }
Joe Perches66c80b62012-07-30 14:41:22 -07005465 }
5466
Joe Perches88982fe2012-12-17 16:02:00 -08005467# check for struct spinlock declarations
5468 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5469 WARN("USE_SPINLOCK_T",
5470 "struct spinlock should be spinlock_t\n" . $herecurr);
5471 }
5472
Joe Perchesa6962d72013-04-29 16:18:13 -07005473# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005474 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005475 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005476 $fmt =~ s/%%//g;
5477 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005478 if (WARN("PREFER_SEQ_PUTS",
5479 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5480 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005481 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005482 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005483 }
5484 }
5485
Andy Whitcroft554e1652012-01-10 15:09:57 -08005486# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005487 if ($^V && $^V ge 5.10.0 &&
5488 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005489 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005490
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005491 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005492 my $ms_val = $7;
5493 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005494
Andy Whitcroft554e1652012-01-10 15:09:57 -08005495 if ($ms_size =~ /^(0x|)0$/i) {
5496 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005497 "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 -08005498 } elsif ($ms_size =~ /^(0x|)1$/i) {
5499 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005500 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5501 }
5502 }
5503
Joe Perches98a9bba2014-01-23 15:54:52 -08005504# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5505 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005506 defined $stat &&
5507 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005508 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005509 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
Joe Perches98a9bba2014-01-23 15:54:52 -08005510 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005511 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
Joe Perches98a9bba2014-01-23 15:54:52 -08005512 }
5513 }
5514
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005515# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5516 if ($^V && $^V ge 5.10.0 &&
5517 defined $stat &&
5518 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5519 WARN("PREFER_ETHER_ADDR_EQUAL",
5520 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5521 }
5522
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005523# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5524# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5525 if ($^V && $^V ge 5.10.0 &&
5526 defined $stat &&
5527 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5528
5529 my $ms_val = $7;
5530
5531 if ($ms_val =~ /^(?:0x|)0+$/i) {
5532 if (WARN("PREFER_ETH_ZERO_ADDR",
5533 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5534 $fix) {
5535 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5536 }
5537 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5538 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5539 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5540 $fix) {
5541 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5542 }
5543 }
5544 }
5545
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005546# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005547 if ($^V && $^V ge 5.10.0 &&
5548 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005549 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005550 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005551 my $call = $1;
5552 my $cast1 = deparenthesize($2);
5553 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005554 my $cast2 = deparenthesize($7);
5555 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005556 my $cast;
5557
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005558 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005559 $cast = "$cast1 or $cast2";
5560 } elsif ($cast1 ne "") {
5561 $cast = $cast1;
5562 } else {
5563 $cast = $cast2;
5564 }
5565 WARN("MINMAX",
5566 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005567 }
5568 }
5569
Joe Perches4a273192012-07-30 14:41:20 -07005570# check usleep_range arguments
5571 if ($^V && $^V ge 5.10.0 &&
5572 defined $stat &&
5573 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5574 my $min = $1;
5575 my $max = $7;
5576 if ($min eq $max) {
5577 WARN("USLEEP_RANGE",
5578 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5579 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5580 $min > $max) {
5581 WARN("USLEEP_RANGE",
5582 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5583 }
5584 }
5585
Joe Perches823b7942013-11-12 15:10:15 -08005586# check for naked sscanf
5587 if ($^V && $^V ge 5.10.0 &&
5588 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005589 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005590 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5591 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5592 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5593 my $lc = $stat =~ tr@\n@@;
5594 $lc = $lc + $linenr;
5595 my $stat_real = raw_line($linenr, 0);
5596 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5597 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5598 }
5599 WARN("NAKED_SSCANF",
5600 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5601 }
5602
Joe Perchesafc819a2014-06-04 16:12:08 -07005603# check for simple sscanf that should be kstrto<foo>
5604 if ($^V && $^V ge 5.10.0 &&
5605 defined $stat &&
5606 $line =~ /\bsscanf\b/) {
5607 my $lc = $stat =~ tr@\n@@;
5608 $lc = $lc + $linenr;
5609 my $stat_real = raw_line($linenr, 0);
5610 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5611 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5612 }
5613 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5614 my $format = $6;
5615 my $count = $format =~ tr@%@%@;
5616 if ($count == 1 &&
5617 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5618 WARN("SSCANF_TO_KSTRTO",
5619 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5620 }
5621 }
5622 }
5623
Joe Perches70dc8a42013-09-11 14:23:58 -07005624# check for new externs in .h files.
5625 if ($realfile =~ /\.h$/ &&
5626 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005627 if (CHK("AVOID_EXTERNS",
5628 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005629 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005630 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005631 }
5632 }
5633
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005634# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005635 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005636 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005637 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005638 my $function_name = $1;
5639 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005640
5641 my $s = $stat;
5642 if (defined $cond) {
5643 substr($s, 0, length($cond), '');
5644 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005645 if ($s =~ /^\s*;/ &&
5646 $function_name ne 'uninitialized_var')
5647 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005648 WARN("AVOID_EXTERNS",
5649 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005650 }
5651
5652 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005653 WARN("FUNCTION_ARGUMENTS",
5654 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005655 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005656
5657 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5658 $stat =~ /^.\s*extern\s+/)
5659 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005660 WARN("AVOID_EXTERNS",
5661 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005662 }
5663
5664# checks for new __setup's
5665 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5666 my $name = $1;
5667
5668 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005669 CHK("UNDOCUMENTED_SETUP",
5670 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005671 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005672 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005673
5674# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005675 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005676 WARN("UNNECESSARY_CASTS",
5677 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005678 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005679
Joe Perchesa640d252013-07-03 15:05:21 -07005680# alloc style
5681# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5682 if ($^V && $^V ge 5.10.0 &&
5683 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5684 CHK("ALLOC_SIZEOF_STRUCT",
5685 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5686 }
5687
Joe Perches60a55362014-06-04 16:12:07 -07005688# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5689 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005690 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07005691 my $oldfunc = $3;
5692 my $a1 = $4;
5693 my $a2 = $10;
5694 my $newfunc = "kmalloc_array";
5695 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005696 my $r1 = $a1;
5697 my $r2 = $a2;
5698 if ($a1 =~ /^sizeof\s*\S/) {
5699 $r1 = $a2;
5700 $r2 = $a1;
5701 }
5702 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5703 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005704 if (WARN("ALLOC_WITH_MULTIPLY",
5705 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5706 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005707 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
Joe Perches60a55362014-06-04 16:12:07 -07005708
5709 }
5710 }
5711 }
5712
Joe Perches972fdea2013-04-29 16:18:12 -07005713# check for krealloc arg reuse
5714 if ($^V && $^V ge 5.10.0 &&
5715 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5716 WARN("KREALLOC_ARG_REUSE",
5717 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5718 }
5719
Joe Perches5ce59ae2013-02-21 16:44:18 -08005720# check for alloc argument mismatch
5721 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5722 WARN("ALLOC_ARRAY_ARGS",
5723 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5724 }
5725
Joe Perchescaf2a542011-01-12 16:59:56 -08005726# check for multiple semicolons
5727 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005728 if (WARN("ONE_SEMICOLON",
5729 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5730 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005731 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005732 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005733 }
5734
Joe Perches0ab90192014-12-10 15:51:57 -08005735# check for #defines like: 1 << <digit> that could be BIT(digit)
5736 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5737 my $ull = "";
5738 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5739 if (CHK("BIT_MACRO",
5740 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5741 $fix) {
5742 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5743 }
5744 }
5745
Joe Perches2d632742016-05-20 17:04:00 -07005746# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5747 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5748 my $config = $1;
5749 if (WARN("PREFER_IS_ENABLED",
5750 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5751 $fix) {
5752 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5753 }
5754 }
5755
Joe Perchese81f2392014-08-06 16:11:25 -07005756# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005757 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5758 my $has_break = 0;
5759 my $has_statement = 0;
5760 my $count = 0;
5761 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005762 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005763 $prevline--;
5764 my $rline = $rawlines[$prevline - 1];
5765 my $fline = $lines[$prevline - 1];
5766 last if ($fline =~ /^\@\@/);
5767 next if ($fline =~ /^\-/);
5768 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5769 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5770 next if ($fline =~ /^.[\s$;]*$/);
5771 $has_statement = 1;
5772 $count++;
5773 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5774 }
5775 if (!$has_break && $has_statement) {
5776 WARN("MISSING_BREAK",
5777 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5778 }
5779 }
5780
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005781# check for switch/default statements without a break;
5782 if ($^V && $^V ge 5.10.0 &&
5783 defined $stat &&
5784 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5785 my $ctx = '';
5786 my $herectx = $here . "\n";
5787 my $cnt = statement_rawlines($stat);
5788 for (my $n = 0; $n < $cnt; $n++) {
5789 $herectx .= raw_line($linenr, $n) . "\n";
5790 }
5791 WARN("DEFAULT_NO_BREAK",
5792 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005793 }
5794
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005795# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005796 if ($line =~ /\b__FUNCTION__\b/) {
5797 if (WARN("USE_FUNC",
5798 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5799 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005800 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005801 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005802 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005803
Joe Perches62ec8182015-02-13 14:38:18 -08005804# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5805 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5806 ERROR("DATE_TIME",
5807 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5808 }
5809
Joe Perches2c924882012-03-23 15:02:20 -07005810# check for use of yield()
5811 if ($line =~ /\byield\s*\(\s*\)/) {
5812 WARN("YIELD",
5813 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5814 }
5815
Joe Perches179f8f42013-07-03 15:05:30 -07005816# check for comparisons against true and false
5817 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5818 my $lead = $1;
5819 my $arg = $2;
5820 my $test = $3;
5821 my $otype = $4;
5822 my $trail = $5;
5823 my $op = "!";
5824
5825 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5826
5827 my $type = lc($otype);
5828 if ($type =~ /^(?:true|false)$/) {
5829 if (("$test" eq "==" && "$type" eq "true") ||
5830 ("$test" eq "!=" && "$type" eq "false")) {
5831 $op = "";
5832 }
5833
5834 CHK("BOOL_COMPARISON",
5835 "Using comparison to $otype is error prone\n" . $herecurr);
5836
5837## maybe suggesting a correct construct would better
5838## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5839
5840 }
5841 }
5842
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005843# check for semaphores initialized locked
5844 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005845 WARN("CONSIDER_COMPLETION",
5846 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005847 }
Joe Perches6712d852012-03-23 15:02:20 -07005848
Joe Perches67d0a072011-10-31 17:13:10 -07005849# recommend kstrto* over simple_strto* and strict_strto*
5850 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005851 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005852 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005853 }
Joe Perches6712d852012-03-23 15:02:20 -07005854
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005855# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005856 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005857 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005858 "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 -07005859 }
Joe Perches6712d852012-03-23 15:02:20 -07005860
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005861# check for various structs that are normally const (ops, kgdb, device_tree)
5862 my $const_structs = qr{
5863 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005864 address_space_operations|
5865 backlight_ops|
5866 block_device_operations|
5867 dentry_operations|
5868 dev_pm_ops|
5869 dma_map_ops|
5870 extent_io_ops|
5871 file_lock_operations|
5872 file_operations|
5873 hv_ops|
5874 ide_dma_ops|
5875 intel_dvo_dev_ops|
5876 item_operations|
5877 iwl_ops|
5878 kgdb_arch|
5879 kgdb_io|
5880 kset_uevent_ops|
5881 lock_manager_operations|
5882 microcode_ops|
5883 mtrr_ops|
5884 neigh_ops|
5885 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005886 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005887 pci_raw_ops|
5888 pipe_buf_operations|
5889 platform_hibernation_ops|
5890 platform_suspend_ops|
5891 proto_ops|
5892 rpc_pipe_ops|
5893 seq_operations|
5894 snd_ac97_build_ops|
5895 soc_pcmcia_socket_ops|
5896 stacktrace_ops|
5897 sysfs_ops|
5898 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005899 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005900 usb_mon_operations|
5901 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005902 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005903 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005904 WARN("CONST_STRUCT",
5905 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005906 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005907 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005908
5909# use of NR_CPUS is usually wrong
5910# ignore definitions of NR_CPUS and usage to define arrays as likely right
5911 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005912 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5913 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005914 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5915 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5916 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005917 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005918 WARN("NR_CPUS",
5919 "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 -07005920 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005921
Joe Perches52ea8502013-11-12 15:10:09 -08005922# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5923 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5924 ERROR("DEFINE_ARCH_HAS",
5925 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5926 }
5927
Joe Perchesacd93622015-02-13 14:38:38 -08005928# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5929 if ($^V && $^V ge 5.10.0 &&
5930 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5931 WARN("LIKELY_MISUSE",
5932 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5933 }
5934
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005935# whine mightly about in_atomic
5936 if ($line =~ /\bin_atomic\s*\(/) {
5937 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005938 ERROR("IN_ATOMIC",
5939 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005940 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005941 WARN("IN_ATOMIC",
5942 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005943 }
5944 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005945
Joe Perches481aea52016-05-20 17:04:08 -07005946# whine about ACCESS_ONCE
5947 if ($^V && $^V ge 5.10.0 &&
5948 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5949 my $par = $1;
5950 my $eq = $2;
5951 my $fun = $3;
5952 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5953 if (defined($eq)) {
5954 if (WARN("PREFER_WRITE_ONCE",
5955 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5956 $fix) {
5957 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5958 }
5959 } else {
5960 if (WARN("PREFER_READ_ONCE",
5961 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5962 $fix) {
5963 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5964 }
5965 }
5966 }
5967
Peter Zijlstra1704f472010-03-19 01:37:42 +01005968# check for lockdep_set_novalidate_class
5969 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5970 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5971 if ($realfile !~ m@^kernel/lockdep@ &&
5972 $realfile !~ m@^include/linux/lockdep@ &&
5973 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005974 ERROR("LOCKDEP",
5975 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005976 }
5977 }
Dave Jones88f88312011-01-12 16:59:59 -08005978
Joe Perchesb392c642015-04-16 12:44:16 -07005979 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5980 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005981 WARN("EXPORTED_WORLD_WRITABLE",
5982 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005983 }
Joe Perches24358802014-04-03 14:49:13 -07005984
Joe Perches515a2352014-04-03 14:49:24 -07005985# Mode permission misuses where it seems decimal should be octal
5986# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5987 if ($^V && $^V ge 5.10.0 &&
5988 $line =~ /$mode_perms_search/) {
5989 foreach my $entry (@mode_permission_funcs) {
5990 my $func = $entry->[0];
5991 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005992
Joe Perches515a2352014-04-03 14:49:24 -07005993 my $skip_args = "";
5994 if ($arg_pos > 1) {
5995 $arg_pos--;
5996 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5997 }
5998 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5999 if ($line =~ /$test/) {
6000 my $val = $1;
6001 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07006002
Joe Perches515a2352014-04-03 14:49:24 -07006003 if ($val !~ /^0$/ &&
6004 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6005 length($val) ne 4)) {
6006 ERROR("NON_OCTAL_PERMISSIONS",
6007 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08006008 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6009 ERROR("EXPORTED_WORLD_WRITABLE",
6010 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006011 }
Joe Perches24358802014-04-03 14:49:13 -07006012 }
6013 }
6014 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006015
6016# validate content of MODULE_LICENSE against list from include/linux/module.h
6017 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6018 my $extracted_string = get_quoted_string($line, $rawline);
6019 my $valid_licenses = qr{
6020 GPL|
6021 GPL\ v2|
6022 GPL\ and\ additional\ rights|
6023 Dual\ BSD/GPL|
6024 Dual\ MIT/GPL|
6025 Dual\ MPL/GPL|
6026 Proprietary
6027 }x;
6028 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6029 WARN("MODULE_LICENSE",
6030 "unknown module license " . $extracted_string . "\n" . $herecurr);
6031 }
6032 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006033 }
6034
6035 # If we have no input at all, then there is nothing to report on
6036 # so just keep quiet.
6037 if ($#rawlines == -1) {
6038 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006039 }
6040
Andy Whitcroft8905a672007-11-28 16:21:06 -08006041 # In mailback mode only produce a report in the negative, for
6042 # things that appear to be patches.
6043 if ($mailback && ($clean == 1 || !$is_patch)) {
6044 exit(0);
6045 }
6046
6047 # This is not a patch, and we are are in 'no-patch' mode so
6048 # just keep quiet.
6049 if (!$chk_patch && !$is_patch) {
6050 exit(0);
6051 }
6052
Joe Perches06330fc2015-06-25 15:03:11 -07006053 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006054 ERROR("NOT_UNIFIED_DIFF",
6055 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006056 }
Joe Perches34d88152015-06-25 15:03:05 -07006057 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006058 ERROR("MISSING_SIGN_OFF",
6059 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006060 }
6061
Andy Whitcroft8905a672007-11-28 16:21:06 -08006062 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006063 if ($summary && !($clean == 1 && $quiet == 1)) {
6064 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006065 print "total: $cnt_error errors, $cnt_warn warnings, " .
6066 (($check)? "$cnt_chk checks, " : "") .
6067 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006068 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006069
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006070 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006071 # If there were any defects found and not already fixing them
6072 if (!$clean and !$fix) {
6073 print << "EOM"
6074
6075NOTE: For some of the reported defects, checkpatch may be able to
6076 mechanically convert to the typical style using --fix or --fix-inplace.
6077EOM
6078 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006079 # If there were whitespace errors which cleanpatch can fix
6080 # then suggest that.
6081 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006082 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006083 print << "EOM"
6084
6085NOTE: Whitespace errors detected.
6086 You may wish to use scripts/cleanpatch or scripts/cleanfile
6087EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006088 }
6089 }
6090
Joe Perchesd752fcc2014-08-06 16:11:05 -07006091 if ($clean == 0 && $fix &&
6092 ("@rawlines" ne "@fixed" ||
6093 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006094 my $newfile = $filename;
6095 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006096 my $linecount = 0;
6097 my $f;
6098
Joe Perchesd752fcc2014-08-06 16:11:05 -07006099 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6100
Joe Perches3705ce52013-07-03 15:05:31 -07006101 open($f, '>', $newfile)
6102 or die "$P: Can't open $newfile for write\n";
6103 foreach my $fixed_line (@fixed) {
6104 $linecount++;
6105 if ($file) {
6106 if ($linecount > 3) {
6107 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006108 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006109 }
6110 } else {
6111 print $f $fixed_line . "\n";
6112 }
6113 }
6114 close($f);
6115
6116 if (!$quiet) {
6117 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006118
Joe Perches3705ce52013-07-03 15:05:31 -07006119Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6120
6121Do _NOT_ trust the results written to this file.
6122Do _NOT_ submit these changes without inspecting them for correctness.
6123
6124This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6125No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006126EOM
6127 }
6128 }
6129
Joe Perchesd8469f12015-06-25 15:03:00 -07006130 if ($quiet == 0) {
6131 print "\n";
6132 if ($clean == 1) {
6133 print "$vname has no obvious style problems and is ready for submission.\n";
6134 } else {
6135 print "$vname has style problems, please review.\n";
6136 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006137 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006138 return $clean;
6139}