blob: 161b0224d6ae9ca927269664eaded3bcce41e91f [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Joe Perches882ea1d2018-06-07 17:04:33 -07002# SPDX-License-Identifier: GPL-2.0
3#
Dave Jonesdbf004d2010-01-12 16:59:52 -05004# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07005# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08006# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07007# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Joe Perches882ea1d2018-06-07 17:04:33 -07008# (c) 2010-2018 Joe Perches <joe@perches.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07009
10use strict;
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +020011use warnings;
Joe Perchesc707a812013-07-08 16:00:43 -070012use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080013use File::Basename;
14use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070015use Term::ANSIColor qw(:constants);
Geert Uytterhoevencd261492018-08-21 21:57:40 -070016use Encode qw(decode encode);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070017
18my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080019my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070020
Joe Perches000d1cc12011-07-25 17:13:25 -070021my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070022
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $tree = 1;
27my $chk_signoff = 1;
28my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070029my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080031my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070032my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070034my $git = 0;
Joe Perches0dea9f12016-05-20 17:04:19 -070035my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070037my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080038my $summary = 1;
39my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080040my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070041my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070042my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070043my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080044my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070045my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080046my %debug;
Joe Perches34456862013-07-03 15:05:34 -070047my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070048my %use_type = ();
49my @use = ();
50my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070051my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070052my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070053my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080054my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070055my $ignore_perl_version = 0;
56my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070057my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070058my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070059my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070060my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070061my $conststructsfile = "$D/const_structs.checkpatch";
Jerome Forissier75ad8c52017-05-08 15:56:00 -070062my $typedefsfile = "";
John Brooks737c0762017-07-10 15:52:24 -070063my $color = "auto";
Joe Perchesdadf6802016-08-02 14:04:33 -070064my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070065
66sub help {
67 my ($exitcode) = @_;
68
69 print << "EOM";
70Usage: $P [OPTION]... [FILE]...
71Version: $V
72
73Options:
74 -q, --quiet quiet
75 --no-tree run without a kernel tree
76 --no-signoff do not check for 'Signed-off-by' line
77 --patch treat FILE as patchfile (default)
78 --emacs emacs compile window format
79 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070080 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070081 -g, --git treat FILE as a single commit or git revision range
82 single git commit with:
83 <rev>
84 <rev>^
85 <rev>~n
86 multiple git commits with:
87 <rev1>..<rev2>
88 <rev1>...<rev2>
89 <rev>-<count>
90 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070091 -f, --file treat FILE as regular source file
92 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070093 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070094 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070095 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070096 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080097 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070098 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070099 --root=PATH PATH to the kernel tree root
100 --no-summary suppress the per-file summary
101 --mailback only produce a report in case of warnings/errors
102 --summary-file include the filename in summary
103 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
104 'values', 'possible', 'type', and 'attr' (default
105 is all off)
106 --test-only=WORD report only warnings/errors containing WORD
107 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700108 --fix EXPERIMENTAL - may create horrible results
109 If correctable single-line errors exist, create
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
112 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800113 --fix-inplace EXPERIMENTAL - may create horrible results
114 Is the same as --fix, but overwrites the input
115 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700116 --ignore-perl-version override checking of perl version. expect
117 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700118 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700119 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700120 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700121 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700122 --color[=WHEN] Use colors 'always', 'never', or only when output
123 is a terminal ('auto'). Default is 'auto'.
Hannes Eder77f5b102009-09-21 17:04:37 -0700124 -h, --help, --version display this help and exit
125
126When FILE is - read standard input.
127EOM
128
129 exit($exitcode);
130}
131
Joe Perches3beb42e2016-05-20 17:04:14 -0700132sub uniq {
133 my %seen;
134 return grep { !$seen{$_}++ } @_;
135}
136
137sub list_types {
138 my ($exitcode) = @_;
139
140 my $count = 0;
141
142 local $/ = undef;
143
144 open(my $script, '<', abs_path($P)) or
145 die "$P: Can't read '$P' $!\n";
146
147 my $text = <$script>;
148 close($script);
149
150 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700153 push (@types, $_);
154 }
155 @types = sort(uniq(@types));
156 print("#\tMessage type\n\n");
157 foreach my $type (@types) {
158 print(++$count . "\t" . $type . "\n");
159 }
160
161 exit($exitcode);
162}
163
Joe Perches000d1cc12011-07-25 17:13:25 -0700164my $conf = which_conf($configuration_file);
165if (-f $conf) {
166 my @conf_args;
167 open(my $conffile, '<', "$conf")
168 or warn "$P: Can't find a readable $configuration_file file $!\n";
169
170 while (<$conffile>) {
171 my $line = $_;
172
173 $line =~ s/\s*\n?$//g;
174 $line =~ s/^\s*//g;
175 $line =~ s/\s+/ /g;
176
177 next if ($line =~ m/^\s*#/);
178 next if ($line =~ m/^\s*$/);
179
180 my @words = split(" ", $line);
181 foreach my $word (@words) {
182 last if ($word =~ m/^#/);
183 push (@conf_args, $word);
184 }
185 }
186 close($conffile);
187 unshift(@ARGV, @conf_args) if @conf_args;
188}
189
John Brooks737c0762017-07-10 15:52:24 -0700190# Perl's Getopt::Long allows options to take optional arguments after a space.
191# Prevent --color by itself from consuming other arguments
192foreach (@ARGV) {
193 if ($_ eq "--color" || $_ eq "-color") {
194 $_ = "--color=$color";
195 }
196}
197
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700198GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700199 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700200 'tree!' => \$tree,
201 'signoff!' => \$chk_signoff,
202 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700203 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800204 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700205 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700206 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700207 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700208 'subjective!' => \$check,
209 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700210 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700211 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700212 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700213 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800214 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700215 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700216 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800217 'summary!' => \$summary,
218 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800219 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700220 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800221 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700222 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800223 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700224 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700225 'codespell!' => \$codespell,
226 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700227 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700228 'color=s' => \$color,
229 'no-color' => \$color, #keep old behaviors of -nocolor
230 'nocolor' => \$color, #keep old behaviors of -nocolor
Hannes Eder77f5b102009-09-21 17:04:37 -0700231 'h|help' => \$help,
232 'version' => \$help
233) or help(1);
234
235help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700236
Joe Perches3beb42e2016-05-20 17:04:14 -0700237list_types(0) if ($list_types);
238
Joe Perches9624b8d2014-01-23 15:54:44 -0800239$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700240$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800241
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700242my $exit = 0;
243
Joe Perches5b579802018-08-21 21:57:33 -0700244my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700245if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700246 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700247 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700248 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700249}
250
Allen Hubbe45107ff2016-08-02 14:04:47 -0700251#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700252if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700253 push(@ARGV, '-');
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700254}
255
John Brooks737c0762017-07-10 15:52:24 -0700256if ($color =~ /^[01]$/) {
257 $color = !$color;
258} elsif ($color =~ /^always$/i) {
259 $color = 1;
260} elsif ($color =~ /^never$/i) {
261 $color = 0;
262} elsif ($color =~ /^auto$/i) {
263 $color = (-t STDOUT);
264} else {
265 die "Invalid color mode: $color\n";
266}
267
Joe Perches91bfe482013-09-11 14:23:59 -0700268sub hash_save_array_words {
269 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700270
Joe Perches91bfe482013-09-11 14:23:59 -0700271 my @array = split(/,/, join(',', @$arrayRef));
272 foreach my $word (@array) {
273 $word =~ s/\s*\n?$//g;
274 $word =~ s/^\s*//g;
275 $word =~ s/\s+/ /g;
276 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700277
Joe Perches91bfe482013-09-11 14:23:59 -0700278 next if ($word =~ m/^\s*#/);
279 next if ($word =~ m/^\s*$/);
280
281 $hashRef->{$word}++;
282 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700283}
284
Joe Perches91bfe482013-09-11 14:23:59 -0700285sub hash_show_words {
286 my ($hashRef, $prefix) = @_;
287
Joe Perches3c816e42015-06-25 15:03:29 -0700288 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700289 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700290 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700291 print " $word";
292 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700293 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700294 }
295}
296
297hash_save_array_words(\%ignore_type, \@ignore);
298hash_save_array_words(\%use_type, \@use);
299
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800300my $dbg_values = 0;
301my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700302my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700303my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800304for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800305 ## no critic
306 eval "\${dbg_$key} = '$debug{$key}';";
307 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800308}
309
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700310my $rpt_cleaners = 0;
311
Andy Whitcroft8905a672007-11-28 16:21:06 -0800312if ($terse) {
313 $emacs = 1;
314 $quiet++;
315}
316
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700317if ($tree) {
318 if (defined $root) {
319 if (!top_of_kernel_tree($root)) {
320 die "$P: $root: --root does not point at a valid tree\n";
321 }
322 } else {
323 if (top_of_kernel_tree('.')) {
324 $root = '.';
325 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
326 top_of_kernel_tree($1)) {
327 $root = $1;
328 }
329 }
330
331 if (!defined $root) {
332 print "Must be run from the top-level dir. of a kernel tree\n";
333 exit(2);
334 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700335}
336
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700337my $emitted_corrupt = 0;
338
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700339our $Ident = qr{
340 [A-Za-z_][A-Za-z\d_]*
341 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
342 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700343our $Storage = qr{extern|static|asmlinkage};
344our $Sparse = qr{
345 __user|
346 __kernel|
347 __force|
348 __iomem|
349 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800350 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700351 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700352 __refconst|
353 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800354 __rcu|
355 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700356 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800357our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
358our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
359our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
360our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
361our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700362
Wolfram Sang52131292010-03-05 13:43:51 -0800363# Notes to $Attribute:
364# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700365our $Attribute = qr{
366 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700367 __percpu|
368 __nocast|
369 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200370 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700371 __packed__|
372 __packed2__|
373 __naked|
374 __maybe_unused|
375 __always_unused|
376 __noreturn|
377 __used|
378 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800379 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700380 __noclone|
381 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700382 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700383 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700384 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700385 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700386 ____cacheline_aligned|
387 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800388 ____cacheline_internodealigned_in_smp|
389 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700390 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700391our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700392our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700393our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
394our $Lval = qr{$Ident(?:$Member)*};
395
Joe Perches95e2c602013-07-03 15:05:20 -0700396our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
397our $Binary = qr{(?i)0b[01]+$Int_type?};
398our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
399our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700400our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800401our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800402our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
403our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
404our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800405our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700406our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800407our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700408our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700409our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700410our $Operators = qr{
411 <=|>=|==|!=|
412 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700413 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700414 }x;
415
Joe Perches91cb5192014-04-03 14:49:32 -0700416our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
417
Joe Perchesab7e23f2015-04-16 12:44:22 -0700418our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700420our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700421our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700423our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700425our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426
Joe Perches15662b32011-10-31 17:13:12 -0700427our $NON_ASCII_UTF8 = qr{
428 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700429 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
430 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
431 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
432 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
433 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
434 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
435}x;
436
Joe Perches15662b32011-10-31 17:13:12 -0700437our $UTF8 = qr{
438 [\x09\x0A\x0D\x20-\x7E] # ASCII
439 | $NON_ASCII_UTF8
440}x;
441
Joe Perchese6176fa2015-06-25 15:02:49 -0700442our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800443our $typeOtherOSTypedefs = qr{(?x:
444 u_(?:char|short|int|long) | # bsd
445 u(?:nchar|short|int|long) # sysv
446)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700447our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700448 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700449 atomic_t
450)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700451our $typeTypedefs = qr{(?x:
452 $typeC99Typedefs\b|
453 $typeOtherOSTypedefs\b|
454 $typeKernelTypedefs\b
455)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700456
Joe Perches6d32f7a2015-11-06 16:31:37 -0800457our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
458
Joe Perches691e6692010-03-05 13:43:51 -0800459our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800460 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700461 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches87bd4992017-11-17 15:28:48 -0800462 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700463 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700464 panic|
Joe Perches06668722013-11-12 15:10:07 -0800465 MODULE_[A-Z_]+|
466 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800467)};
468
Joe Perches20112472011-07-25 17:13:23 -0700469our $signature_tags = qr{(?xi:
470 Signed-off-by:|
471 Acked-by:|
472 Tested-by:|
473 Reviewed-by:|
474 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700475 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700476 To:|
477 Cc:
478)};
479
Joe Perches18130872014-08-06 16:11:22 -0700480our @typeListMisordered = (
481 qr{char\s+(?:un)?signed},
482 qr{int\s+(?:(?:un)?signed\s+)?short\s},
483 qr{int\s+short(?:\s+(?:un)?signed)},
484 qr{short\s+int(?:\s+(?:un)?signed)},
485 qr{(?:un)?signed\s+int\s+short},
486 qr{short\s+(?:un)?signed},
487 qr{long\s+int\s+(?:un)?signed},
488 qr{int\s+long\s+(?:un)?signed},
489 qr{long\s+(?:un)?signed\s+int},
490 qr{int\s+(?:un)?signed\s+long},
491 qr{int\s+(?:un)?signed},
492 qr{int\s+long\s+long\s+(?:un)?signed},
493 qr{long\s+long\s+int\s+(?:un)?signed},
494 qr{long\s+long\s+(?:un)?signed\s+int},
495 qr{long\s+long\s+(?:un)?signed},
496 qr{long\s+(?:un)?signed},
497);
498
Andy Whitcroft8905a672007-11-28 16:21:06 -0800499our @typeList = (
500 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700501 qr{(?:(?:un)?signed\s+)?char},
502 qr{(?:(?:un)?signed\s+)?short\s+int},
503 qr{(?:(?:un)?signed\s+)?short},
504 qr{(?:(?:un)?signed\s+)?int},
505 qr{(?:(?:un)?signed\s+)?long\s+int},
506 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
507 qr{(?:(?:un)?signed\s+)?long\s+long},
508 qr{(?:(?:un)?signed\s+)?long},
509 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800510 qr{float},
511 qr{double},
512 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800513 qr{struct\s+$Ident},
514 qr{union\s+$Ident},
515 qr{enum\s+$Ident},
516 qr{${Ident}_t},
517 qr{${Ident}_handler},
518 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700519 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800520);
Joe Perches938224b2016-01-20 14:59:15 -0800521
522our $C90_int_types = qr{(?x:
523 long\s+long\s+int\s+(?:un)?signed|
524 long\s+long\s+(?:un)?signed\s+int|
525 long\s+long\s+(?:un)?signed|
526 (?:(?:un)?signed\s+)?long\s+long\s+int|
527 (?:(?:un)?signed\s+)?long\s+long|
528 int\s+long\s+long\s+(?:un)?signed|
529 int\s+(?:(?:un)?signed\s+)?long\s+long|
530
531 long\s+int\s+(?:un)?signed|
532 long\s+(?:un)?signed\s+int|
533 long\s+(?:un)?signed|
534 (?:(?:un)?signed\s+)?long\s+int|
535 (?:(?:un)?signed\s+)?long|
536 int\s+long\s+(?:un)?signed|
537 int\s+(?:(?:un)?signed\s+)?long|
538
539 int\s+(?:un)?signed|
540 (?:(?:un)?signed\s+)?int
541)};
542
Alex Dowad485ff232015-06-25 15:02:52 -0700543our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700544our @typeListWithAttr = (
545 @typeList,
546 qr{struct\s+$InitAttribute\s+$Ident},
547 qr{union\s+$InitAttribute\s+$Ident},
548);
549
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700550our @modifierList = (
551 qr{fastcall},
552);
Alex Dowad485ff232015-06-25 15:02:52 -0700553our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800554
Joe Perches24358802014-04-03 14:49:13 -0700555our @mode_permission_funcs = (
556 ["module_param", 3],
557 ["module_param_(?:array|named|string)", 4],
558 ["module_param_array_named", 5],
559 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
560 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700561 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
562 ["IIO_DEV_ATTR_[A-Z_]+", 1],
563 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
564 ["SENSOR_TEMPLATE(?:_2|)", 3],
565 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700566);
567
Joe Perches515a2352014-04-03 14:49:24 -0700568#Create a search pattern for all these functions to speed up a loop below
569our $mode_perms_search = "";
570foreach my $entry (@mode_permission_funcs) {
571 $mode_perms_search .= '|' if ($mode_perms_search ne "");
572 $mode_perms_search .= $entry->[0];
573}
Joe Perches00180462018-02-06 15:38:55 -0800574$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700575
Joe Perchesb392c642015-04-16 12:44:16 -0700576our $mode_perms_world_writable = qr{
577 S_IWUGO |
578 S_IWOTH |
579 S_IRWXUGO |
580 S_IALLUGO |
581 0[0-7][0-7][2367]
582}x;
583
Joe Perchesf90774e2016-10-11 13:51:47 -0700584our %mode_permission_string_types = (
585 "S_IRWXU" => 0700,
586 "S_IRUSR" => 0400,
587 "S_IWUSR" => 0200,
588 "S_IXUSR" => 0100,
589 "S_IRWXG" => 0070,
590 "S_IRGRP" => 0040,
591 "S_IWGRP" => 0020,
592 "S_IXGRP" => 0010,
593 "S_IRWXO" => 0007,
594 "S_IROTH" => 0004,
595 "S_IWOTH" => 0002,
596 "S_IXOTH" => 0001,
597 "S_IRWXUGO" => 0777,
598 "S_IRUGO" => 0444,
599 "S_IWUGO" => 0222,
600 "S_IXUGO" => 0111,
601);
602
603#Create a search pattern for all these strings to speed up a loop below
604our $mode_perms_string_search = "";
605foreach my $entry (keys %mode_permission_string_types) {
606 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
607 $mode_perms_string_search .= $entry;
608}
Joe Perches00180462018-02-06 15:38:55 -0800609our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
610our $multi_mode_perms_string_search = qr{
611 ${single_mode_perms_string_search}
612 (?:\s*\|\s*${single_mode_perms_string_search})*
613}x;
614
615sub perms_to_octal {
616 my ($string) = @_;
617
618 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
619
620 my $val = "";
621 my $oval = "";
622 my $to = 0;
623 my $curpos = 0;
624 my $lastpos = 0;
625 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
626 $curpos = pos($string);
627 my $match = $2;
628 my $omatch = $1;
629 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
630 $lastpos = $curpos;
631 $to |= $mode_permission_string_types{$match};
632 $val .= '\s*\|\s*' if ($val ne "");
633 $val .= $match;
634 $oval .= $omatch;
635 }
636 $oval =~ s/^\s*\|\s*//;
637 $oval =~ s/\s*\|\s*$//;
638 return sprintf("%04o", $to);
639}
Joe Perchesf90774e2016-10-11 13:51:47 -0700640
Wolfram Sang7840a942010-08-09 17:20:57 -0700641our $allowed_asm_includes = qr{(?x:
642 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700643 memory|
644 time|
645 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700646)};
647# memory.h: ARM has a custom one
648
Kees Cook66b47b42014-10-13 15:51:57 -0700649# Load common spelling mistakes and build regular expression list.
650my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700651my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700652
Joe Perches36061e32014-12-10 15:51:43 -0800653if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800654 while (<$spelling>) {
655 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700656
Joe Perches36061e32014-12-10 15:51:43 -0800657 $line =~ s/\s*\n?$//g;
658 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700659
Joe Perches36061e32014-12-10 15:51:43 -0800660 next if ($line =~ m/^\s*#/);
661 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700662
Joe Perches36061e32014-12-10 15:51:43 -0800663 my ($suspect, $fix) = split(/\|\|/, $line);
664
Joe Perches36061e32014-12-10 15:51:43 -0800665 $spelling_fix{$suspect} = $fix;
666 }
667 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800668} else {
669 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700670}
Kees Cook66b47b42014-10-13 15:51:57 -0700671
Joe Perchesebfd7d62015-04-16 12:44:14 -0700672if ($codespell) {
673 if (open(my $spelling, '<', $codespellfile)) {
674 while (<$spelling>) {
675 my $line = $_;
676
677 $line =~ s/\s*\n?$//g;
678 $line =~ s/^\s*//g;
679
680 next if ($line =~ m/^\s*#/);
681 next if ($line =~ m/^\s*$/);
682 next if ($line =~ m/, disabled/i);
683
684 $line =~ s/,.*$//;
685
686 my ($suspect, $fix) = split(/->/, $line);
687
688 $spelling_fix{$suspect} = $fix;
689 }
690 close($spelling);
691 } else {
692 warn "No codespell typos will be found - file '$codespellfile': $!\n";
693 }
694}
695
696$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
697
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700698sub read_words {
699 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700700
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700701 if (open(my $words, '<', $file)) {
702 while (<$words>) {
703 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700704
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700705 $line =~ s/\s*\n?$//g;
706 $line =~ s/^\s*//g;
707
708 next if ($line =~ m/^\s*#/);
709 next if ($line =~ m/^\s*$/);
710 if ($line =~ /\s/) {
711 print("$file: '$line' invalid - ignored\n");
712 next;
713 }
714
715 $$wordsRef .= '|' if ($$wordsRef ne "");
716 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700717 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700718 close($file);
719 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700720 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700721
722 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700723}
724
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700725my $const_structs = "";
726read_words(\$const_structs, $conststructsfile)
727 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
728
729my $typeOtherTypedefs = "";
730if (length($typedefsfile)) {
731 read_words(\$typeOtherTypedefs, $typedefsfile)
732 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
733}
734$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
735
Andy Whitcroft8905a672007-11-28 16:21:06 -0800736sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700737 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
738 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700739 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700740 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700741 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700742 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700743 (?:$typeTypedefs\b)|
744 (?:${all}\b)
745 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800746 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700747 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800748 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800749 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700750 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700751 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800752 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700753 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800754 }x;
Joe Perches18130872014-08-06 16:11:22 -0700755 $NonptrTypeMisordered = qr{
756 (?:$Modifier\s+|const\s+)*
757 (?:
758 (?:${Misordered}\b)
759 )
760 (?:\s+$Modifier|\s+const)*
761 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700762 $NonptrTypeWithAttr = qr{
763 (?:$Modifier\s+|const\s+)*
764 (?:
765 (?:typeof|__typeof__)\s*\([^\)]*\)|
766 (?:$typeTypedefs\b)|
767 (?:${allWithAttr}\b)
768 )
769 (?:\s+$Modifier|\s+const)*
770 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800771 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700772 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700773 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700774 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800775 }x;
Joe Perches18130872014-08-06 16:11:22 -0700776 $TypeMisordered = qr{
777 $NonptrTypeMisordered
778 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
779 (?:\s+$Inline|\s+$Modifier)*
780 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700781 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700782 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800783}
784build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700785
Joe Perches7d2367a2011-07-25 17:13:22 -0700786our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700787
788# Using $balanced_parens, $LvalOrFunc, or $FuncArg
789# requires at least perl version v5.10.0
790# Any use must be runtime checked with $^V
791
792our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700793our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800794our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700795
Joe Perchesf8422302014-08-06 16:11:31 -0700796our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700797 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700798 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700799 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
800 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700801)};
802
Joe Perches7d2367a2011-07-25 17:13:22 -0700803sub deparenthesize {
804 my ($string) = @_;
805 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700806
807 while ($string =~ /^\s*\(.*\)\s*$/) {
808 $string =~ s@^\s*\(\s*@@;
809 $string =~ s@\s*\)\s*$@@;
810 }
811
Joe Perches7d2367a2011-07-25 17:13:22 -0700812 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700813
Joe Perches7d2367a2011-07-25 17:13:22 -0700814 return $string;
815}
816
Joe Perches34456862013-07-03 15:05:34 -0700817sub seed_camelcase_file {
818 my ($file) = @_;
819
820 return if (!(-f $file));
821
822 local $/;
823
824 open(my $include_file, '<', "$file")
825 or warn "$P: Can't read '$file' $!\n";
826 my $text = <$include_file>;
827 close($include_file);
828
829 my @lines = split('\n', $text);
830
831 foreach my $line (@lines) {
832 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
833 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
834 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800835 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
836 $camelcase{$1} = 1;
837 } 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 -0700838 $camelcase{$1} = 1;
839 }
840 }
841}
842
Joe Perches85b0ee12016-10-11 13:51:44 -0700843sub is_maintained_obsolete {
844 my ($filename) = @_;
845
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800846 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700847
Joe Perches0616efa2016-10-11 13:52:02 -0700848 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
Joe Perches85b0ee12016-10-11 13:51:44 -0700849
850 return $status =~ /obsolete/i;
851}
852
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700853sub is_SPDX_License_valid {
854 my ($license) = @_;
855
Joe Perches56294112018-08-21 21:58:04 -0700856 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700857
Joe Perches56294112018-08-21 21:58:04 -0700858 my $root_path = abs_path($root);
859 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700860 return 0 if ($status ne "");
861 return 1;
862}
863
Joe Perches34456862013-07-03 15:05:34 -0700864my $camelcase_seeded = 0;
865sub seed_camelcase_includes {
866 return if ($camelcase_seeded);
867
868 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700869 my $camelcase_cache = "";
870 my @include_files = ();
871
872 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700873
Richard Genoud3645e322014-02-10 14:25:32 -0800874 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700875 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
876 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700877 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700878 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700879 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700880 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700881 @include_files = split('\n', $files);
882 foreach my $file (@include_files) {
883 my $date = POSIX::strftime("%Y%m%d%H%M",
884 localtime((stat $file)[9]));
885 $last_mod_date = $date if ($last_mod_date < $date);
886 }
887 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700888 }
Joe Perchesc707a812013-07-08 16:00:43 -0700889
890 if ($camelcase_cache ne "" && -f $camelcase_cache) {
891 open(my $camelcase_file, '<', "$camelcase_cache")
892 or warn "$P: Can't read '$camelcase_cache' $!\n";
893 while (<$camelcase_file>) {
894 chomp;
895 $camelcase{$_} = 1;
896 }
897 close($camelcase_file);
898
899 return;
900 }
901
Richard Genoud3645e322014-02-10 14:25:32 -0800902 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700903 $files = `git ls-files "include/*.h"`;
904 @include_files = split('\n', $files);
905 }
906
Joe Perches34456862013-07-03 15:05:34 -0700907 foreach my $file (@include_files) {
908 seed_camelcase_file($file);
909 }
Joe Perches351b2a12013-07-03 15:05:36 -0700910
Joe Perchesc707a812013-07-08 16:00:43 -0700911 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700912 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700913 open(my $camelcase_file, '>', "$camelcase_cache")
914 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700915 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
916 print $camelcase_file ("$_\n");
917 }
918 close($camelcase_file);
919 }
Joe Perches34456862013-07-03 15:05:34 -0700920}
921
Joe Perchesd311cd42014-08-06 16:10:57 -0700922sub git_commit_info {
923 my ($commit, $id, $desc) = @_;
924
925 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
926
927 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
928 $output =~ s/^\s*//gm;
929 my @lines = split("\n", $output);
930
Joe Perches0d7835f2015-02-13 14:38:35 -0800931 return ($id, $desc) if ($#lines < 0);
932
Joe Perchesd311cd42014-08-06 16:10:57 -0700933 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
934# Maybe one day convert this block of bash into something that returns
935# all matching commit ids, but it's very slow...
936#
937# echo "checking commits $1..."
938# git rev-list --remotes | grep -i "^$1" |
939# while read line ; do
940# git log --format='%H %s' -1 $line |
941# echo "commit $(cut -c 1-12,41-)"
942# done
943 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700944 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700945 } else {
946 $id = substr($lines[0], 0, 12);
947 $desc = substr($lines[0], 41);
948 }
949
950 return ($id, $desc);
951}
952
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700953$chk_signoff = 0 if ($file);
954
Andy Whitcroft00df3442007-06-08 13:47:06 -0700955my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800956my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700957my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700958my @fixed_inserted = ();
959my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700960my $fixlinenr = -1;
961
Du, Changbin4a593c32016-05-20 17:04:16 -0700962# If input is git commits, extract all commits from the commit expressions.
963# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
964die "$P: No git repository found\n" if ($git && !-e ".git");
965
966if ($git) {
967 my @commits = ();
Joe Perches0dea9f12016-05-20 17:04:19 -0700968 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700969 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700970 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
971 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700972 } elsif ($commit_expr =~ m/\.\./) {
973 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700974 } else {
Joe Perches0dea9f12016-05-20 17:04:19 -0700975 $git_range = "-1 $commit_expr";
976 }
977 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
978 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700979 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
980 next if (!defined($1) || !defined($2));
Joe Perches0dea9f12016-05-20 17:04:19 -0700981 my $sha1 = $1;
982 my $subject = $2;
983 unshift(@commits, $sha1);
984 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700985 }
986 }
987 die "$P: no git commits after extraction!\n" if (@commits == 0);
988 @ARGV = @commits;
989}
990
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800991my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700992for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800993 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700994 if ($git) {
995 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
996 die "$P: $filename: git format-patch failed - $!\n";
997 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800998 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700999 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001000 } elsif ($filename eq '-') {
1001 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001002 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001003 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001004 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001005 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001006 if ($filename eq '-') {
1007 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001008 } elsif ($git) {
Joe Perches0dea9f12016-05-20 17:04:19 -07001009 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010 } else {
1011 $vname = $filename;
1012 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001013 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001014 chomp;
1015 push(@rawlines, $_);
1016 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001017 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001018
1019 if ($#ARGV > 0 && $quiet == 0) {
1020 print '-' x length($vname) . "\n";
1021 print "$vname\n";
1022 print '-' x length($vname) . "\n";
1023 }
1024
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001025 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001026 $exit = 1;
1027 }
1028 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001029 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001030 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001031 @fixed_inserted = ();
1032 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001033 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001034 @modifierListFile = ();
1035 @typeListFile = ();
1036 build_types();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001037}
1038
Joe Perchesd8469f12015-06-25 15:03:00 -07001039if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001040 hash_show_words(\%use_type, "Used");
1041 hash_show_words(\%ignore_type, "Ignored");
1042
Joe Perches5b579802018-08-21 21:57:33 -07001043 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001044 print << "EOM"
1045
1046NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001047 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001048EOM
1049 }
1050 if ($exit) {
1051 print << "EOM"
1052
1053NOTE: If any of the errors are false positives, please report
1054 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1055EOM
1056 }
1057}
1058
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001059exit($exit);
1060
1061sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001062 my ($root) = @_;
1063
1064 my @tree_check = (
1065 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1066 "README", "Documentation", "arch", "include", "drivers",
1067 "fs", "init", "ipc", "kernel", "lib", "scripts",
1068 );
1069
1070 foreach my $check (@tree_check) {
1071 if (! -e $root . '/' . $check) {
1072 return 0;
1073 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001074 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001075 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001076}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001077
Joe Perches20112472011-07-25 17:13:23 -07001078sub parse_email {
1079 my ($formatted_email) = @_;
1080
1081 my $name = "";
1082 my $address = "";
1083 my $comment = "";
1084
1085 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1086 $name = $1;
1087 $address = $2;
1088 $comment = $3 if defined $3;
1089 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1090 $address = $1;
1091 $comment = $2 if defined $2;
1092 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1093 $address = $1;
1094 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001095 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001096 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001097 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001098 $name =~ s/^\"|\"$//g;
1099 # If there's a name left after stripping spaces and
1100 # leading quotes, and the address doesn't have both
1101 # leading and trailing angle brackets, the address
1102 # is invalid. ie:
1103 # "joe smith joe@smith.com" bad
1104 # "joe smith <joe@smith.com" bad
1105 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1106 $name = "";
1107 $address = "";
1108 $comment = "";
1109 }
1110 }
1111
Joe Perches3705ce52013-07-03 15:05:31 -07001112 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001113 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001114 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001115 $address =~ s/^\<|\>$//g;
1116
1117 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1118 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1119 $name = "\"$name\"";
1120 }
1121
1122 return ($name, $address, $comment);
1123}
1124
1125sub format_email {
1126 my ($name, $address) = @_;
1127
1128 my $formatted_email;
1129
Joe Perches3705ce52013-07-03 15:05:31 -07001130 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001131 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001132 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001133
1134 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1135 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1136 $name = "\"$name\"";
1137 }
1138
1139 if ("$name" eq "") {
1140 $formatted_email = "$address";
1141 } else {
1142 $formatted_email = "$name <$address>";
1143 }
1144
1145 return $formatted_email;
1146}
1147
Joe Perchesd311cd42014-08-06 16:10:57 -07001148sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001149 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001150
Joe Perchesbd474ca2014-08-06 16:11:10 -07001151 foreach my $path (split(/:/, $ENV{PATH})) {
1152 if (-e "$path/$bin") {
1153 return "$path/$bin";
1154 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001155 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001156
Joe Perchesbd474ca2014-08-06 16:11:10 -07001157 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001158}
1159
Joe Perches000d1cc12011-07-25 17:13:25 -07001160sub which_conf {
1161 my ($conf) = @_;
1162
1163 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1164 if (-e "$path/$conf") {
1165 return "$path/$conf";
1166 }
1167 }
1168
1169 return "";
1170}
1171
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001172sub expand_tabs {
1173 my ($str) = @_;
1174
1175 my $res = '';
1176 my $n = 0;
1177 for my $c (split(//, $str)) {
1178 if ($c eq "\t") {
1179 $res .= ' ';
1180 $n++;
1181 for (; ($n % 8) != 0; $n++) {
1182 $res .= ' ';
1183 }
1184 next;
1185 }
1186 $res .= $c;
1187 $n++;
1188 }
1189
1190 return $res;
1191}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001192sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001193 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 return $res;
1195}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001196
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001197sub line_stats {
1198 my ($line) = @_;
1199
1200 # Drop the diff line leader and expand tabs
1201 $line =~ s/^.//;
1202 $line = expand_tabs($line);
1203
1204 # Pick the indent from the front of the line.
1205 my ($white) = ($line =~ /^(\s*)/);
1206
1207 return (length($line), length($white));
1208}
1209
Andy Whitcroft773647a2008-03-28 14:15:58 -07001210my $sanitise_quote = '';
1211
1212sub sanitise_line_reset {
1213 my ($in_comment) = @_;
1214
1215 if ($in_comment) {
1216 $sanitise_quote = '*/';
1217 } else {
1218 $sanitise_quote = '';
1219 }
1220}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001221sub sanitise_line {
1222 my ($line) = @_;
1223
1224 my $res = '';
1225 my $l = '';
1226
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001227 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001228 my $off = 0;
1229 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001230
Andy Whitcroft773647a2008-03-28 14:15:58 -07001231 # Always copy over the diff marker.
1232 $res = substr($line, 0, 1);
1233
1234 for ($off = 1; $off < length($line); $off++) {
1235 $c = substr($line, $off, 1);
1236
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001237 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001238 # and end, all to $;.
1239 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1240 $sanitise_quote = '*/';
1241
1242 substr($res, $off, 2, "$;$;");
1243 $off++;
1244 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001245 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001246 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001247 $sanitise_quote = '';
1248 substr($res, $off, 2, "$;$;");
1249 $off++;
1250 next;
1251 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001252 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1253 $sanitise_quote = '//';
1254
1255 substr($res, $off, 2, $sanitise_quote);
1256 $off++;
1257 next;
1258 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001259
1260 # A \ in a string means ignore the next character.
1261 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1262 $c eq "\\") {
1263 substr($res, $off, 2, 'XX');
1264 $off++;
1265 next;
1266 }
1267 # Regular quotes.
1268 if ($c eq "'" || $c eq '"') {
1269 if ($sanitise_quote eq '') {
1270 $sanitise_quote = $c;
1271
1272 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001273 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001274 } elsif ($sanitise_quote eq $c) {
1275 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001276 }
1277 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001278
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001279 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001280 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1281 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001282 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1283 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001284 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1285 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001286 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001287 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001288 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001289 }
1290
Daniel Walker113f04a2009-09-21 17:04:35 -07001291 if ($sanitise_quote eq '//') {
1292 $sanitise_quote = '';
1293 }
1294
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001295 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001296 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001297 my $clean = 'X' x length($1);
1298 $res =~ s@\<.*\>@<$clean>@;
1299
1300 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001301 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001303 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001304 }
1305
Joe Perchesdadf6802016-08-02 14:04:33 -07001306 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1307 my $match = $1;
1308 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1309 }
1310
Andy Whitcroft00df3442007-06-08 13:47:06 -07001311 return $res;
1312}
1313
Joe Perchesa6962d72013-04-29 16:18:13 -07001314sub get_quoted_string {
1315 my ($line, $rawline) = @_;
1316
Joe Perches478b1792018-04-10 16:33:34 -07001317 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001318 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001319 return substr($rawline, $-[0], $+[0] - $-[0]);
1320}
1321
Andy Whitcroft8905a672007-11-28 16:21:06 -08001322sub ctx_statement_block {
1323 my ($linenr, $remain, $off) = @_;
1324 my $line = $linenr - 1;
1325 my $blk = '';
1326 my $soff = $off;
1327 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001328 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001329
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001330 my $loff = 0;
1331
Andy Whitcroft8905a672007-11-28 16:21:06 -08001332 my $type = '';
1333 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001334 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001335 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001336 my $c;
1337 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001338
1339 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001340 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001341 @stack = (['', 0]) if ($#stack == -1);
1342
Andy Whitcroft773647a2008-03-28 14:15:58 -07001343 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001344 # If we are about to drop off the end, pull in more
1345 # context.
1346 if ($off >= $len) {
1347 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001348 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001349 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001350 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001351 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001352 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001353 $len = length($blk);
1354 $line++;
1355 last;
1356 }
1357 # Bail if there is no further context.
1358 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001359 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001360 last;
1361 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001362 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1363 $level++;
1364 $type = '#';
1365 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001366 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001367 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001368 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001369 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001370
Andy Whitcroft773647a2008-03-28 14:15:58 -07001371 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001372
1373 # Handle nested #if/#else.
1374 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1375 push(@stack, [ $type, $level ]);
1376 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1377 ($type, $level) = @{$stack[$#stack - 1]};
1378 } elsif ($remainder =~ /^#\s*endif\b/) {
1379 ($type, $level) = @{pop(@stack)};
1380 }
1381
Andy Whitcroft8905a672007-11-28 16:21:06 -08001382 # Statement ends at the ';' or a close '}' at the
1383 # outermost level.
1384 if ($level == 0 && $c eq ';') {
1385 last;
1386 }
1387
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001388 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001389 if ($level == 0 && $coff_set == 0 &&
1390 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1391 $remainder =~ /^(else)(?:\s|{)/ &&
1392 $remainder !~ /^else\s+if\b/) {
1393 $coff = $off + length($1) - 1;
1394 $coff_set = 1;
1395 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1396 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001397 }
1398
Andy Whitcroft8905a672007-11-28 16:21:06 -08001399 if (($type eq '' || $type eq '(') && $c eq '(') {
1400 $level++;
1401 $type = '(';
1402 }
1403 if ($type eq '(' && $c eq ')') {
1404 $level--;
1405 $type = ($level != 0)? '(' : '';
1406
1407 if ($level == 0 && $coff < $soff) {
1408 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001409 $coff_set = 1;
1410 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001411 }
1412 }
1413 if (($type eq '' || $type eq '{') && $c eq '{') {
1414 $level++;
1415 $type = '{';
1416 }
1417 if ($type eq '{' && $c eq '}') {
1418 $level--;
1419 $type = ($level != 0)? '{' : '';
1420
1421 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001422 if (substr($blk, $off + 1, 1) eq ';') {
1423 $off++;
1424 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001425 last;
1426 }
1427 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001428 # Preprocessor commands end at the newline unless escaped.
1429 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1430 $level--;
1431 $type = '';
1432 $off++;
1433 last;
1434 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001435 $off++;
1436 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001437 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001438 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001439 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001440 $line++;
1441 $remain--;
1442 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001443
1444 my $statement = substr($blk, $soff, $off - $soff + 1);
1445 my $condition = substr($blk, $soff, $coff - $soff + 1);
1446
1447 #warn "STATEMENT<$statement>\n";
1448 #warn "CONDITION<$condition>\n";
1449
Andy Whitcroft773647a2008-03-28 14:15:58 -07001450 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001451
1452 return ($statement, $condition,
1453 $line, $remain + 1, $off - $loff + 1, $level);
1454}
1455
Andy Whitcroftcf655042008-03-04 14:28:20 -08001456sub statement_lines {
1457 my ($stmt) = @_;
1458
1459 # Strip the diff line prefixes and rip blank lines at start and end.
1460 $stmt =~ s/(^|\n)./$1/g;
1461 $stmt =~ s/^\s*//;
1462 $stmt =~ s/\s*$//;
1463
1464 my @stmt_lines = ($stmt =~ /\n/g);
1465
1466 return $#stmt_lines + 2;
1467}
1468
1469sub statement_rawlines {
1470 my ($stmt) = @_;
1471
1472 my @stmt_lines = ($stmt =~ /\n/g);
1473
1474 return $#stmt_lines + 2;
1475}
1476
1477sub statement_block_size {
1478 my ($stmt) = @_;
1479
1480 $stmt =~ s/(^|\n)./$1/g;
1481 $stmt =~ s/^\s*{//;
1482 $stmt =~ s/}\s*$//;
1483 $stmt =~ s/^\s*//;
1484 $stmt =~ s/\s*$//;
1485
1486 my @stmt_lines = ($stmt =~ /\n/g);
1487 my @stmt_statements = ($stmt =~ /;/g);
1488
1489 my $stmt_lines = $#stmt_lines + 2;
1490 my $stmt_statements = $#stmt_statements + 1;
1491
1492 if ($stmt_lines > $stmt_statements) {
1493 return $stmt_lines;
1494 } else {
1495 return $stmt_statements;
1496 }
1497}
1498
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001499sub ctx_statement_full {
1500 my ($linenr, $remain, $off) = @_;
1501 my ($statement, $condition, $level);
1502
1503 my (@chunks);
1504
Andy Whitcroftcf655042008-03-04 14:28:20 -08001505 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001506 ($statement, $condition, $linenr, $remain, $off, $level) =
1507 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001508 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001509 push(@chunks, [ $condition, $statement ]);
1510 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1511 return ($level, $linenr, @chunks);
1512 }
1513
1514 # Pull in the following conditional/block pairs and see if they
1515 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001516 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001517 ($statement, $condition, $linenr, $remain, $off, $level) =
1518 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001519 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001520 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001521 #print "C: push\n";
1522 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001523 }
1524
1525 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001526}
1527
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001528sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001529 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001530 my $line;
1531 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001532 my $blk = '';
1533 my @o;
1534 my @c;
1535 my @res = ();
1536
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001537 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001538 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001539 for ($line = $start; $remain > 0; $line++) {
1540 next if ($rawlines[$line] =~ /^-/);
1541 $remain--;
1542
1543 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001544
1545 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001546 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001547 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001548 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001549 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001550 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001551 $level = pop(@stack);
1552 }
1553
Andy Whitcroft01464f32010-10-26 14:23:19 -07001554 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001555 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1556 if ($off > 0) {
1557 $off--;
1558 next;
1559 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001560
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001561 if ($c eq $close && $level > 0) {
1562 $level--;
1563 last if ($level == 0);
1564 } elsif ($c eq $open) {
1565 $level++;
1566 }
1567 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001568
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001569 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001570 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001571 }
1572
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001573 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001574 }
1575
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001576 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001577}
1578sub ctx_block_outer {
1579 my ($linenr, $remain) = @_;
1580
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001581 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1582 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001583}
1584sub ctx_block {
1585 my ($linenr, $remain) = @_;
1586
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001587 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1588 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001589}
1590sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001591 my ($linenr, $remain, $off) = @_;
1592
1593 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1594 return @r;
1595}
1596sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001597 my ($linenr, $remain) = @_;
1598
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001599 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001600}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001601sub ctx_statement_level {
1602 my ($linenr, $remain, $off) = @_;
1603
1604 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1605}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001606
1607sub ctx_locate_comment {
1608 my ($first_line, $end_line) = @_;
1609
1610 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001611 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001612 return $current_comment if (defined $current_comment);
1613
1614 # Look through the context and try and figure out if there is a
1615 # comment.
1616 my $in_comment = 0;
1617 $current_comment = '';
1618 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001619 my $line = $rawlines[$linenr - 1];
1620 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001621 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1622 $in_comment = 1;
1623 }
1624 if ($line =~ m@/\*@) {
1625 $in_comment = 1;
1626 }
1627 if (!$in_comment && $current_comment ne '') {
1628 $current_comment = '';
1629 }
1630 $current_comment .= $line . "\n" if ($in_comment);
1631 if ($line =~ m@\*/@) {
1632 $in_comment = 0;
1633 }
1634 }
1635
1636 chomp($current_comment);
1637 return($current_comment);
1638}
1639sub ctx_has_comment {
1640 my ($first_line, $end_line) = @_;
1641 my $cmt = ctx_locate_comment($first_line, $end_line);
1642
Andy Whitcroft00df3442007-06-08 13:47:06 -07001643 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001644 ##print "CMMT: $cmt\n";
1645
1646 return ($cmt ne '');
1647}
1648
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001649sub raw_line {
1650 my ($linenr, $cnt) = @_;
1651
1652 my $offset = $linenr - 1;
1653 $cnt++;
1654
1655 my $line;
1656 while ($cnt) {
1657 $line = $rawlines[$offset++];
1658 next if (defined($line) && $line =~ /^-/);
1659 $cnt--;
1660 }
1661
1662 return $line;
1663}
1664
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001665sub get_stat_real {
1666 my ($linenr, $lc) = @_;
1667
1668 my $stat_real = raw_line($linenr, 0);
1669 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1670 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1671 }
1672
1673 return $stat_real;
1674}
1675
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001676sub get_stat_here {
1677 my ($linenr, $cnt, $here) = @_;
1678
1679 my $herectx = $here . "\n";
1680 for (my $n = 0; $n < $cnt; $n++) {
1681 $herectx .= raw_line($linenr, $n) . "\n";
1682 }
1683
1684 return $herectx;
1685}
1686
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001687sub cat_vet {
1688 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001689 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001690
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001691 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001692 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1693 $res .= $1;
1694 if ($2 ne '') {
1695 $coded = sprintf("^%c", unpack('C', $2) + 64);
1696 $res .= $coded;
1697 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001698 }
1699 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001700
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001701 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001702}
1703
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001704my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001705my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001706my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001707my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001708
1709sub annotate_reset {
1710 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001711 $av_pending = '_';
1712 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001713 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001714}
1715
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001716sub annotate_values {
1717 my ($stream, $type) = @_;
1718
1719 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001720 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001721 my $cur = $stream;
1722
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001723 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001724
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001725 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001726 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001727 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001728 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001729 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001730 print "WS($1)\n" if ($dbg_values > 1);
1731 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001732 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001733 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001734 }
1735
Florian Micklerc023e4732011-01-12 16:59:58 -08001736 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001737 print "CAST($1)\n" if ($dbg_values > 1);
1738 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001739 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001740
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001741 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001742 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001743 $type = 'T';
1744
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001745 } elsif ($cur =~ /^($Modifier)\s*/) {
1746 print "MODIFIER($1)\n" if ($dbg_values > 1);
1747 $type = 'T';
1748
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001749 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001750 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001751 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001752 push(@av_paren_type, $type);
1753 if ($2 ne '') {
1754 $av_pending = 'N';
1755 }
1756 $type = 'E';
1757
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001758 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001759 print "UNDEF($1)\n" if ($dbg_values > 1);
1760 $av_preprocessor = 1;
1761 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001762
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001763 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001764 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001765 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001766
1767 push(@av_paren_type, $type);
1768 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001769 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001770
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001771 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001772 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1773 $av_preprocessor = 1;
1774
1775 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1776
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001777 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001778
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001779 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001780 print "PRE_END($1)\n" if ($dbg_values > 1);
1781
1782 $av_preprocessor = 1;
1783
1784 # Assume all arms of the conditional end as this
1785 # one does, and continue as if the #endif was not here.
1786 pop(@av_paren_type);
1787 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001788 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001789
1790 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001791 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001792
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001793 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1794 print "ATTR($1)\n" if ($dbg_values > 1);
1795 $av_pending = $type;
1796 $type = 'N';
1797
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001798 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001799 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001800 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001801 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001802 }
1803 $type = 'N';
1804
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001805 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001806 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001807 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001808 $type = 'N';
1809
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001810 } elsif ($cur =~/^(case)/o) {
1811 print "CASE($1)\n" if ($dbg_values > 1);
1812 $av_pend_colon = 'C';
1813 $type = 'N';
1814
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001815 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001816 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001817 $type = 'N';
1818
1819 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001820 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001821 push(@av_paren_type, $av_pending);
1822 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001823 $type = 'N';
1824
1825 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001826 my $new_type = pop(@av_paren_type);
1827 if ($new_type ne '_') {
1828 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001829 print "PAREN('$1') -> $type\n"
1830 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001831 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001832 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001833 }
1834
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001835 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001836 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001837 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001838 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001839
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001840 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1841 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001842 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001843 } elsif ($type eq 'E') {
1844 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001845 }
1846 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1847 $type = 'V';
1848
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001849 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001850 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001851 $type = 'V';
1852
1853 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001854 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001855 $type = 'N';
1856
Andy Whitcroftcf655042008-03-04 14:28:20 -08001857 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001858 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001859 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001860 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001861
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001862 } elsif ($cur =~/^(,)/) {
1863 print "COMMA($1)\n" if ($dbg_values > 1);
1864 $type = 'C';
1865
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001866 } elsif ($cur =~ /^(\?)/o) {
1867 print "QUESTION($1)\n" if ($dbg_values > 1);
1868 $type = 'N';
1869
1870 } elsif ($cur =~ /^(:)/o) {
1871 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1872
1873 substr($var, length($res), 1, $av_pend_colon);
1874 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1875 $type = 'E';
1876 } else {
1877 $type = 'N';
1878 }
1879 $av_pend_colon = 'O';
1880
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001881 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001882 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001883 $type = 'N';
1884
Andy Whitcroft0d413862008-10-15 22:02:16 -07001885 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001886 my $variant;
1887
1888 print "OPV($1)\n" if ($dbg_values > 1);
1889 if ($type eq 'V') {
1890 $variant = 'B';
1891 } else {
1892 $variant = 'U';
1893 }
1894
1895 substr($var, length($res), 1, $variant);
1896 $type = 'N';
1897
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001898 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001899 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001900 if ($1 ne '++' && $1 ne '--') {
1901 $type = 'N';
1902 }
1903
1904 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001905 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001906 }
1907 if (defined $1) {
1908 $cur = substr($cur, length($1));
1909 $res .= $type x length($1);
1910 }
1911 }
1912
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001913 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001914}
1915
Andy Whitcroft8905a672007-11-28 16:21:06 -08001916sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001917 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001918 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001919 ^(?:
1920 $Modifier|
1921 $Storage|
1922 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001923 DEFINE_\S+
1924 )$|
1925 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001926 goto|
1927 return|
1928 case|
1929 else|
1930 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001931 do|
1932 \#|
1933 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001934 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001935 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001936 )}x;
1937 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1938 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001939 # Check for modifiers.
1940 $possible =~ s/\s*$Storage\s*//g;
1941 $possible =~ s/\s*$Sparse\s*//g;
1942 if ($possible =~ /^\s*$/) {
1943
1944 } elsif ($possible =~ /\s/) {
1945 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001946 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001947 if ($modifier !~ $notPermitted) {
1948 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001949 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001950 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001951 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001952
1953 } else {
1954 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001955 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001956 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001957 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001958 } else {
1959 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001960 }
1961}
1962
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001963my $prefix = '';
1964
Joe Perches000d1cc12011-07-25 17:13:25 -07001965sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001966 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001967
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001968 $type =~ tr/[a-z]/[A-Z]/;
1969
Joe Perchescbec18a2014-04-03 14:49:19 -07001970 return defined $use_type{$type} if (scalar keys %use_type > 0);
1971
1972 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001973}
1974
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001975sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001976 my ($level, $type, $msg) = @_;
1977
1978 if (!show_type($type) ||
1979 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001980 return 0;
1981 }
Joe Perches57230292015-06-25 15:03:03 -07001982 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001983 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001984 if ($level eq 'ERROR') {
1985 $output .= RED;
1986 } elsif ($level eq 'WARNING') {
1987 $output .= YELLOW;
1988 } else {
1989 $output .= GREEN;
1990 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001991 }
Joe Perches57230292015-06-25 15:03:03 -07001992 $output .= $prefix . $level . ':';
1993 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001994 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001995 $output .= "$type:";
1996 }
John Brooks737c0762017-07-10 15:52:24 -07001997 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001998 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001999
2000 if ($showfile) {
2001 my @lines = split("\n", $output, -1);
2002 splice(@lines, 1, 1);
2003 $output = join("\n", @lines);
2004 }
Joe Perches57230292015-06-25 15:03:03 -07002005 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002006
Joe Perches57230292015-06-25 15:03:03 -07002007 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002008
2009 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002010}
Joe Perchescbec18a2014-04-03 14:49:19 -07002011
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002012sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002013 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002014}
Joe Perches000d1cc12011-07-25 17:13:25 -07002015
Joe Perchesd752fcc2014-08-06 16:11:05 -07002016sub fixup_current_range {
2017 my ($lineRef, $offset, $length) = @_;
2018
2019 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2020 my $o = $1;
2021 my $l = $2;
2022 my $no = $o + $offset;
2023 my $nl = $l + $length;
2024 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2025 }
2026}
2027
2028sub fix_inserted_deleted_lines {
2029 my ($linesRef, $insertedRef, $deletedRef) = @_;
2030
2031 my $range_last_linenr = 0;
2032 my $delta_offset = 0;
2033
2034 my $old_linenr = 0;
2035 my $new_linenr = 0;
2036
2037 my $next_insert = 0;
2038 my $next_delete = 0;
2039
2040 my @lines = ();
2041
2042 my $inserted = @{$insertedRef}[$next_insert++];
2043 my $deleted = @{$deletedRef}[$next_delete++];
2044
2045 foreach my $old_line (@{$linesRef}) {
2046 my $save_line = 1;
2047 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002048 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002049 $delta_offset = 0;
2050 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2051 $range_last_linenr = $new_linenr;
2052 fixup_current_range(\$line, $delta_offset, 0);
2053 }
2054
2055 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2056 $deleted = @{$deletedRef}[$next_delete++];
2057 $save_line = 0;
2058 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2059 }
2060
2061 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2062 push(@lines, ${$inserted}{'LINE'});
2063 $inserted = @{$insertedRef}[$next_insert++];
2064 $new_linenr++;
2065 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2066 }
2067
2068 if ($save_line) {
2069 push(@lines, $line);
2070 $new_linenr++;
2071 }
2072
2073 $old_linenr++;
2074 }
2075
2076 return @lines;
2077}
2078
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002079sub fix_insert_line {
2080 my ($linenr, $line) = @_;
2081
2082 my $inserted = {
2083 LINENR => $linenr,
2084 LINE => $line,
2085 };
2086 push(@fixed_inserted, $inserted);
2087}
2088
2089sub fix_delete_line {
2090 my ($linenr, $line) = @_;
2091
2092 my $deleted = {
2093 LINENR => $linenr,
2094 LINE => $line,
2095 };
2096
2097 push(@fixed_deleted, $deleted);
2098}
2099
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002100sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002101 my ($type, $msg) = @_;
2102
2103 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002104 our $clean = 0;
2105 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002106 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002107 }
Joe Perches3705ce52013-07-03 15:05:31 -07002108 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002109}
2110sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002111 my ($type, $msg) = @_;
2112
2113 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002114 our $clean = 0;
2115 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002116 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002117 }
Joe Perches3705ce52013-07-03 15:05:31 -07002118 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002119}
2120sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002121 my ($type, $msg) = @_;
2122
2123 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002124 our $clean = 0;
2125 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002126 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002127 }
Joe Perches3705ce52013-07-03 15:05:31 -07002128 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002129}
2130
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002131sub check_absolute_file {
2132 my ($absolute, $herecurr) = @_;
2133 my $file = $absolute;
2134
2135 ##print "absolute<$absolute>\n";
2136
2137 # See if any suffix of this path is a path within the tree.
2138 while ($file =~ s@^[^/]*/@@) {
2139 if (-f "$root/$file") {
2140 ##print "file<$file>\n";
2141 last;
2142 }
2143 }
2144 if (! -f _) {
2145 return 0;
2146 }
2147
2148 # It is, so see if the prefix is acceptable.
2149 my $prefix = $absolute;
2150 substr($prefix, -length($file)) = '';
2151
2152 ##print "prefix<$prefix>\n";
2153 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002154 WARN("USE_RELATIVE_PATH",
2155 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002156 }
2157}
2158
Joe Perches3705ce52013-07-03 15:05:31 -07002159sub trim {
2160 my ($string) = @_;
2161
Joe Perchesb34c6482013-09-11 14:24:01 -07002162 $string =~ s/^\s+|\s+$//g;
2163
2164 return $string;
2165}
2166
2167sub ltrim {
2168 my ($string) = @_;
2169
2170 $string =~ s/^\s+//;
2171
2172 return $string;
2173}
2174
2175sub rtrim {
2176 my ($string) = @_;
2177
2178 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002179
2180 return $string;
2181}
2182
Joe Perches52ea8502013-11-12 15:10:09 -08002183sub string_find_replace {
2184 my ($string, $find, $replace) = @_;
2185
2186 $string =~ s/$find/$replace/g;
2187
2188 return $string;
2189}
2190
Joe Perches3705ce52013-07-03 15:05:31 -07002191sub tabify {
2192 my ($leading) = @_;
2193
2194 my $source_indent = 8;
2195 my $max_spaces_before_tab = $source_indent - 1;
2196 my $spaces_to_tab = " " x $source_indent;
2197
2198 #convert leading spaces to tabs
2199 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2200 #Remove spaces before a tab
2201 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2202
2203 return "$leading";
2204}
2205
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002206sub pos_last_openparen {
2207 my ($line) = @_;
2208
2209 my $pos = 0;
2210
2211 my $opens = $line =~ tr/\(/\(/;
2212 my $closes = $line =~ tr/\)/\)/;
2213
2214 my $last_openparen = 0;
2215
2216 if (($opens == 0) || ($closes >= $opens)) {
2217 return -1;
2218 }
2219
2220 my $len = length($line);
2221
2222 for ($pos = 0; $pos < $len; $pos++) {
2223 my $string = substr($line, $pos);
2224 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2225 $pos += length($1) - 1;
2226 } elsif (substr($line, $pos, 1) eq '(') {
2227 $last_openparen = $pos;
2228 } elsif (index($string, '(') == -1) {
2229 last;
2230 }
2231 }
2232
Joe Perches91cb5192014-04-03 14:49:32 -07002233 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002234}
2235
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002236sub process {
2237 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002238
2239 my $linenr=0;
2240 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002241 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002242 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002243 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002244
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002245 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002246 my $indent;
2247 my $previndent=0;
2248 my $stashindent=0;
2249
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002250 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002251 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002252 my $author = '';
2253 my $authorsignoff = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002254 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002255 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002256 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002257 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002258 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002259 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002260 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002261 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002262 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002263 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002264 my $non_utf8_charset = 0;
2265
Joe Perches365dd4e2014-08-06 16:10:42 -07002266 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002267 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002268
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002269 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002270 our $cnt_lines = 0;
2271 our $cnt_error = 0;
2272 our $cnt_warn = 0;
2273 our $cnt_chk = 0;
2274
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002275 # Trace the real file/line as we go.
2276 my $realfile = '';
2277 my $realline = 0;
2278 my $realcnt = 0;
2279 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002280 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002281 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002282 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002283 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002284 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002285
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002286 my $prev_values = 'E';
2287
2288 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002289 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002290 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002291 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002292 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002293
Joe Perches7e51f192013-09-11 14:23:57 -07002294 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002295
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002296 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002297 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002298 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002299 my @setup_docs = ();
2300 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002301
Joe Perchesd8b07712013-11-12 15:10:06 -08002302 my $camelcase_file_seeded = 0;
2303
Rob Herring9f3a8992018-04-10 16:33:13 -07002304 my $checklicenseline = 1;
2305
Andy Whitcroft773647a2008-03-28 14:15:58 -07002306 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002307 my $line;
2308 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002309 $linenr++;
2310 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002311
Joe Perches3705ce52013-07-03 15:05:31 -07002312 push(@fixed, $rawline) if ($fix);
2313
Andy Whitcroft773647a2008-03-28 14:15:58 -07002314 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002315 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002316 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002317 $setup_docs = 1;
2318 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002319 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002320 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002321 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002322 $realline=$1-1;
2323 if (defined $2) {
2324 $realcnt=$3+1;
2325 } else {
2326 $realcnt=1+1;
2327 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002328 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002329
2330 # Guestimate if this is a continuing comment. Run
2331 # the context looking for a comment "edge". If this
2332 # edge is a close comment then we must be in a comment
2333 # at context start.
2334 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002335 my $cnt = $realcnt;
2336 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2337 next if (defined $rawlines[$ln - 1] &&
2338 $rawlines[$ln - 1] =~ /^-/);
2339 $cnt--;
2340 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002341 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002342 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2343 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2344 ($edge) = $1;
2345 last;
2346 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002347 }
2348 if (defined $edge && $edge eq '*/') {
2349 $in_comment = 1;
2350 }
2351
2352 # Guestimate if this is a continuing comment. If this
2353 # is the start of a diff block and this line starts
2354 # ' *' then it is very likely a comment.
2355 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002356 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002357 {
2358 $in_comment = 1;
2359 }
2360
2361 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2362 sanitise_line_reset($in_comment);
2363
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002364 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002365 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002366 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002367 $line = sanitise_line($rawline);
2368 }
2369 push(@lines, $line);
2370
2371 if ($realcnt > 1) {
2372 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2373 } else {
2374 $realcnt = 0;
2375 }
2376
2377 #print "==>$rawline\n";
2378 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002379
2380 if ($setup_docs && $line =~ /^\+/) {
2381 push(@setup_docs, $line);
2382 }
2383 }
2384
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002385 $prefix = '';
2386
Andy Whitcroft773647a2008-03-28 14:15:58 -07002387 $realcnt = 0;
2388 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002389 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002390 foreach my $line (@lines) {
2391 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002392 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002393 my $sline = $line; #copy of $line
2394 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002395
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002396 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002397
Joe Perches12c253a2018-06-07 17:10:58 -07002398# check if it's a mode change, rename or start of a patch
2399 if (!$in_commit_log &&
2400 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2401 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2402 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2403 $is_patch = 1;
2404 }
2405
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002406#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002407 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002408 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2409 my $context = $4;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002410 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002411 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002412 $realline=$1-1;
2413 if (defined $2) {
2414 $realcnt=$3+1;
2415 } else {
2416 $realcnt=1+1;
2417 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002418 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002419 $prev_values = 'E';
2420
Andy Whitcroft773647a2008-03-28 14:15:58 -07002421 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002422 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002423 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002424 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002425 if ($context =~ /\b(\w+)\s*\(/) {
2426 $context_function = $1;
2427 } else {
2428 undef $context_function;
2429 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002430 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002431
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002432# track the line number as we move through the hunk, note that
2433# new versions of GNU diff omit the leading space on completely
2434# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002435 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002436 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002437 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002438
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002439 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002440 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002441
2442 # Track the previous line.
2443 ($prevline, $stashline) = ($stashline, $line);
2444 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002445 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2446
Andy Whitcroft773647a2008-03-28 14:15:58 -07002447 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002448
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002449 } elsif ($realcnt == 1) {
2450 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002451 }
2452
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002453 my $hunk_line = ($realcnt != 0);
2454
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002455 $here = "#$linenr: " if (!$file);
2456 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002457
Joe Perches2ac73b42014-06-04 16:12:05 -07002458 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002459 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002460 if ($line =~ /^diff --git.*?(\S+)$/) {
2461 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002462 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002463 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002464 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002465 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002466 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002467 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002468 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002469
2470 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002471 if (!$file && $tree && $p1_prefix ne '' &&
2472 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002473 WARN("PATCH_PREFIX",
2474 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002475 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002476
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002477 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002478 ERROR("MODIFIED_INCLUDE_ASM",
2479 "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 -07002480 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002481 $found_file = 1;
2482 }
2483
Joe Perches34d88152015-06-25 15:03:05 -07002484#make up the handle for any error we report on this line
2485 if ($showfile) {
2486 $prefix = "$realfile:$realline: "
2487 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002488 if ($file) {
2489 $prefix = "$filename:$realline: ";
2490 } else {
2491 $prefix = "$filename:$linenr: ";
2492 }
Joe Perches34d88152015-06-25 15:03:05 -07002493 }
2494
Joe Perches2ac73b42014-06-04 16:12:05 -07002495 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002496 if (is_maintained_obsolete($realfile)) {
2497 WARN("OBSOLETE",
2498 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2499 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002500 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002501 $check = 1;
2502 } else {
2503 $check = $check_orig;
2504 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002505 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002506
2507 if ($realfile !~ /^MAINTAINERS/) {
2508 my $last_binding_patch = $is_binding_patch;
2509
2510 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2511
2512 if (($last_binding_patch != -1) &&
2513 ($last_binding_patch ^ $is_binding_patch)) {
2514 WARN("DT_SPLIT_BINDING_PATCH",
2515 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2516 }
2517 }
2518
Andy Whitcroft773647a2008-03-28 14:15:58 -07002519 next;
2520 }
2521
Randy Dunlap389834b2007-06-08 13:47:03 -07002522 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002523
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002524 my $hereline = "$here\n$rawline\n";
2525 my $herecurr = "$here\n$rawline\n";
2526 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002527
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002528 $cnt_lines++ if ($realcnt != 0);
2529
Joe Perches490b2922018-08-21 21:58:01 -07002530# Verify the existence of a commit log if appropriate
2531# 2 is used because a $signature is counted in $commit_log_lines
2532 if ($in_commit_log) {
2533 if ($line !~ /^\s*$/) {
2534 $commit_log_lines++; #could be a $signature
2535 }
2536 } elsif ($has_commit_log && $commit_log_lines < 2) {
2537 WARN("COMMIT_MESSAGE",
2538 "Missing commit description - Add an appropriate one\n");
2539 $commit_log_lines = 2; #warn only once
2540 }
2541
Joe Perchese518e9a2015-06-25 15:03:27 -07002542# Check if the commit log has what seems like a diff which can confuse patch
2543 if ($in_commit_log && !$commit_log_has_diff &&
2544 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2545 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2546 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2547 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2548 ERROR("DIFF_IN_COMMIT_MSG",
2549 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2550 $commit_log_has_diff = 1;
2551 }
2552
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002553# Check for incorrect file permissions
2554 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2555 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002556 if ($realfile !~ m@scripts/@ &&
2557 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002558 ERROR("EXECUTE_PERMISSIONS",
2559 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002560 }
2561 }
2562
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002563# Check the patch for a From:
2564 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2565 $author = $1;
2566 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2567 $author =~ s/"//g;
2568 }
2569
Joe Perches20112472011-07-25 17:13:23 -07002570# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002571 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002572 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002573 $in_commit_log = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002574 if ($author ne '') {
2575 my $l = $line;
2576 $l =~ s/"//g;
2577 if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
2578 $authorsignoff = 1;
2579 }
2580 }
Joe Perches20112472011-07-25 17:13:23 -07002581 }
2582
Joe Perchese0d975b2014-12-10 15:51:49 -08002583# Check if MAINTAINERS is being updated. If so, there's probably no need to
2584# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2585 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2586 $reported_maintainer_file = 1;
2587 }
2588
Joe Perches20112472011-07-25 17:13:23 -07002589# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002590 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002591 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002592 my $space_before = $1;
2593 my $sign_off = $2;
2594 my $space_after = $3;
2595 my $email = $4;
2596 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2597
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002598 if ($sign_off !~ /$signature_tags/) {
2599 WARN("BAD_SIGN_OFF",
2600 "Non-standard signature: $sign_off\n" . $herecurr);
2601 }
Joe Perches20112472011-07-25 17:13:23 -07002602 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002603 if (WARN("BAD_SIGN_OFF",
2604 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2605 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002606 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002607 "$ucfirst_sign_off $email";
2608 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002609 }
Joe Perches20112472011-07-25 17:13:23 -07002610 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002611 if (WARN("BAD_SIGN_OFF",
2612 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2613 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002614 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002615 "$ucfirst_sign_off $email";
2616 }
2617
Joe Perches20112472011-07-25 17:13:23 -07002618 }
2619 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002620 if (WARN("BAD_SIGN_OFF",
2621 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2622 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002623 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002624 "$ucfirst_sign_off $email";
2625 }
Joe Perches20112472011-07-25 17:13:23 -07002626 }
2627
2628 my ($email_name, $email_address, $comment) = parse_email($email);
2629 my $suggested_email = format_email(($email_name, $email_address));
2630 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002631 ERROR("BAD_SIGN_OFF",
2632 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002633 } else {
2634 my $dequoted = $suggested_email;
2635 $dequoted =~ s/^"//;
2636 $dequoted =~ s/" </ </;
2637 # Don't force email to have quotes
2638 # Allow just an angle bracketed address
2639 if ("$dequoted$comment" ne $email &&
2640 "<$email_address>$comment" ne $email &&
2641 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002642 WARN("BAD_SIGN_OFF",
2643 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002644 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002645 }
Joe Perches7e51f192013-09-11 14:23:57 -07002646
2647# Check for duplicate signatures
2648 my $sig_nospace = $line;
2649 $sig_nospace =~ s/\s//g;
2650 $sig_nospace = lc($sig_nospace);
2651 if (defined $signatures{$sig_nospace}) {
2652 WARN("BAD_SIGN_OFF",
2653 "Duplicate signature\n" . $herecurr);
2654 } else {
2655 $signatures{$sig_nospace} = 1;
2656 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002657 }
2658
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002659# Check email subject for common tools that don't need to be mentioned
2660 if ($in_header_lines &&
2661 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2662 WARN("EMAIL_SUBJECT",
2663 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2664 }
2665
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002666# Check for unwanted Gerrit info
2667 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2668 ERROR("GERRIT_CHANGE_ID",
2669 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2670 }
2671
Joe Perches369c8dd2015-11-06 16:31:34 -08002672# Check if the commit log is in a possible stack dump
2673 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2674 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2675 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2676 # timestamp
2677 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2678 # stack dump address
2679 $commit_log_possible_stack_dump = 1;
2680 }
2681
Joe Perches2a076f42015-04-16 12:44:28 -07002682# Check for line lengths > 75 in commit log, warn once
2683 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002684 length($line) > 75 &&
2685 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2686 # file delta changes
2687 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2688 # filename then :
2689 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2690 # A Fixes: or Link: line
2691 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002692 WARN("COMMIT_LOG_LONG_LINE",
2693 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2694 $commit_log_long_line = 1;
2695 }
2696
Joe Perchesbf4daf12015-09-09 15:37:50 -07002697# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002698 if ($in_commit_log && $commit_log_possible_stack_dump &&
2699 $line =~ /^\s*$/) {
2700 $commit_log_possible_stack_dump = 0;
2701 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002702
Joe Perches0d7835f2015-02-13 14:38:35 -08002703# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002704 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002705 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002706 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002707 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002708 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002709 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2710 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002711 my $init_char = "c";
2712 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002713 my $short = 1;
2714 my $long = 0;
2715 my $case = 1;
2716 my $space = 1;
2717 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002718 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002719 my $id = '0123456789ab';
2720 my $orig_desc = "commit description";
2721 my $description = "";
2722
Joe Perchesfe043ea2015-09-09 15:37:25 -07002723 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2724 $init_char = $1;
2725 $orig_commit = lc($2);
2726 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2727 $orig_commit = lc($1);
2728 }
2729
Joe Perches0d7835f2015-02-13 14:38:35 -08002730 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2731 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2732 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2733 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2734 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2735 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002736 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002737 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2738 defined $rawlines[$linenr] &&
2739 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2740 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002741 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002742 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2743 defined $rawlines[$linenr] &&
2744 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2745 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2746 $orig_desc = $1;
2747 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2748 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002749 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002750 }
2751
2752 ($id, $description) = git_commit_info($orig_commit,
2753 $id, $orig_desc);
2754
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002755 if (defined($id) &&
2756 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002757 ERROR("GIT_COMMIT_ID",
2758 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2759 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002760 }
2761
Joe Perches13f19372014-08-06 16:10:59 -07002762# Check for added, moved or deleted files
2763 if (!$reported_maintainer_file && !$in_commit_log &&
2764 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2765 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2766 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2767 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002768 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002769 $reported_maintainer_file = 1;
2770 WARN("FILE_PATH_CHANGES",
2771 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2772 }
2773
Andy Whitcroft00df3442007-06-08 13:47:06 -07002774# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002775 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002776 ERROR("CORRUPTED_PATCH",
2777 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002778 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002779 }
2780
2781# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2782 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002783 $rawline !~ m/^$UTF8*$/) {
2784 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2785
2786 my $blank = copy_spacing($rawline);
2787 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2788 my $hereptr = "$hereline$ptr\n";
2789
Joe Perches34d99212011-07-25 17:13:26 -07002790 CHK("INVALID_UTF8",
2791 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002792 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002793
Joe Perches15662b32011-10-31 17:13:12 -07002794# Check if it's the start of a commit log
2795# (not a header line and we haven't seen the patch filename)
2796 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002797 !($rawline =~ /^\s+(?:\S|$)/ ||
2798 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002799 $in_header_lines = 0;
2800 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002801 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002802 }
2803
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002804# Check if there is UTF-8 in a commit log when a mail header has explicitly
2805# declined it, i.e defined some charset where it is missing.
2806 if ($in_header_lines &&
2807 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2808 $1 !~ /utf-8/i) {
2809 $non_utf8_charset = 1;
2810 }
2811
2812 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002813 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002814 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002815 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2816 }
2817
Joe Perchesd6430f72016-12-12 16:46:28 -08002818# Check for absolute kernel paths in commit message
2819 if ($tree && $in_commit_log) {
2820 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2821 my $file = $1;
2822
2823 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2824 check_absolute_file($1, $herecurr)) {
2825 #
2826 } else {
2827 check_absolute_file($file, $herecurr);
2828 }
2829 }
2830 }
2831
Kees Cook66b47b42014-10-13 15:51:57 -07002832# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002833 if (defined($misspellings) &&
2834 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002835 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002836 my $typo = $1;
2837 my $typo_fix = $spelling_fix{lc($typo)};
2838 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2839 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002840 my $msg_level = \&WARN;
2841 $msg_level = \&CHK if ($file);
2842 if (&{$msg_level}("TYPO_SPELLING",
2843 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002844 $fix) {
2845 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2846 }
2847 }
2848 }
2849
Andy Whitcroft306708542008-10-15 22:02:28 -07002850# ignore non-hunk lines and lines being removed
2851 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002852
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002853#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002854 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002855 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002856 if (ERROR("DOS_LINE_ENDINGS",
2857 "DOS line endings\n" . $herevet) &&
2858 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002859 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002860 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002861 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2862 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002863 if (ERROR("TRAILING_WHITESPACE",
2864 "trailing whitespace\n" . $herevet) &&
2865 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002866 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002867 }
2868
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002869 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002870 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002871
Josh Triplett4783f892013-11-12 15:10:12 -08002872# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002873 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002874 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002875 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2876 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002877 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002878 my $msg_level = \&ERROR;
2879 $msg_level = \&CHK if ($file);
2880 &{$msg_level}("FSF_MAILING_ADDRESS",
2881 "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 -08002882 }
2883
Andi Kleen33549572010-05-24 14:33:29 -07002884# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002885# Only applies when adding the entry originally, after that we do not have
2886# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002887 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002888 # 'choice' is usually the last thing on the line (though
2889 # Kconfig supports named choices), so use a word boundary
2890 # (\b) rather than a whitespace character (\s)
2891 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002892 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002893 my $cnt = $realcnt;
2894 my $ln = $linenr + 1;
2895 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002896 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002897 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002898 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002899 $f = $lines[$ln - 1];
2900 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2901 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002902
2903 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002904 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002905
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002906 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002907 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002908 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2909 if ($lines[$ln - 1] =~ "---help---") {
2910 WARN("CONFIG_DESCRIPTION",
2911 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2912 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002913 $length = -1;
2914 }
2915
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002916 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002917 $f =~ s/#.*//;
2918 $f =~ s/^\s+//;
2919 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002920
2921 # This only checks context lines in the patch
2922 # and so hopefully shouldn't trigger false
2923 # positives, even though some of these are
2924 # common words in help texts
2925 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2926 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002927 $is_end = 1;
2928 last;
2929 }
Andi Kleen33549572010-05-24 14:33:29 -07002930 $length++;
2931 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002932 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2933 WARN("CONFIG_DESCRIPTION",
2934 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2935 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002936 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002937 }
2938
Joe Perches628f91a2017-07-10 15:52:07 -07002939# check for MAINTAINERS entries that don't have the right form
2940 if ($realfile =~ /^MAINTAINERS$/ &&
2941 $rawline =~ /^\+[A-Z]:/ &&
2942 $rawline !~ /^\+[A-Z]:\t\S/) {
2943 if (WARN("MAINTAINERS_STYLE",
2944 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2945 $fix) {
2946 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2947 }
2948 }
2949
Christoph Jaeger327953e2015-02-13 14:38:29 -08002950# discourage the use of boolean for type definition attributes of Kconfig options
2951 if ($realfile =~ /Kconfig/ &&
2952 $line =~ /^\+\s*\bboolean\b/) {
2953 WARN("CONFIG_TYPE_BOOLEAN",
2954 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2955 }
2956
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002957 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2958 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2959 my $flag = $1;
2960 my $replacement = {
2961 'EXTRA_AFLAGS' => 'asflags-y',
2962 'EXTRA_CFLAGS' => 'ccflags-y',
2963 'EXTRA_CPPFLAGS' => 'cppflags-y',
2964 'EXTRA_LDFLAGS' => 'ldflags-y',
2965 };
2966
2967 WARN("DEPRECATED_VARIABLE",
2968 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2969 }
2970
Rob Herringbff5da42014-01-23 15:54:51 -08002971# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002972 if (defined $root &&
2973 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2974 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2975
Rob Herringbff5da42014-01-23 15:54:51 -08002976 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2977
Florian Vaussardcc933192014-04-03 14:49:27 -07002978 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2979 my $vp_file = $dt_path . "vendor-prefixes.txt";
2980
Rob Herringbff5da42014-01-23 15:54:51 -08002981 foreach my $compat (@compats) {
2982 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002983 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2984 my $compat3 = $compat;
2985 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2986 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002987 if ( $? >> 8 ) {
2988 WARN("UNDOCUMENTED_DT_STRING",
2989 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2990 }
2991
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002992 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2993 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002994 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002995 if ( $? >> 8 ) {
2996 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002997 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002998 }
2999 }
3000 }
3001
Rob Herring9f3a8992018-04-10 16:33:13 -07003002# check for using SPDX license tag at beginning of files
3003 if ($realline == $checklicenseline) {
3004 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3005 $checklicenseline = 2;
3006 } elsif ($rawline =~ /^\+/) {
3007 my $comment = "";
3008 if ($realfile =~ /\.(h|s|S)$/) {
3009 $comment = '/*';
3010 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3011 $comment = '//';
3012 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
3013 $comment = '#';
3014 } elsif ($realfile =~ /\.rst$/) {
3015 $comment = '..';
3016 }
3017
3018 if ($comment !~ /^$/ &&
3019 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003020 WARN("SPDX_LICENSE_TAG",
3021 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3022 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3023 my $spdx_license = $1;
3024 if (!is_SPDX_License_valid($spdx_license)) {
3025 WARN("SPDX_LICENSE_TAG",
3026 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3027 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003028 }
3029 }
3030 }
3031
Andy Whitcroft5368df22008-10-15 22:02:27 -07003032# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003033 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07003034
Joe Perches47e0c882015-06-25 15:02:57 -07003035# line length limit (with some exclusions)
3036#
3037# There are a few types of lines that may extend beyond $max_line_length:
3038# logging functions like pr_info that end in a string
3039# lines with a single string
3040# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003041# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003042#
3043# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003044# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003045# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3046# LONG_LINE all other lines longer than $max_line_length
3047#
3048# if LONG_LINE is ignored, the other 2 types are also ignored
3049#
3050
Joe Perchesb4749e92015-07-17 16:24:01 -07003051 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003052 my $msg_type = "LONG_LINE";
3053
3054 # Check the allowed long line types first
3055
3056 # logging functions that end in a string that starts
3057 # before $max_line_length
3058 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3059 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3060 $msg_type = "";
3061
3062 # lines with only strings (w/ possible termination)
3063 # #defines with only strings
3064 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3065 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3066 $msg_type = "";
3067
Joe Perchescc147502017-11-17 15:28:44 -08003068 # More special cases
3069 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3070 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003071 $msg_type = "";
3072
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003073 # URL ($rawline is used in case the URL is in a comment)
3074 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3075 $msg_type = "";
3076
Joe Perches47e0c882015-06-25 15:02:57 -07003077 # Otherwise set the alternate message types
3078
3079 # a comment starts before $max_line_length
3080 } elsif ($line =~ /($;[\s$;]*)$/ &&
3081 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3082 $msg_type = "LONG_LINE_COMMENT"
3083
3084 # a quoted string starts before $max_line_length
3085 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3086 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3087 $msg_type = "LONG_LINE_STRING"
3088 }
3089
3090 if ($msg_type ne "" &&
3091 (show_type("LONG_LINE") || show_type($msg_type))) {
3092 WARN($msg_type,
3093 "line over $max_line_length characters\n" . $herecurr);
3094 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003095 }
3096
Andy Whitcroft8905a672007-11-28 16:21:06 -08003097# check for adding lines without a newline.
3098 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003099 WARN("MISSING_EOF_NEWLINE",
3100 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003101 }
3102
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003103# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003104 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003105
3106# at the beginning of a line any tabs must come first and anything
3107# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003108 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3109 $rawline =~ /^\+\s* \s*/) {
3110 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003111 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003112 if (ERROR("CODE_INDENT",
3113 "code indent should use tabs where possible\n" . $herevet) &&
3114 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003115 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003116 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003117 }
3118
Alberto Panizzo08e44362010-03-05 13:43:54 -08003119# check for space before tabs.
3120 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3121 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003122 if (WARN("SPACE_BEFORE_TAB",
3123 "please, no space before tabs\n" . $herevet) &&
3124 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003125 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003126 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003127 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003128 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003129 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003130 }
3131
Joe Perches6a487212018-04-10 16:34:04 -07003132# check for assignments on the start of a line
3133 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3134 CHK("ASSIGNMENT_CONTINUATIONS",
3135 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3136 }
3137
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003138# check for && or || at the start of a line
3139 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3140 CHK("LOGICAL_CONTINUATIONS",
3141 "Logical continuations should be on the previous line\n" . $hereprev);
3142 }
3143
Joe Perchesa91e8992016-05-20 17:04:05 -07003144# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003145 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003146 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003147 my $indent = length($1);
3148 if ($indent % 8) {
3149 if (WARN("TABSTOP",
3150 "Statements should start on a tabstop\n" . $herecurr) &&
3151 $fix) {
3152 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3153 }
3154 }
3155 }
3156
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003157# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003158 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003159 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003160 $prevline =~ /^\+(\t*)(.*)$/;
3161 my $oldindent = $1;
3162 my $rest = $2;
3163
3164 my $pos = pos_last_openparen($rest);
3165 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003166 $line =~ /^(\+| )([ \t]*)/;
3167 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003168
3169 my $goodtabindent = $oldindent .
3170 "\t" x ($pos / 8) .
3171 " " x ($pos % 8);
3172 my $goodspaceindent = $oldindent . " " x $pos;
3173
3174 if ($newindent ne $goodtabindent &&
3175 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003176
3177 if (CHK("PARENTHESIS_ALIGNMENT",
3178 "Alignment should match open parenthesis\n" . $hereprev) &&
3179 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003180 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003181 s/^\+[ \t]*/\+$goodtabindent/;
3182 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003183 }
3184 }
3185 }
3186
Joe Perches6ab3a972015-04-16 12:44:05 -07003187# check for space after cast like "(int) foo" or "(struct foo) bar"
3188# avoid checking a few false positives:
3189# "sizeof(<type>)" or "__alignof__(<type>)"
3190# function pointer declarations like "(*foo)(int) = bar;"
3191# structure definitions like "(struct foo) { 0 };"
3192# multiline macros that define functions
3193# known attributes or the __attribute__ keyword
3194 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3195 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003196 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003197 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003198 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003199 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003200 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003201 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003202 }
3203
Joe Perches86406b12015-09-09 15:37:41 -07003204# Block comment styles
3205# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003206 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003207 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003208 $rawline =~ /^\+[ \t]*\*/ &&
3209 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003210 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3211 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3212 }
3213
Joe Perches86406b12015-09-09 15:37:41 -07003214# Block comments use * on subsequent lines
3215 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3216 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003217 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003218 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003219 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003220 WARN("BLOCK_COMMENT_STYLE",
3221 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003222 }
3223
Joe Perches86406b12015-09-09 15:37:41 -07003224# Block comments use */ on trailing lines
3225 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003226 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3227 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3228 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003229 WARN("BLOCK_COMMENT_STYLE",
3230 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003231 }
3232
Joe Perches08eb9b82016-10-11 13:51:50 -07003233# Block comment * alignment
3234 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003235 $line =~ /^\+[ \t]*$;/ && #leading comment
3236 $rawline =~ /^\+[ \t]*\*/ && #leading *
3237 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003238 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003239 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3240 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003241 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003242 if (defined($1)) {
3243 $oldindent = expand_tabs($1);
3244 } else {
3245 $prevrawline =~ m@^\+(.*/?)\*@;
3246 $oldindent = expand_tabs($1);
3247 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003248 $rawline =~ m@^\+([ \t]*)\*@;
3249 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003250 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003251 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003252 WARN("BLOCK_COMMENT_STYLE",
3253 "Block comments should align the * on each line\n" . $hereprev);
3254 }
3255 }
3256
Joe Perches7f619192014-08-06 16:10:39 -07003257# check for missing blank lines after struct/union declarations
3258# with exceptions for various attributes and macros
3259 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3260 $line =~ /^\+/ &&
3261 !($line =~ /^\+\s*$/ ||
3262 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3263 $line =~ /^\+\s*MODULE_/i ||
3264 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3265 $line =~ /^\+[a-z_]*init/ ||
3266 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3267 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003268 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003269 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003270 if (CHK("LINE_SPACING",
3271 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3272 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003273 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003274 }
Joe Perches7f619192014-08-06 16:10:39 -07003275 }
3276
Joe Perches365dd4e2014-08-06 16:10:42 -07003277# check for multiple consecutive blank lines
3278 if ($prevline =~ /^[\+ ]\s*$/ &&
3279 $line =~ /^\+\s*$/ &&
3280 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003281 if (CHK("LINE_SPACING",
3282 "Please don't use multiple blank lines\n" . $hereprev) &&
3283 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003284 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003285 }
3286
Joe Perches365dd4e2014-08-06 16:10:42 -07003287 $last_blank_line = $linenr;
3288 }
3289
Joe Perches3b617e32014-04-03 14:49:28 -07003290# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003291 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3292 # actual declarations
3293 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003294 # function pointer declarations
3295 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003296 # foo bar; where foo is some local typedef or #define
3297 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3298 # known declaration macros
3299 $prevline =~ /^\+\s+$declaration_macros/) &&
3300 # for "else if" which can look like "$Ident $Ident"
3301 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3302 # other possible extensions of declaration lines
3303 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3304 # not starting a section or a macro "\" extended line
3305 $prevline =~ /(?:\{\s*|\\)$/) &&
3306 # looks like a declaration
3307 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003308 # function pointer declarations
3309 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003310 # foo bar; where foo is some local typedef or #define
3311 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3312 # known declaration macros
3313 $sline =~ /^\+\s+$declaration_macros/ ||
3314 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003315 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003316 # start or end of block or continuation of declaration
3317 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3318 # bitfield continuation
3319 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3320 # other possible extensions of declaration lines
3321 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3322 # indentation of previous and current line are the same
3323 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003324 if (WARN("LINE_SPACING",
3325 "Missing a blank line after declarations\n" . $hereprev) &&
3326 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003327 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003328 }
Joe Perches3b617e32014-04-03 14:49:28 -07003329 }
3330
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003331# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003332# Exceptions:
3333# 1) within comments
3334# 2) indented preprocessor commands
3335# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003336 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003337 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003338 if (WARN("LEADING_SPACE",
3339 "please, no spaces at the start of a line\n" . $herevet) &&
3340 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003341 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003342 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003343 }
3344
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003345# check we are in a valid C source file if not then ignore this hunk
3346 next if ($realfile !~ /\.(h|c)$/);
3347
Joe Perches5751a242017-11-17 15:28:52 -08003348# check for unusual line ending [ or (
3349 if ($line =~ /^\+.*([\[\(])\s*$/) {
3350 CHK("OPEN_ENDED_LINE",
3351 "Lines should not end with a '$1'\n" . $herecurr);
3352 }
3353
Joe Perches4dbed762017-05-08 15:55:39 -07003354# check if this appears to be the start function declaration, save the name
3355 if ($sline =~ /^\+\{\s*$/ &&
3356 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3357 $context_function = $1;
3358 }
3359
3360# check if this appears to be the end of function declaration
3361 if ($sline =~ /^\+\}\s*$/) {
3362 undef $context_function;
3363 }
3364
Joe Perches032a4c02014-08-06 16:10:29 -07003365# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003366# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003367# if the previous line is a break or return and is indented 1 tab more...
3368 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3369 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003370 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3371 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3372 defined $lines[$linenr] &&
3373 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003374 WARN("UNNECESSARY_ELSE",
3375 "else is not generally useful after a break or return\n" . $hereprev);
3376 }
3377 }
3378
Joe Perchesc00df192014-08-06 16:11:01 -07003379# check indentation of a line with a break;
3380# if the previous line is a goto or return and is indented the same # of tabs
3381 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3382 my $tabs = $1;
3383 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3384 WARN("UNNECESSARY_BREAK",
3385 "break is not useful after a goto or return\n" . $hereprev);
3386 }
3387 }
3388
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003389# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003390 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003391 WARN("CVS_KEYWORD",
3392 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003393 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003394
Joe Perches56e77d72013-02-21 16:44:14 -08003395# check for old HOTPLUG __dev<foo> section markings
3396 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3397 WARN("HOTPLUG_SECTION",
3398 "Using $1 is unnecessary\n" . $herecurr);
3399 }
3400
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003401# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003402 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3403 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003404#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003405 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003406 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003407 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003408 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003409 $stat =~ s/\n./\n /g;
3410 $cond =~ s/\n./\n /g;
3411
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003412#print "linenr<$linenr> <$stat>\n";
3413 # If this statement has no statement boundaries within
3414 # it there is no point in retrying a statement scan
3415 # until we hit end of it.
3416 my $frag = $stat; $frag =~ s/;+\s*$//;
3417 if ($frag !~ /(?:{|;)/) {
3418#print "skip<$line_nr_next>\n";
3419 $suppress_statement = $line_nr_next;
3420 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003421
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003422 # Find the real next line.
3423 $realline_next = $line_nr_next;
3424 if (defined $realline_next &&
3425 (!defined $lines[$realline_next - 1] ||
3426 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3427 $realline_next++;
3428 }
3429
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003430 my $s = $stat;
3431 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003432
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003433 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003434 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003435
3436 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003437 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003438
Andy Whitcroft463f2862009-09-21 17:04:34 -07003439 } elsif ($s =~ /^.\s*else\b/s) {
3440
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003441 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003442 } 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 -07003443 my $type = $1;
3444 $type =~ s/\s+/ /g;
3445 possible($type, "A:" . $s);
3446
Andy Whitcroft8905a672007-11-28 16:21:06 -08003447 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003448 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003449 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003450 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003451
3452 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003453 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003454 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003455 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003456
3457 # Check for any sort of function declaration.
3458 # int foo(something bar, other baz);
3459 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003460 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 -08003461 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003462
Andy Whitcroftcf655042008-03-04 14:28:20 -08003463 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003464 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003465 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003466
Andy Whitcroft8905a672007-11-28 16:21:06 -08003467 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003468 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003469
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003470 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003471 }
3472 }
3473 }
3474
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003475 }
3476
Andy Whitcroft653d4872007-06-23 17:16:34 -07003477#
3478# Checks which may be anchored in the context.
3479#
3480
3481# Check for switch () and associated case and default
3482# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003483 if ($line=~/\bswitch\s*\(.*\)/) {
3484 my $err = '';
3485 my $sep = '';
3486 my @ctx = ctx_block_outer($linenr, $realcnt);
3487 shift(@ctx);
3488 for my $ctx (@ctx) {
3489 my ($clen, $cindent) = line_stats($ctx);
3490 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3491 $indent != $cindent) {
3492 $err .= "$sep$ctx\n";
3493 $sep = '';
3494 } else {
3495 $sep = "[...]\n";
3496 }
3497 }
3498 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003499 ERROR("SWITCH_CASE_INDENT_LEVEL",
3500 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003501 }
3502 }
3503
3504# if/while/etc brace do not go on next line, unless defining a do while loop,
3505# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003506 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 -07003507 my $pre_ctx = "$1$2";
3508
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003509 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003510
3511 if ($line =~ /^\+\t{6,}/) {
3512 WARN("DEEP_INDENTATION",
3513 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3514 }
3515
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003516 my $ctx_cnt = $realcnt - $#ctx - 1;
3517 my $ctx = join("\n", @ctx);
3518
Andy Whitcroft548596d2008-07-23 21:29:01 -07003519 my $ctx_ln = $linenr;
3520 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003521
Andy Whitcroft548596d2008-07-23 21:29:01 -07003522 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3523 defined $lines[$ctx_ln - 1] &&
3524 $lines[$ctx_ln - 1] =~ /^-/)) {
3525 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3526 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003527 $ctx_ln++;
3528 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003529
Andy Whitcroft53210162008-07-23 21:29:03 -07003530 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3531 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003532
Joe Perchesd752fcc2014-08-06 16:11:05 -07003533 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003534 ERROR("OPEN_BRACE",
3535 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003536 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003537 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003538 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3539 $ctx =~ /\)\s*\;\s*$/ &&
3540 defined $lines[$ctx_ln - 1])
3541 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003542 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3543 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003544 WARN("TRAILING_SEMICOLON",
3545 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003546 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003547 }
3548 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003549 }
3550
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003551# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003552 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003553 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3554 ctx_statement_block($linenr, $realcnt, 0)
3555 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003556 my ($s, $c) = ($stat, $cond);
3557
3558 substr($s, 0, length($c), '');
3559
Joe Perches9f5af482015-09-09 15:37:30 -07003560 # remove inline comments
3561 $s =~ s/$;/ /g;
3562 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003563
3564 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003565 my @newlines = ($c =~ /\n/gs);
3566 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003567
Joe Perches9f5af482015-09-09 15:37:30 -07003568 # Make sure we remove the line prefixes as we have
3569 # none on the first line, and are going to readd them
3570 # where necessary.
3571 $s =~ s/\n./\n/gs;
3572 while ($s =~ /\n\s+\\\n/) {
3573 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3574 }
3575
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003576 # We want to check the first line inside the block
3577 # starting at the end of the conditional, so remove:
3578 # 1) any blank line termination
3579 # 2) any opening brace { on end of the line
3580 # 3) any do (...) {
3581 my $continuation = 0;
3582 my $check = 0;
3583 $s =~ s/^.*\bdo\b//;
3584 $s =~ s/^\s*{//;
3585 if ($s =~ s/^\s*\\//) {
3586 $continuation = 1;
3587 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003588 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003589 $check = 1;
3590 $cond_lines++;
3591 }
3592
3593 # Also ignore a loop construct at the end of a
3594 # preprocessor statement.
3595 if (($prevline =~ /^.\s*#\s*define\s/ ||
3596 $prevline =~ /\\\s*$/) && $continuation == 0) {
3597 $check = 0;
3598 }
3599
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003600 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003601 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003602 while ($cond_ptr != $cond_lines) {
3603 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003604
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003605 # If we see an #else/#elif then the code
3606 # is not linear.
3607 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3608 $check = 0;
3609 }
3610
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003611 # Ignore:
3612 # 1) blank lines, they should be at 0,
3613 # 2) preprocessor lines, and
3614 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003615 if ($continuation ||
3616 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003617 $s =~ /^\s*#\s*?/ ||
3618 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003619 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003620 if ($s =~ s/^.*?\n//) {
3621 $cond_lines++;
3622 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003623 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003624 }
3625
3626 my (undef, $sindent) = line_stats("+" . $s);
3627 my $stat_real = raw_line($linenr, $cond_lines);
3628
3629 # Check if either of these lines are modified, else
3630 # this is not this patch's fault.
3631 if (!defined($stat_real) ||
3632 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3633 $check = 0;
3634 }
3635 if (defined($stat_real) && $cond_lines > 1) {
3636 $stat_real = "[...]\n$stat_real";
3637 }
3638
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003639 #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 -07003640
Joe Perches9f5af482015-09-09 15:37:30 -07003641 if ($check && $s ne '' &&
3642 (($sindent % 8) != 0 ||
3643 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003644 ($sindent == $indent &&
3645 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003646 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003647 WARN("SUSPECT_CODE_INDENT",
3648 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003649 }
3650 }
3651
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003652 # Track the 'values' across context and added lines.
3653 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003654 my ($curr_values, $curr_vars) =
3655 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003656 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003657 if ($dbg_values) {
3658 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003659 print "$linenr > .$outline\n";
3660 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003661 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003662 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003663 $prev_values = substr($curr_values, -1);
3664
Andy Whitcroft00df3442007-06-08 13:47:06 -07003665#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003666 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003667
Joe Perches11ca40a2016-12-12 16:46:31 -08003668# check for dereferences that span multiple lines
3669 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3670 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3671 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3672 my $ref = $1;
3673 $line =~ /^.\s*($Lval)/;
3674 $ref .= $1;
3675 $ref =~ s/\s//g;
3676 WARN("MULTILINE_DEREFERENCE",
3677 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3678 }
3679
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003680# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003681 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003682 my $type = $1;
3683 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003684 $var = "" if (!defined $var);
3685 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003686 my $sign = $1;
3687 my $pointer = $2;
3688
3689 $pointer = "" if (!defined $pointer);
3690
3691 if (WARN("UNSPECIFIED_INT",
3692 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3693 $fix) {
3694 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003695 my $comp_pointer = $pointer;
3696 $comp_pointer =~ s/\s//g;
3697 $decl .= $comp_pointer;
3698 $decl = rtrim($decl) if ($var eq "");
3699 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003700 }
3701 }
3702 }
3703
Andy Whitcroft653d4872007-06-23 17:16:34 -07003704# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003705 if ($dbg_type) {
3706 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003707 ERROR("TEST_TYPE",
3708 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003709 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003710 ERROR("TEST_NOT_TYPE",
3711 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003712 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003713 next;
3714 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003715# TEST: allow direct testing of the attribute matcher.
3716 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003717 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003718 ERROR("TEST_ATTR",
3719 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003720 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003721 ERROR("TEST_NOT_ATTR",
3722 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003723 }
3724 next;
3725 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003726
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003727# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003728 if ($line =~ /^.\s*{/ &&
3729 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003730 if (ERROR("OPEN_BRACE",
3731 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003732 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3733 fix_delete_line($fixlinenr - 1, $prevrawline);
3734 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003735 my $fixedline = $prevrawline;
3736 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003737 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003738 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003739 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003740 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003741 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003742 }
3743
Andy Whitcroft653d4872007-06-23 17:16:34 -07003744#
3745# Checks which are anchored on the added line.
3746#
3747
3748# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003749 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003750 my $path = $1;
3751 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003752 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003753 "malformed #include filename\n" . $herecurr);
3754 }
3755 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3756 ERROR("UAPI_INCLUDE",
3757 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003758 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003759 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003760
3761# no C99 // comments
3762 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003763 if (ERROR("C99_COMMENTS",
3764 "do not use C99 // comments\n" . $herecurr) &&
3765 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003766 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003767 if ($line =~ /\/\/(.*)$/) {
3768 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003769 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003770 }
3771 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003772 }
3773 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003774 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003775 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003776
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003777# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3778# the whole statement.
3779#print "APW <$lines[$realline_next - 1]>\n";
3780 if (defined $realline_next &&
3781 exists $lines[$realline_next - 1] &&
3782 !defined $suppress_export{$realline_next} &&
3783 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3784 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003785 # Handle definitions which produce identifiers with
3786 # a prefix:
3787 # XXX(foo);
3788 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003789 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003790 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003791 $name =~ /^${Ident}_$2/) {
3792#print "FOO C name<$name>\n";
3793 $suppress_export{$realline_next} = 1;
3794
3795 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003796 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003797 ^.DEFINE_$Ident\(\Q$name\E\)|
3798 ^.DECLARE_$Ident\(\Q$name\E\)|
3799 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003800 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3801 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003802 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003803#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3804 $suppress_export{$realline_next} = 2;
3805 } else {
3806 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003807 }
3808 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003809 if (!defined $suppress_export{$linenr} &&
3810 $prevline =~ /^.\s*$/ &&
3811 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3812 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3813#print "FOO B <$lines[$linenr - 1]>\n";
3814 $suppress_export{$linenr} = 2;
3815 }
3816 if (defined $suppress_export{$linenr} &&
3817 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003818 WARN("EXPORT_SYMBOL",
3819 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003820 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003821
Joe Eloff5150bda2010-08-09 17:21:00 -07003822# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003823 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003824 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003825 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003826 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003827 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003828 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003829 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003830# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003831 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003832 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003833 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003834 $herecurr) &&
3835 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003836 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003837 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003838 }
3839
Joe Perches18130872014-08-06 16:11:22 -07003840# check for misordered declarations of char/short/int/long with signed/unsigned
3841 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3842 my $tmp = trim($1);
3843 WARN("MISORDERED_TYPE",
3844 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3845 }
3846
Joe Perches809e0822018-08-21 21:58:12 -07003847# check for unnecessary <signed> int declarations of short/long/long long
3848 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
3849 my $type = trim($1);
3850 next if ($type !~ /\bint\b/);
3851 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
3852 my $new_type = $type;
3853 $new_type =~ s/\b\s*int\s*\b/ /;
3854 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
3855 $new_type =~ s/^const\s+//;
3856 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
3857 $new_type = "const $new_type" if ($type =~ /^const\b/);
3858 $new_type =~ s/\s+/ /g;
3859 $new_type = trim($new_type);
3860 if (WARN("UNNECESSARY_INT",
3861 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
3862 $fix) {
3863 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
3864 }
3865 }
3866
Joe Perchescb710ec2010-10-26 14:23:20 -07003867# check for static const char * arrays.
3868 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003869 WARN("STATIC_CONST_CHAR_ARRAY",
3870 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003871 $herecurr);
3872 }
3873
3874# check for static char foo[] = "bar" declarations.
3875 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003876 WARN("STATIC_CONST_CHAR_ARRAY",
3877 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003878 $herecurr);
3879 }
3880
Joe Perchesab7e23f2015-04-16 12:44:22 -07003881# check for const <foo> const where <foo> is not a pointer or array type
3882 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3883 my $found = $1;
3884 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3885 WARN("CONST_CONST",
3886 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3887 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3888 WARN("CONST_CONST",
3889 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3890 }
3891 }
3892
Joe Perches9b0fa602014-04-03 14:49:18 -07003893# check for non-global char *foo[] = {"bar", ...} declarations.
3894 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3895 WARN("STATIC_CONST_CHAR_ARRAY",
3896 "char * array declaration might be better as static const\n" .
3897 $herecurr);
3898 }
3899
Joe Perchesb598b672015-04-16 12:44:36 -07003900# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3901 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3902 my $array = $1;
3903 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3904 my $array_div = $1;
3905 if (WARN("ARRAY_SIZE",
3906 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3907 $fix) {
3908 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3909 }
3910 }
3911 }
3912
Joe Perchesb36190c2014-01-27 17:07:18 -08003913# check for function declarations without arguments like "int foo()"
3914 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3915 if (ERROR("FUNCTION_WITHOUT_ARGS",
3916 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3917 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003918 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003919 }
3920 }
3921
Andy Whitcroft653d4872007-06-23 17:16:34 -07003922# check for new typedefs, only function parameters and sparse annotations
3923# make sense.
3924 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003925 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003926 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003927 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003928 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003929 WARN("NEW_TYPEDEFS",
3930 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003931 }
3932
3933# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003934 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003935 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3936 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003937 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003938
Andy Whitcroft65863862009-01-06 14:41:21 -08003939 # Should start with a space.
3940 $to =~ s/^(\S)/ $1/;
3941 # Should not end with a space.
3942 $to =~ s/\s+$//;
3943 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003944 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003945 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003946
Joe Perches3705ce52013-07-03 15:05:31 -07003947## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003948 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003949 if (ERROR("POINTER_LOCATION",
3950 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3951 $fix) {
3952 my $sub_from = $ident;
3953 my $sub_to = $ident;
3954 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003955 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003956 s@\Q$sub_from\E@$sub_to@;
3957 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003958 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003959 }
3960 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3961 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003962 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003963
Andy Whitcroft65863862009-01-06 14:41:21 -08003964 # Should start with a space.
3965 $to =~ s/^(\S)/ $1/;
3966 # Should not end with a space.
3967 $to =~ s/\s+$//;
3968 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003969 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003970 }
3971 # Modifiers should have spaces.
3972 $to =~ s/(\b$Modifier$)/$1 /;
3973
Joe Perches3705ce52013-07-03 15:05:31 -07003974## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003975 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003976 if (ERROR("POINTER_LOCATION",
3977 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3978 $fix) {
3979
3980 my $sub_from = $match;
3981 my $sub_to = $match;
3982 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003983 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003984 s@\Q$sub_from\E@$sub_to@;
3985 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003986 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003987 }
3988
Joe Perches9d3e3c72015-09-09 15:37:27 -07003989# avoid BUG() or BUG_ON()
3990 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003991 my $msg_level = \&WARN;
3992 $msg_level = \&CHK if ($file);
3993 &{$msg_level}("AVOID_BUG",
3994 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
Joe Perches9d3e3c72015-09-09 15:37:27 -07003995 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003996
Joe Perches9d3e3c72015-09-09 15:37:27 -07003997# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003998 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003999 WARN("LINUX_VERSION_CODE",
4000 "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 -08004001 }
4002
Joe Perches17441222011-06-15 15:08:17 -07004003# check for uses of printk_ratelimit
4004 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004005 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004006 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004007 }
4008
Joe Percheseeef5732017-11-17 15:28:41 -08004009# printk should use KERN_* levels
4010 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4011 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4012 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004013 }
4014
Joe Perches243f3802012-05-31 16:26:09 -07004015 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4016 my $orig = $1;
4017 my $level = lc($orig);
4018 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004019 my $level2 = $level;
4020 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004021 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004022 "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 -07004023 }
4024
4025 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004026 if (WARN("PREFER_PR_LEVEL",
4027 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
4028 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004029 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004030 s/\bpr_warning\b/pr_warn/;
4031 }
Joe Perches243f3802012-05-31 16:26:09 -07004032 }
4033
Joe Perchesdc139312013-02-21 16:44:13 -08004034 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4035 my $orig = $1;
4036 my $level = lc($orig);
4037 $level = "warn" if ($level eq "warning");
4038 $level = "dbg" if ($level eq "debug");
4039 WARN("PREFER_DEV_LEVEL",
4040 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4041 }
4042
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004043# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4044# number of false positives, but assembly files are not checked, so at
4045# least the arch entry code will not trigger this warning.
4046 if ($line =~ /\bENOSYS\b/) {
4047 WARN("ENOSYS",
4048 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4049 }
4050
Andy Whitcroft653d4872007-06-23 17:16:34 -07004051# function brace can't be on same line, except for #defines of do while,
4052# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004053 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004054 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4055 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4056 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004057 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004058 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004059 $fix) {
4060 fix_delete_line($fixlinenr, $rawline);
4061 my $fixed_line = $rawline;
4062 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4063 my $line1 = $1;
4064 my $line2 = $2;
4065 fix_insert_line($fixlinenr, ltrim($line1));
4066 fix_insert_line($fixlinenr, "\+{");
4067 if ($line2 !~ /^\s*$/) {
4068 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4069 }
4070 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004071 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004072
Andy Whitcroft8905a672007-11-28 16:21:06 -08004073# open braces for enum, union and struct go on the same line.
4074 if ($line =~ /^.\s*{/ &&
4075 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004076 if (ERROR("OPEN_BRACE",
4077 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4078 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4079 fix_delete_line($fixlinenr - 1, $prevrawline);
4080 fix_delete_line($fixlinenr, $rawline);
4081 my $fixedline = rtrim($prevrawline) . " {";
4082 fix_insert_line($fixlinenr, $fixedline);
4083 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004084 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004085 if ($fixedline !~ /^\+\s*$/) {
4086 fix_insert_line($fixlinenr, $fixedline);
4087 }
4088 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004089 }
4090
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004091# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004092 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4093 if (WARN("SPACING",
4094 "missing space after $1 definition\n" . $herecurr) &&
4095 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004096 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004097 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4098 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004099 }
4100
Joe Perches31070b52014-01-23 15:54:49 -08004101# Function pointer declarations
4102# check spacing between type, funcptr, and args
4103# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004104 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004105 my $declare = $1;
4106 my $pre_pointer_space = $2;
4107 my $post_pointer_space = $3;
4108 my $funcname = $4;
4109 my $post_funcname_space = $5;
4110 my $pre_args_space = $6;
4111
Joe Perches91f72e92014-04-03 14:49:12 -07004112# the $Declare variable will capture all spaces after the type
4113# so check it for a missing trailing missing space but pointer return types
4114# don't need a space so don't warn for those.
4115 my $post_declare_space = "";
4116 if ($declare =~ /(\s+)$/) {
4117 $post_declare_space = $1;
4118 $declare = rtrim($declare);
4119 }
4120 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004121 WARN("SPACING",
4122 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004123 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004124 }
4125
4126# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004127# This test is not currently implemented because these declarations are
4128# equivalent to
4129# int foo(int bar, ...)
4130# and this is form shouldn't/doesn't generate a checkpatch warning.
4131#
4132# elsif ($declare =~ /\s{2,}$/) {
4133# WARN("SPACING",
4134# "Multiple spaces after return type\n" . $herecurr);
4135# }
Joe Perches31070b52014-01-23 15:54:49 -08004136
4137# unnecessary space "type ( *funcptr)(args...)"
4138 if (defined $pre_pointer_space &&
4139 $pre_pointer_space =~ /^\s/) {
4140 WARN("SPACING",
4141 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4142 }
4143
4144# unnecessary space "type (* funcptr)(args...)"
4145 if (defined $post_pointer_space &&
4146 $post_pointer_space =~ /^\s/) {
4147 WARN("SPACING",
4148 "Unnecessary space before function pointer name\n" . $herecurr);
4149 }
4150
4151# unnecessary space "type (*funcptr )(args...)"
4152 if (defined $post_funcname_space &&
4153 $post_funcname_space =~ /^\s/) {
4154 WARN("SPACING",
4155 "Unnecessary space after function pointer name\n" . $herecurr);
4156 }
4157
4158# unnecessary space "type (*funcptr) (args...)"
4159 if (defined $pre_args_space &&
4160 $pre_args_space =~ /^\s/) {
4161 WARN("SPACING",
4162 "Unnecessary space before function pointer arguments\n" . $herecurr);
4163 }
4164
4165 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004166 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004167 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004168 }
4169 }
4170
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004171# check for spacing round square brackets; allowed:
4172# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004173# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4174# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004175 while ($line =~ /(.*?\s)\[/g) {
4176 my ($where, $prefix) = ($-[1], $1);
4177 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004178 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004179 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004180 if (ERROR("BRACKET_SPACE",
4181 "space prohibited before open square bracket '['\n" . $herecurr) &&
4182 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004183 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004184 s/^(\+.*?)\s+\[/$1\[/;
4185 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004186 }
4187 }
4188
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004189# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004190 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004191 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004192 my $ctx_before = substr($line, 0, $-[1]);
4193 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004194
4195 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004196 if ($name =~ /^(?:
4197 if|for|while|switch|return|case|
4198 volatile|__volatile__|
4199 __attribute__|format|__extension__|
4200 asm|__asm__)$/x)
4201 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004202 # cpp #define statements have non-optional spaces, ie
4203 # if there is a space between the name and the open
4204 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004205 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004206
4207 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004208 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004209
4210 # If this whole things ends with a type its most
4211 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004212 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004213
4214 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004215 if (WARN("SPACING",
4216 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4217 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004218 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004219 s/\b$name\s+\(/$name\(/;
4220 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004221 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004222 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004223
Andy Whitcroft653d4872007-06-23 17:16:34 -07004224# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004225 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004226 my $fixed_line = "";
4227 my $line_fixed = 0;
4228
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004229 my $ops = qr{
4230 <<=|>>=|<=|>=|==|!=|
4231 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4232 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004233 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004234 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004235 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004236 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004237
4238## print("element count: <" . $#elements . ">\n");
4239## foreach my $el (@elements) {
4240## print("el: <$el>\n");
4241## }
4242
4243 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004244 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004245
Joe Perches3705ce52013-07-03 15:05:31 -07004246 foreach my $el (@elements) {
4247 push(@fix_elements, substr($rawline, $off, length($el)));
4248 $off += length($el);
4249 }
4250
4251 $off = 0;
4252
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004253 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004254 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004255
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004256 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004257
4258 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4259
4260## print("n: <$n> good: <$good>\n");
4261
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004262 $off += length($elements[$n]);
4263
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004264 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004265 my $ca = substr($opline, 0, $off);
4266 my $cc = '';
4267 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4268 $cc = substr($opline, $off + length($elements[$n + 1]));
4269 }
4270 my $cb = "$ca$;$cc";
4271
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004272 my $a = '';
4273 $a = 'V' if ($elements[$n] ne '');
4274 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004275 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004276 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4277 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004278 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004279
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004280 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004281
4282 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004283 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004284 $c = 'V' if ($elements[$n + 2] ne '');
4285 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004286 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004287 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4288 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004289 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004290 } else {
4291 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004292 }
4293
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004294 my $ctx = "${a}x${c}";
4295
4296 my $at = "(ctx:$ctx)";
4297
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004298 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004299 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004300
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004301 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004302 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004303
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004304 # Get the full operator variant.
4305 my $opv = $op . substr($curr_vars, $off, 1);
4306
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004307 # Ignore operators passed as parameters.
4308 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004309 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004310
Andy Whitcroftcf655042008-03-04 14:28:20 -08004311# # Ignore comments
4312# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004313
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004314 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004315 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004316 if ($ctx !~ /.x[WEBC]/ &&
4317 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004318 if (ERROR("SPACING",
4319 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004320 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004321 $line_fixed = 1;
4322 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004323 }
4324
4325 # // is a comment
4326 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004327
Joe Perchesb00e4812014-04-03 14:49:33 -07004328 # : when part of a bitfield
4329 } elsif ($opv eq ':B') {
4330 # skip the bitfield test for now
4331
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004332 # No spaces for:
4333 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004334 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004335 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004336 if (ERROR("SPACING",
4337 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004338 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004339 if (defined $fix_elements[$n + 2]) {
4340 $fix_elements[$n + 2] =~ s/^\s+//;
4341 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004342 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004343 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004344 }
4345
Joe Perches23810972014-12-10 15:51:32 -08004346 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004347 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004348 my $rtrim_before = 0;
4349 my $space_after = 0;
4350 if ($ctx =~ /Wx./) {
4351 if (ERROR("SPACING",
4352 "space prohibited before that '$op' $at\n" . $hereptr)) {
4353 $line_fixed = 1;
4354 $rtrim_before = 1;
4355 }
4356 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004357 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004358 if (ERROR("SPACING",
4359 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004360 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004361 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004362 $space_after = 1;
4363 }
4364 }
4365 if ($rtrim_before || $space_after) {
4366 if ($rtrim_before) {
4367 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4368 } else {
4369 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4370 }
4371 if ($space_after) {
4372 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004373 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004374 }
4375
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004376 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004377 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004378 #warn "'*' is part of type\n";
4379
4380 # unary operators should have a space before and
4381 # none after. May be left adjacent to another
4382 # unary operator, or a cast
4383 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004384 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004385 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004386 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004387 if (ERROR("SPACING",
4388 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004389 if ($n != $last_after + 2) {
4390 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4391 $line_fixed = 1;
4392 }
Joe Perches3705ce52013-07-03 15:05:31 -07004393 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004394 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004395 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004396 # A unary '*' may be const
4397
4398 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004399 if (ERROR("SPACING",
4400 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004401 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004402 if (defined $fix_elements[$n + 2]) {
4403 $fix_elements[$n + 2] =~ s/^\s+//;
4404 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004405 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004406 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004407 }
4408
4409 # unary ++ and unary -- are allowed no space on one side.
4410 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004411 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004412 if (ERROR("SPACING",
4413 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004414 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004415 $line_fixed = 1;
4416 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004417 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004418 if ($ctx =~ /Wx[BE]/ ||
4419 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004420 if (ERROR("SPACING",
4421 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004422 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004423 $line_fixed = 1;
4424 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004425 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004426 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004427 if (ERROR("SPACING",
4428 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004429 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004430 if (defined $fix_elements[$n + 2]) {
4431 $fix_elements[$n + 2] =~ s/^\s+//;
4432 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004433 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004434 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004435 }
4436
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004437 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004438 } elsif ($op eq '<<' or $op eq '>>' or
4439 $op eq '&' or $op eq '^' or $op eq '|' or
4440 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004441 $op eq '*' or $op eq '/' or
4442 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004443 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004444 if ($check) {
4445 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4446 if (CHK("SPACING",
4447 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4448 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4449 $fix_elements[$n + 2] =~ s/^\s+//;
4450 $line_fixed = 1;
4451 }
4452 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4453 if (CHK("SPACING",
4454 "space preferred before that '$op' $at\n" . $hereptr)) {
4455 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4456 $line_fixed = 1;
4457 }
4458 }
4459 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004460 if (ERROR("SPACING",
4461 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004462 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4463 if (defined $fix_elements[$n + 2]) {
4464 $fix_elements[$n + 2] =~ s/^\s+//;
4465 }
Joe Perches3705ce52013-07-03 15:05:31 -07004466 $line_fixed = 1;
4467 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004468 }
4469
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004470 # A colon needs no spaces before when it is
4471 # terminating a case value or a label.
4472 } elsif ($opv eq ':C' || $opv eq ':L') {
4473 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004474 if (ERROR("SPACING",
4475 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004476 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004477 $line_fixed = 1;
4478 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004479 }
4480
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004481 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004482 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004483 my $ok = 0;
4484
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004485 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004486 if (($op eq '<' &&
4487 $cc =~ /^\S+\@\S+>/) ||
4488 ($op eq '>' &&
4489 $ca =~ /<\S+\@\S+$/))
4490 {
4491 $ok = 1;
4492 }
4493
Joe Perchese0df7e12015-04-16 12:44:53 -07004494 # for asm volatile statements
4495 # ignore a colon with another
4496 # colon immediately before or after
4497 if (($op eq ':') &&
4498 ($ca =~ /:$/ || $cc =~ /^:/)) {
4499 $ok = 1;
4500 }
4501
Joe Perches84731622013-11-12 15:10:05 -08004502 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004503 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004504 my $msg_level = \&ERROR;
4505 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004506
Jean Delvare0675a8f2017-09-08 16:16:07 -07004507 if (&{$msg_level}("SPACING",
4508 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004509 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4510 if (defined $fix_elements[$n + 2]) {
4511 $fix_elements[$n + 2] =~ s/^\s+//;
4512 }
Joe Perches3705ce52013-07-03 15:05:31 -07004513 $line_fixed = 1;
4514 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004515 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004516 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004517 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004518
4519## print("n: <$n> GOOD: <$good>\n");
4520
4521 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004522 }
Joe Perches3705ce52013-07-03 15:05:31 -07004523
4524 if (($#elements % 2) == 0) {
4525 $fixed_line = $fixed_line . $fix_elements[$#elements];
4526 }
4527
Joe Perches194f66f2014-08-06 16:11:03 -07004528 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4529 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004530 }
4531
4532
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004533 }
4534
Joe Perches786b6322013-07-03 15:05:32 -07004535# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004536 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004537 if (WARN("SPACING",
4538 "space prohibited before semicolon\n" . $herecurr) &&
4539 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004540 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004541 s/^(\+.*\S)\s+;/$1;/;
4542 }
4543 }
4544
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004545# check for multiple assignments
4546 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004547 CHK("MULTIPLE_ASSIGNMENTS",
4548 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004549 }
4550
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004551## # check for multiple declarations, allowing for a function declaration
4552## # continuation.
4553## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4554## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4555##
4556## # Remove any bracketed sections to ensure we do not
4557## # falsly report the parameters of functions.
4558## my $ln = $line;
4559## while ($ln =~ s/\([^\(\)]*\)//g) {
4560## }
4561## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004562## WARN("MULTIPLE_DECLARATION",
4563## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004564## }
4565## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004566
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004567#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004568 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004569 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004570 if (ERROR("SPACING",
4571 "space required before the open brace '{'\n" . $herecurr) &&
4572 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004573 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004574 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004575 }
4576
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004577## # check for blank lines before declarations
4578## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4579## $prevrawline =~ /^.\s*$/) {
4580## WARN("SPACING",
4581## "No blank lines before declarations\n" . $hereprev);
4582## }
4583##
4584
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004585# closing brace should have a space following it when it has anything
4586# on the line
4587 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004588 if (ERROR("SPACING",
4589 "space required after that close brace '}'\n" . $herecurr) &&
4590 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004591 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004592 s/}((?!(?:,|;|\)))\S)/} $1/;
4593 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004594 }
4595
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004596# check spacing on square brackets
4597 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004598 if (ERROR("SPACING",
4599 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4600 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004601 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004602 s/\[\s+/\[/;
4603 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004604 }
4605 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004606 if (ERROR("SPACING",
4607 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4608 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004609 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004610 s/\s+\]/\]/;
4611 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004612 }
4613
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004614# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004615 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4616 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004617 if (ERROR("SPACING",
4618 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4619 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004620 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004621 s/\(\s+/\(/;
4622 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004623 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004624 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004625 $line !~ /for\s*\(.*;\s+\)/ &&
4626 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004627 if (ERROR("SPACING",
4628 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4629 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004630 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004631 s/\s+\)/\)/;
4632 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004633 }
4634
Joe Perchese2826fd2014-08-06 16:10:48 -07004635# check unnecessary parentheses around addressof/dereference single $Lvals
4636# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4637
4638 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004639 my $var = $1;
4640 if (CHK("UNNECESSARY_PARENTHESES",
4641 "Unnecessary parentheses around $var\n" . $herecurr) &&
4642 $fix) {
4643 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4644 }
4645 }
4646
4647# check for unnecessary parentheses around function pointer uses
4648# ie: (foo->bar)(); should be foo->bar();
4649# but not "if (foo->bar) (" to avoid some false positives
4650 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4651 my $var = $2;
4652 if (CHK("UNNECESSARY_PARENTHESES",
4653 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4654 $fix) {
4655 my $var2 = deparenthesize($var);
4656 $var2 =~ s/\s//g;
4657 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4658 }
4659 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004660
Joe Perches63b7c732017-09-08 16:16:01 -07004661# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004662# when !drivers/staging or command-line uses --strict
4663 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07004664 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004665 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4666 my $if_stat = $1;
4667 my $test = substr($2, 1, -1);
4668 my $herectx;
4669 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4670 my $match = $1;
4671 # avoid parentheses around potential macro args
4672 next if ($match =~ /^\s*\w+\s*$/);
4673 if (!defined($herectx)) {
4674 $herectx = $here . "\n";
4675 my $cnt = statement_rawlines($if_stat);
4676 for (my $n = 0; $n < $cnt; $n++) {
4677 my $rl = raw_line($linenr, $n);
4678 $herectx .= $rl . "\n";
4679 last if $rl =~ /^[ \+].*\{/;
4680 }
4681 }
4682 CHK("UNNECESSARY_PARENTHESES",
4683 "Unnecessary parentheses around '$match'\n" . $herectx);
4684 }
4685 }
4686
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004687#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004688 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004689 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004690 if (WARN("INDENTED_LABEL",
4691 "labels should not be indented\n" . $herecurr) &&
4692 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004693 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004694 s/^(.)\s+/$1/;
4695 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004696 }
4697
Joe Perches5b9553a2014-04-03 14:49:21 -07004698# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004699 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004700 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004701 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004702 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4703 my $value = $1;
4704 $value = deparenthesize($value);
4705 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4706 ERROR("RETURN_PARENTHESES",
4707 "return is not a function, parentheses are not required\n" . $herecurr);
4708 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004709 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004710 ERROR("SPACING",
4711 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004712 }
4713 }
Joe Perches507e5142013-11-12 15:10:13 -08004714
Joe Perchesb43ae212014-06-23 13:22:07 -07004715# unnecessary return in a void function
4716# at end-of-function, with the previous line a single leading tab, then return;
4717# and the line before that not a goto label target like "out:"
4718 if ($sline =~ /^[ \+]}\s*$/ &&
4719 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4720 $linenr >= 3 &&
4721 $lines[$linenr - 3] =~ /^[ +]/ &&
4722 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004723 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004724 "void function return statements are not generally useful\n" . $hereprev);
4725 }
Joe Perches9819cf22014-06-04 16:12:09 -07004726
Joe Perches189248d2014-01-23 15:54:47 -08004727# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07004728 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08004729 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4730 my $openparens = $1;
4731 my $count = $openparens =~ tr@\(@\(@;
4732 my $msg = "";
4733 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4734 my $comp = $4; #Not $1 because of $LvalOrFunc
4735 $msg = " - maybe == should be = ?" if ($comp eq "==");
4736 WARN("UNNECESSARY_PARENTHESES",
4737 "Unnecessary parentheses$msg\n" . $herecurr);
4738 }
4739 }
4740
Joe Perchesc5595fa2015-09-09 15:37:58 -07004741# comparisons with a constant or upper case identifier on the left
4742# avoid cases like "foo + BAR < baz"
4743# only fix matches surrounded by parentheses to avoid incorrect
4744# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07004745 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004746 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4747 my $lead = $1;
4748 my $const = $2;
4749 my $comp = $3;
4750 my $to = $4;
4751 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004752 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004753 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4754 WARN("CONSTANT_COMPARISON",
4755 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4756 $fix) {
4757 if ($comp eq "<") {
4758 $newcomp = ">";
4759 } elsif ($comp eq "<=") {
4760 $newcomp = ">=";
4761 } elsif ($comp eq ">") {
4762 $newcomp = "<";
4763 } elsif ($comp eq ">=") {
4764 $newcomp = "<=";
4765 }
4766 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4767 }
4768 }
4769
Joe Perchesf34e4a42015-04-16 12:44:19 -07004770# Return of what appears to be an errno should normally be negative
4771 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004772 my $name = $1;
4773 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004774 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004775 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004776 }
4777 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004778
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004779# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004780 if ($line =~ /\b(if|while|for|switch)\(/) {
4781 if (ERROR("SPACING",
4782 "space required before the open parenthesis '('\n" . $herecurr) &&
4783 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004784 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004785 s/\b(if|while|for|switch)\(/$1 \(/;
4786 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004787 }
4788
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004789# Check for illegal assignment in if conditional -- and check for trailing
4790# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004791 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004792 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4793 ctx_statement_block($linenr, $realcnt, 0)
4794 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004795 my ($stat_next) = ctx_statement_block($line_nr_next,
4796 $remain_next, $off_next);
4797 $stat_next =~ s/\n./\n /g;
4798 ##print "stat<$stat> stat_next<$stat_next>\n";
4799
4800 if ($stat_next =~ /^\s*while\b/) {
4801 # If the statement carries leading newlines,
4802 # then count those as offsets.
4803 my ($whitespace) =
4804 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4805 my $offset =
4806 statement_rawlines($whitespace) - 1;
4807
4808 $suppress_whiletrailers{$line_nr_next +
4809 $offset} = 1;
4810 }
4811 }
4812 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004813 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004814 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004815 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004816
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004817 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004818 ERROR("ASSIGN_IN_IF",
4819 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004820 }
4821
4822 # Find out what is on the end of the line after the
4823 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004824 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004825 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004826 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004827 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4828 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004829 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004830 # Find out how long the conditional actually is.
4831 my @newlines = ($c =~ /\n/gs);
4832 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004833 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004834
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004835 $stat_real = raw_line($linenr, $cond_lines)
4836 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004837 if (defined($stat_real) && $cond_lines > 1) {
4838 $stat_real = "[...]\n$stat_real";
4839 }
4840
Joe Perches000d1cc12011-07-25 17:13:25 -07004841 ERROR("TRAILING_STATEMENTS",
4842 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004843 }
4844 }
4845
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004846# Check for bitwise tests written as boolean
4847 if ($line =~ /
4848 (?:
4849 (?:\[|\(|\&\&|\|\|)
4850 \s*0[xX][0-9]+\s*
4851 (?:\&\&|\|\|)
4852 |
4853 (?:\&\&|\|\|)
4854 \s*0[xX][0-9]+\s*
4855 (?:\&\&|\|\||\)|\])
4856 )/x)
4857 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004858 WARN("HEXADECIMAL_BOOLEAN_TEST",
4859 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004860 }
4861
Andy Whitcroft8905a672007-11-28 16:21:06 -08004862# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004863 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4864 my $s = $1;
4865 $s =~ s/$;//g; # Remove any comments
4866 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004867 ERROR("TRAILING_STATEMENTS",
4868 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004869 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004870 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004871# if should not continue a brace
4872 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004873 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004874 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004875 $herecurr);
4876 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004877# case and default should not have general statements after them
4878 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4879 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004880 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004881 \s*return\s+
4882 )/xg)
4883 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004884 ERROR("TRAILING_STATEMENTS",
4885 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004886 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004887
4888 # Check for }<nl>else {, these must be at the same
4889 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004890 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4891 $previndent == $indent) {
4892 if (ERROR("ELSE_AFTER_BRACE",
4893 "else should follow close brace '}'\n" . $hereprev) &&
4894 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4895 fix_delete_line($fixlinenr - 1, $prevrawline);
4896 fix_delete_line($fixlinenr, $rawline);
4897 my $fixedline = $prevrawline;
4898 $fixedline =~ s/}\s*$//;
4899 if ($fixedline !~ /^\+\s*$/) {
4900 fix_insert_line($fixlinenr, $fixedline);
4901 }
4902 $fixedline = $rawline;
4903 $fixedline =~ s/^(.\s*)else/$1} else/;
4904 fix_insert_line($fixlinenr, $fixedline);
4905 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004906 }
4907
Joe Perches8b8856f2014-08-06 16:11:14 -07004908 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4909 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004910 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4911
4912 # Find out what is on the end of the line after the
4913 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004914 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004915 $s =~ s/\n.*//g;
4916
4917 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004918 if (ERROR("WHILE_AFTER_BRACE",
4919 "while should follow close brace '}'\n" . $hereprev) &&
4920 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4921 fix_delete_line($fixlinenr - 1, $prevrawline);
4922 fix_delete_line($fixlinenr, $rawline);
4923 my $fixedline = $prevrawline;
4924 my $trailing = $rawline;
4925 $trailing =~ s/^\+//;
4926 $trailing = trim($trailing);
4927 $fixedline =~ s/}\s*$/} $trailing/;
4928 fix_insert_line($fixlinenr, $fixedline);
4929 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004930 }
4931 }
4932
Joe Perches95e2c602013-07-03 15:05:20 -07004933#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004934 while ($line =~ m{($Constant|$Lval)}g) {
4935 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004936
4937#gcc binary extension
4938 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004939 if (WARN("GCC_BINARY_CONSTANT",
4940 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4941 $fix) {
4942 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004943 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004944 s/\b$var\b/$hexval/;
4945 }
Joe Perches95e2c602013-07-03 15:05:20 -07004946 }
4947
4948#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004949 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004950 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004951#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004952 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004953#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004954 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4955#Ignore some three character SI units explicitly, like MiB and KHz
4956 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004957 while ($var =~ m{($Ident)}g) {
4958 my $word = $1;
4959 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004960 if ($check) {
4961 seed_camelcase_includes();
4962 if (!$file && !$camelcase_file_seeded) {
4963 seed_camelcase_file($realfile);
4964 $camelcase_file_seeded = 1;
4965 }
4966 }
Joe Perches7e781f62013-09-11 14:23:55 -07004967 if (!defined $camelcase{$word}) {
4968 $camelcase{$word} = 1;
4969 CHK("CAMELCASE",
4970 "Avoid CamelCase: <$word>\n" . $herecurr);
4971 }
Joe Perches34456862013-07-03 15:05:34 -07004972 }
Joe Perches323c1262012-12-17 16:02:07 -08004973 }
4974 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004975
4976#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004977 if ($line =~ /\#\s*define.*\\\s+$/) {
4978 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4979 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4980 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004981 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004982 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004983 }
4984
Fabian Frederick0e212e02015-04-16 12:44:25 -07004985# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4986# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004987 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004988 my $file = "$1.h";
4989 my $checkfile = "include/linux/$file";
4990 if (-f "$root/$checkfile" &&
4991 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004992 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004993 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004994 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4995 if ($asminclude > 0) {
4996 if ($realfile =~ m{^arch/}) {
4997 CHK("ARCH_INCLUDE_LINUX",
4998 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4999 } else {
5000 WARN("INCLUDE_LINUX",
5001 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5002 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005003 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005004 }
5005 }
5006
Andy Whitcroft653d4872007-06-23 17:16:34 -07005007# multi-statement macros should be enclosed in a do while loop, grab the
5008# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005009# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005010 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5011 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005012 my $ln = $linenr;
5013 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005014 my ($off, $dstat, $dcond, $rest);
5015 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005016 my $has_flow_statement = 0;
5017 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005018 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005019 ctx_statement_block($linenr, $realcnt, 0);
5020 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005021 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005022 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005023
Joe Perches08a28432014-10-13 15:51:55 -07005024 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005025 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005026
Joe Perchesf59b64b2016-10-11 13:52:08 -07005027 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5028 my $define_args = $1;
5029 my $define_stmt = $dstat;
5030 my @def_args = ();
5031
5032 if (defined $define_args && $define_args ne "") {
5033 $define_args = substr($define_args, 1, length($define_args) - 2);
5034 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005035 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005036 @def_args = split(",", $define_args);
5037 }
5038
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005039 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005040 $dstat =~ s/\\\n.//g;
5041 $dstat =~ s/^\s*//s;
5042 $dstat =~ s/\s*$//s;
5043
5044 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005045 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5046 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005047 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005048 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005049 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005050
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005051 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07005052 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5053 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005054 {
5055 }
5056
Joe Perches42e15292016-03-15 14:58:01 -07005057 # Make asm volatile uses seem like a generic function
5058 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5059
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005060 my $exceptions = qr{
5061 $Declare|
5062 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005063 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005064 DECLARE_PER_CPU|
5065 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005066 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005067 union|
5068 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005069 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005070 ^\"|\"$|
5071 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005072 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005073 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005074
5075 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005076 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005077 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005078
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005079 if ($dstat ne '' &&
5080 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5081 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005082 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005083 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005084 $dstat !~ /$exceptions/ &&
5085 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005086 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005087 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005088 $dstat !~ /^for\s*$Constant$/ && # for (...)
5089 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5090 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005091 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005092 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005093 {
Joe Perchese7955562017-05-08 15:55:48 -07005094 if ($dstat =~ /^\s*if\b/) {
5095 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5096 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5097 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005098 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5099 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5100 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005101 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005102 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005103 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005104
5105 }
Joe Perches52076492016-10-11 13:52:14 -07005106
5107 # Make $define_stmt single line, comment-free, etc
5108 my @stmt_array = split('\n', $define_stmt);
5109 my $first = 1;
5110 $define_stmt = "";
5111 foreach my $l (@stmt_array) {
5112 $l =~ s/\\$//;
5113 if ($first) {
5114 $define_stmt = $l;
5115 $first = 0;
5116 } elsif ($l =~ /^[\+ ]/) {
5117 $define_stmt .= substr($l, 1);
5118 }
5119 }
5120 $define_stmt =~ s/$;//g;
5121 $define_stmt =~ s/\s+/ /g;
5122 $define_stmt = trim($define_stmt);
5123
Joe Perchesf59b64b2016-10-11 13:52:08 -07005124# check if any macro arguments are reused (ignore '...' and 'type')
5125 foreach my $arg (@def_args) {
5126 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005127 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005128 my $tmp_stmt = $define_stmt;
5129 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5130 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5131 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005132 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005133 if ($use_cnt > 1) {
5134 CHK("MACRO_ARG_REUSE",
5135 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005136 }
5137# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005138 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005139 ((defined($1) && $1 ne ',') ||
5140 (defined($2) && $2 ne ','))) {
5141 CHK("MACRO_ARG_PRECEDENCE",
5142 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005143 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005144 }
Joe Perches5023d342012-12-17 16:01:47 -08005145
Joe Perches08a28432014-10-13 15:51:55 -07005146# check for macros with flow control, but without ## concatenation
5147# ## concatenation is commonly a macro that defines a function so ignore those
5148 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005149 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005150 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005151
Joe Perches08a28432014-10-13 15:51:55 -07005152 WARN("MACRO_WITH_FLOW_CONTROL",
5153 "Macros with flow control statements should be avoided\n" . "$herectx");
5154 }
5155
Joe Perches481eb482012-12-17 16:01:56 -08005156# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005157
5158 } else {
5159 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005160 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5161 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005162 $line =~ /^\+.*\\$/) {
5163 WARN("LINE_CONTINUATIONS",
5164 "Avoid unnecessary line continuations\n" . $herecurr);
5165 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005166 }
5167
Joe Perchesb13edf72012-07-30 14:41:24 -07005168# do {} while (0) macro tests:
5169# single-statement macros do not need to be enclosed in do while (0) loop,
5170# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005171 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005172 $realfile !~ m@/vmlinux.lds.h$@ &&
5173 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5174 my $ln = $linenr;
5175 my $cnt = $realcnt;
5176 my ($off, $dstat, $dcond, $rest);
5177 my $ctx = '';
5178 ($dstat, $dcond, $ln, $cnt, $off) =
5179 ctx_statement_block($linenr, $realcnt, 0);
5180 $ctx = $dstat;
5181
5182 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005183 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005184
5185 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5186 my $stmts = $2;
5187 my $semis = $3;
5188
5189 $ctx =~ s/\n*$//;
5190 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005191 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005192
Joe Perchesac8e97f2012-08-21 16:15:53 -07005193 if (($stmts =~ tr/;/;/) == 1 &&
5194 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005195 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5196 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5197 }
5198 if (defined $semis && $semis ne "") {
5199 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5200 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5201 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005202 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5203 $ctx =~ s/\n*$//;
5204 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005205 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005206
5207 WARN("TRAILING_SEMICOLON",
5208 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005209 }
5210 }
5211
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005212# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005213 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5214 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005215 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005216 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005217 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5218 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005219 my @allowed = ();
5220 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005221 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005222 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005223 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005224 for my $chunk (@chunks) {
5225 my ($cond, $block) = @{$chunk};
5226
Andy Whitcroft773647a2008-03-28 14:15:58 -07005227 # If the condition carries leading newlines, then count those as offsets.
5228 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5229 my $offset = statement_rawlines($whitespace) - 1;
5230
Joe Perchesaad4f612012-03-23 15:02:19 -07005231 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005232 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5233
5234 # We have looked at and allowed this specific line.
5235 $suppress_ifbraces{$ln + $offset} = 1;
5236
5237 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005238 $ln += statement_rawlines($block) - 1;
5239
Andy Whitcroft773647a2008-03-28 14:15:58 -07005240 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005241
5242 $seen++ if ($block =~ /^\s*{/);
5243
Joe Perchesaad4f612012-03-23 15:02:19 -07005244 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005245 if (statement_lines($cond) > 1) {
5246 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005247 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005248 }
5249 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005250 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005251 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005252 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005253 if (statement_block_size($block) > 1) {
5254 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005255 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005256 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005257 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005258 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005259 if ($seen) {
5260 my $sum_allowed = 0;
5261 foreach (@allowed) {
5262 $sum_allowed += $_;
5263 }
5264 if ($sum_allowed == 0) {
5265 WARN("BRACES",
5266 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5267 } elsif ($sum_allowed != $allow &&
5268 $seen != $allow) {
5269 CHK("BRACES",
5270 "braces {} should be used on all arms of this statement\n" . $herectx);
5271 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005272 }
5273 }
5274 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005275 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005276 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005277 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005278
Andy Whitcroftcf655042008-03-04 14:28:20 -08005279 # Check the pre-context.
5280 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5281 #print "APW: ALLOWED: pre<$1>\n";
5282 $allowed = 1;
5283 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005284
5285 my ($level, $endln, @chunks) =
5286 ctx_statement_full($linenr, $realcnt, $-[0]);
5287
Andy Whitcroftcf655042008-03-04 14:28:20 -08005288 # Check the condition.
5289 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005290 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005291 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005292 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005293 }
5294 if (statement_lines($cond) > 1) {
5295 #print "APW: ALLOWED: cond<$cond>\n";
5296 $allowed = 1;
5297 }
5298 if ($block =~/\b(?:if|for|while)\b/) {
5299 #print "APW: ALLOWED: block<$block>\n";
5300 $allowed = 1;
5301 }
5302 if (statement_block_size($block) > 1) {
5303 #print "APW: ALLOWED: lines block<$block>\n";
5304 $allowed = 1;
5305 }
5306 # Check the post-context.
5307 if (defined $chunks[1]) {
5308 my ($cond, $block) = @{$chunks[1]};
5309 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005310 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005311 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005312 if ($block =~ /^\s*\{/) {
5313 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5314 $allowed = 1;
5315 }
5316 }
5317 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005318 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005319 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005320
Joe Perches000d1cc12011-07-25 17:13:25 -07005321 WARN("BRACES",
5322 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005323 }
5324 }
5325
Joe Perchese4c5bab2017-02-24 15:01:41 -08005326# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005327 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5328 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005329 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5330 }
5331
Joe Perches0979ae62012-12-17 16:01:59 -08005332# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005333 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005334 if (CHK("BRACES",
5335 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5336 $fix && $prevrawline =~ /^\+/) {
5337 fix_delete_line($fixlinenr - 1, $prevrawline);
5338 }
Joe Perches0979ae62012-12-17 16:01:59 -08005339 }
Joe Perches77b9a532013-07-03 15:05:29 -07005340 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005341 if (CHK("BRACES",
5342 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5343 $fix) {
5344 fix_delete_line($fixlinenr, $rawline);
5345 }
Joe Perches0979ae62012-12-17 16:01:59 -08005346 }
5347
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005348# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005349 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5350 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005351 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005352 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005353 }
5354
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005355# Check for user-visible strings broken across lines, which breaks the ability
5356# to grep for the string. Make exceptions when the previous string ends in a
5357# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5358# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005359 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005360 $prevline =~ /"\s*$/ &&
5361 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5362 if (WARN("SPLIT_STRING",
5363 "quoted string split across lines\n" . $hereprev) &&
5364 $fix &&
5365 $prevrawline =~ /^\+.*"\s*$/ &&
5366 $last_coalesced_string_linenr != $linenr - 1) {
5367 my $extracted_string = get_quoted_string($line, $rawline);
5368 my $comma_close = "";
5369 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5370 $comma_close = $1;
5371 }
5372
5373 fix_delete_line($fixlinenr - 1, $prevrawline);
5374 fix_delete_line($fixlinenr, $rawline);
5375 my $fixedline = $prevrawline;
5376 $fixedline =~ s/"\s*$//;
5377 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5378 fix_insert_line($fixlinenr - 1, $fixedline);
5379 $fixedline = $rawline;
5380 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5381 if ($fixedline !~ /\+\s*$/) {
5382 fix_insert_line($fixlinenr, $fixedline);
5383 }
5384 $last_coalesced_string_linenr = $linenr;
5385 }
5386 }
5387
5388# check for missing a space in a string concatenation
5389 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5390 WARN('MISSING_SPACE',
5391 "break quoted strings at a space character\n" . $hereprev);
5392 }
5393
Joe Perchese4b7d302017-05-08 15:55:51 -07005394# check for an embedded function name in a string when the function is known
5395# This does not work very well for -f --file checking as it depends on patch
5396# context providing the function name or a single line form for in-file
5397# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005398 if ($line =~ /^\+.*$String/ &&
5399 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005400 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5401 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005402 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005403 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005404 }
5405
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005406# check for spaces before a quoted newline
5407 if ($rawline =~ /^.*\".*\s\\n/) {
5408 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5409 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5410 $fix) {
5411 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5412 }
5413
5414 }
5415
Joe Perchesf17dba42014-10-13 15:51:51 -07005416# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005417 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5418 if (CHK("CONCATENATED_STRING",
5419 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5420 $fix) {
5421 while ($line =~ /($String)/g) {
5422 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5423 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5424 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5425 }
5426 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005427 }
5428
Joe Perches90ad30e2014-12-10 15:51:59 -08005429# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005430 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005431 if (WARN("STRING_FRAGMENTS",
5432 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5433 $fix) {
5434 while ($line =~ /($String)(?=\s*")/g) {
5435 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5436 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5437 }
5438 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005439 }
5440
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005441# check for non-standard and hex prefixed decimal printf formats
5442 my $show_L = 1; #don't show the same defect twice
5443 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005444 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005445 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005446 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005447 # check for %L
5448 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005449 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005450 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5451 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005452 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005453 # check for %Z
5454 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5455 WARN("PRINTF_Z",
5456 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5457 $show_Z = 0;
5458 }
5459 # check for 0x<decimal>
5460 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5461 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005462 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5463 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005464 }
5465
5466# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005467 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005468 WARN("LINE_CONTINUATIONS",
5469 "Avoid line continuations in quoted strings\n" . $herecurr);
5470 }
5471
Andy Whitcroft00df3442007-06-08 13:47:06 -07005472# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005473 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005474 WARN("IF_0",
5475 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5476 }
5477
5478# warn about #if 1
5479 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5480 WARN("IF_1",
5481 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005482 }
5483
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005484# check for needless "if (<foo>) fn(<foo>)" uses
5485 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005486 my $tested = quotemeta($1);
5487 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5488 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5489 my $func = $1;
5490 if (WARN('NEEDLESS_IF',
5491 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5492 $fix) {
5493 my $do_fix = 1;
5494 my $leading_tabs = "";
5495 my $new_leading_tabs = "";
5496 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5497 $leading_tabs = $1;
5498 } else {
5499 $do_fix = 0;
5500 }
5501 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5502 $new_leading_tabs = $1;
5503 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5504 $do_fix = 0;
5505 }
5506 } else {
5507 $do_fix = 0;
5508 }
5509 if ($do_fix) {
5510 fix_delete_line($fixlinenr - 1, $prevrawline);
5511 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5512 }
5513 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005514 }
5515 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005516
Joe Perchesebfdc402014-08-06 16:10:27 -07005517# check for unnecessary "Out of Memory" messages
5518 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5519 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5520 (defined $1 || defined $3) &&
5521 $linenr > 3) {
5522 my $testval = $2;
5523 my $testline = $lines[$linenr - 3];
5524
5525 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5526# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5527
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005528 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005529 WARN("OOM_MESSAGE",
5530 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5531 }
5532 }
5533
Joe Perchesf78d98f2014-10-13 15:52:01 -07005534# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005535 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005536 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5537 my $level = $1;
5538 if (WARN("UNNECESSARY_KERN_LEVEL",
5539 "Possible unnecessary $level\n" . $herecurr) &&
5540 $fix) {
5541 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5542 }
5543 }
5544
Joe Perches45c55e92017-02-24 15:01:31 -08005545# check for logging continuations
5546 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5547 WARN("LOGGING_CONTINUATION",
5548 "Avoid logging continuation uses where feasible\n" . $herecurr);
5549 }
5550
Joe Perchesabb08a52014-12-10 15:51:46 -08005551# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005552 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005553 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5554 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5555 WARN("MASK_THEN_SHIFT",
5556 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5557 }
5558
Joe Perchesb75ac612014-12-10 15:52:02 -08005559# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005560 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005561 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5562 my $val = $1;
5563 my $equal = "!";
5564 $equal = "" if ($4 eq "!=");
5565 if (CHK("COMPARISON_TO_NULL",
5566 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5567 $fix) {
5568 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5569 }
5570 }
5571 }
5572
Joe Perches8716de32013-09-11 14:24:05 -07005573# check for bad placement of section $InitAttribute (e.g.: __initdata)
5574 if ($line =~ /(\b$InitAttribute\b)/) {
5575 my $attr = $1;
5576 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5577 my $ptr = $1;
5578 my $var = $2;
5579 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5580 ERROR("MISPLACED_INIT",
5581 "$attr should be placed after $var\n" . $herecurr)) ||
5582 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5583 WARN("MISPLACED_INIT",
5584 "$attr should be placed after $var\n" . $herecurr))) &&
5585 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005586 $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 -07005587 }
5588 }
5589 }
5590
Joe Perchese970b8842013-11-12 15:10:10 -08005591# check for $InitAttributeData (ie: __initdata) with const
5592 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5593 my $attr = $1;
5594 $attr =~ /($InitAttributePrefix)(.*)/;
5595 my $attr_prefix = $1;
5596 my $attr_type = $2;
5597 if (ERROR("INIT_ATTRIBUTE",
5598 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5599 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005600 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005601 s/$InitAttributeData/${attr_prefix}initconst/;
5602 }
5603 }
5604
5605# check for $InitAttributeConst (ie: __initconst) without const
5606 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5607 my $attr = $1;
5608 if (ERROR("INIT_ATTRIBUTE",
5609 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5610 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005611 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005612 /(^\+\s*(?:static\s+))/;
5613 $lead = rtrim($1);
5614 $lead = "$lead " if ($lead !~ /^\+$/);
5615 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005616 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005617 }
5618 }
5619
Joe Perchesc17893c2015-04-16 12:44:42 -07005620# check for __read_mostly with const non-pointer (should just be const)
5621 if ($line =~ /\b__read_mostly\b/ &&
5622 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5623 if (ERROR("CONST_READ_MOSTLY",
5624 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5625 $fix) {
5626 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5627 }
5628 }
5629
Joe Perchesfbdb8132014-04-03 14:49:14 -07005630# don't use __constant_<foo> functions outside of include/uapi/
5631 if ($realfile !~ m@^include/uapi/@ &&
5632 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5633 my $constant_func = $1;
5634 my $func = $constant_func;
5635 $func =~ s/^__constant_//;
5636 if (WARN("CONSTANT_CONVERSION",
5637 "$constant_func should be $func\n" . $herecurr) &&
5638 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005639 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005640 }
5641 }
5642
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005643# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005644 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005645 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005646 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005647 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005648 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005649 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5650 }
5651 if ($delay > 2000) {
5652 WARN("LONG_UDELAY",
5653 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005654 }
5655 }
5656
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005657# warn about unexpectedly long msleep's
5658 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5659 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005660 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005661 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005662 }
5663 }
5664
Joe Perches36ec1932013-07-03 15:05:25 -07005665# check for comparisons of jiffies
5666 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5667 WARN("JIFFIES_COMPARISON",
5668 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5669 }
5670
Joe Perches9d7a34a2013-07-03 15:05:26 -07005671# check for comparisons of get_jiffies_64()
5672 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5673 WARN("JIFFIES_COMPARISON",
5674 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5675 }
5676
Andy Whitcroft00df3442007-06-08 13:47:06 -07005677# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005678# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005679# print "#ifdef in C files should be avoided\n";
5680# print "$herecurr";
5681# $clean = 0;
5682# }
5683
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005684# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005685 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005686 if (ERROR("SPACING",
5687 "exactly one space required after that #$1\n" . $herecurr) &&
5688 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005689 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005690 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5691 }
5692
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005693 }
5694
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005695# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005696 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5697 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005698 my $which = $1;
5699 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005700 CHK("UNCOMMENTED_DEFINITION",
5701 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005702 }
5703 }
5704# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005705
5706 my $barriers = qr{
5707 mb|
5708 rmb|
5709 wmb|
5710 read_barrier_depends
5711 }x;
5712 my $barrier_stems = qr{
5713 mb__before_atomic|
5714 mb__after_atomic|
5715 store_release|
5716 load_acquire|
5717 store_mb|
5718 (?:$barriers)
5719 }x;
5720 my $all_barriers = qr{
5721 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005722 smp_(?:$barrier_stems)|
5723 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005724 }x;
5725
5726 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005727 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005728 WARN("MEMORY_BARRIER",
5729 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005730 }
5731 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005732
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005733 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5734
5735 if ($realfile !~ m@^include/asm-generic/@ &&
5736 $realfile !~ m@/barrier\.h$@ &&
5737 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5738 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5739 WARN("MEMORY_BARRIER",
5740 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5741 }
5742
Joe Perchescb426e92015-06-25 15:02:46 -07005743# check for waitqueue_active without a comment.
5744 if ($line =~ /\bwaitqueue_active\s*\(/) {
5745 if (!ctx_has_comment($first_line, $linenr)) {
5746 WARN("WAITQUEUE_ACTIVE",
5747 "waitqueue_active without comment\n" . $herecurr);
5748 }
5749 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005750
Paul E. McKenney91db2592017-11-27 09:37:35 -08005751# check for smp_read_barrier_depends and read_barrier_depends
5752 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5753 WARN("READ_BARRIER_DEPENDS",
5754 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5755 }
5756
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005757# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005758 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005759 CHK("ARCH_DEFINES",
5760 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005761 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005762
Joe Perches596ed452017-07-12 14:37:02 -07005763# check that the storage class is not after a type
5764 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005765 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005766 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5767 }
5768# Check that the storage class is at the beginning of a declaration
5769 if ($line =~ /\b$Storage\b/ &&
5770 $line !~ /^.\s*$Storage/ &&
5771 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5772 $1 !~ /[\,\)]\s*$/) {
5773 WARN("STORAGE_CLASS",
5774 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005775 }
5776
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005777# check the location of the inline attribute, that it is between
5778# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005779 if ($line =~ /\b$Type\s+$Inline\b/ ||
5780 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005781 ERROR("INLINE_LOCATION",
5782 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005783 }
5784
Andy Whitcroft8905a672007-11-28 16:21:06 -08005785# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005786 if ($realfile !~ m@\binclude/uapi/@ &&
5787 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005788 if (WARN("INLINE",
5789 "plain inline is preferred over $1\n" . $herecurr) &&
5790 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005791 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005792
5793 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005794 }
5795
Joe Perches3d130fd2011-01-12 17:00:00 -08005796# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005797 if ($realfile !~ m@\binclude/uapi/@ &&
5798 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005799 WARN("PREFER_PACKED",
5800 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005801 }
5802
Joe Perches39b7e282011-07-25 17:13:24 -07005803# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005804 if ($realfile !~ m@\binclude/uapi/@ &&
5805 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005806 WARN("PREFER_ALIGNED",
5807 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005808 }
5809
Joe Perches5f14d3b2012-01-10 15:09:52 -08005810# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005811 if ($realfile !~ m@\binclude/uapi/@ &&
5812 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005813 if (WARN("PREFER_PRINTF",
5814 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5815 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005816 $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 -07005817
5818 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005819 }
5820
Joe Perches6061d942012-03-23 15:02:16 -07005821# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005822 if ($realfile !~ m@\binclude/uapi/@ &&
5823 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005824 if (WARN("PREFER_SCANF",
5825 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5826 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005827 $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 -07005828 }
Joe Perches6061d942012-03-23 15:02:16 -07005829 }
5830
Joe Perches619a9082014-12-10 15:51:35 -08005831# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07005832 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08005833 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5834 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5835 $line =~ /\b__weak\b/)) {
5836 ERROR("WEAK_DECLARATION",
5837 "Using weak declarations can have unintended link defects\n" . $herecurr);
5838 }
5839
Tomas Winklerfd39f902016-12-12 16:46:34 -08005840# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005841 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005842 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005843 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5844 my $type = $1;
5845 if ($type =~ /\b($typeC99Typedefs)\b/) {
5846 $type = $1;
5847 my $kernel_type = 'u';
5848 $kernel_type = 's' if ($type =~ /^_*[si]/);
5849 $type =~ /(\d+)/;
5850 $kernel_type .= $1;
5851 if (CHK("PREFER_KERNEL_TYPES",
5852 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5853 $fix) {
5854 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5855 }
5856 }
5857 }
5858
Joe Perches938224b2016-01-20 14:59:15 -08005859# check for cast of C90 native int or longer types constants
5860 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5861 my $cast = $1;
5862 my $const = $2;
5863 if (WARN("TYPECAST_INT_CONSTANT",
5864 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5865 $fix) {
5866 my $suffix = "";
5867 my $newconst = $const;
5868 $newconst =~ s/${Int_type}$//;
5869 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5870 if ($cast =~ /\blong\s+long\b/) {
5871 $suffix .= 'LL';
5872 } elsif ($cast =~ /\blong\b/) {
5873 $suffix .= 'L';
5874 }
5875 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5876 }
5877 }
5878
Joe Perches8f53a9b2010-03-05 13:43:48 -08005879# check for sizeof(&)
5880 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005881 WARN("SIZEOF_ADDRESS",
5882 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005883 }
5884
Joe Perches66c80b62012-07-30 14:41:22 -07005885# check for sizeof without parenthesis
5886 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005887 if (WARN("SIZEOF_PARENTHESIS",
5888 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5889 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005890 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005891 }
Joe Perches66c80b62012-07-30 14:41:22 -07005892 }
5893
Joe Perches88982fe2012-12-17 16:02:00 -08005894# check for struct spinlock declarations
5895 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5896 WARN("USE_SPINLOCK_T",
5897 "struct spinlock should be spinlock_t\n" . $herecurr);
5898 }
5899
Joe Perchesa6962d72013-04-29 16:18:13 -07005900# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005901 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005902 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005903 $fmt =~ s/%%//g;
5904 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005905 if (WARN("PREFER_SEQ_PUTS",
5906 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5907 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005908 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005909 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005910 }
5911 }
5912
Joe Perches478b1792018-04-10 16:33:34 -07005913# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07005914 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07005915 defined $stat &&
5916 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5917 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005918 my $stat_real;
5919
Joe Perches0b523762017-05-08 15:55:36 -07005920 my $lc = $stat =~ tr@\n@@;
5921 $lc = $lc + $linenr;
5922 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07005923 my $specifier;
5924 my $extension;
5925 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07005926 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5927 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005928
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005929 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5930 $specifier = $1;
5931 $extension = $2;
5932 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
5933 $bad_specifier = $specifier;
5934 last;
5935 }
5936 if ($extension eq "x" && !defined($stat_real)) {
5937 if (!defined($stat_real)) {
5938 $stat_real = get_stat_real($linenr, $lc);
5939 }
5940 WARN("VSPRINTF_SPECIFIER_PX",
5941 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5942 }
5943 }
5944 if ($bad_specifier ne "") {
5945 my $stat_real = get_stat_real($linenr, $lc);
5946 my $ext_type = "Invalid";
5947 my $use = "";
5948 if ($bad_specifier =~ /p[Ff]/) {
5949 $ext_type = "Deprecated";
5950 $use = " - use %pS instead";
5951 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
5952 }
5953
5954 WARN("VSPRINTF_POINTER_EXTENSION",
5955 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
5956 }
Joe Perches0b523762017-05-08 15:55:36 -07005957 }
5958 }
5959
Andy Whitcroft554e1652012-01-10 15:09:57 -08005960# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07005961 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005962 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005963 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005964
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005965 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005966 my $ms_val = $7;
5967 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005968
Andy Whitcroft554e1652012-01-10 15:09:57 -08005969 if ($ms_size =~ /^(0x|)0$/i) {
5970 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005971 "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 -08005972 } elsif ($ms_size =~ /^(0x|)1$/i) {
5973 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005974 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5975 }
5976 }
5977
Joe Perches98a9bba2014-01-23 15:54:52 -08005978# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07005979# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07005980# defined $stat &&
5981# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5982# if (WARN("PREFER_ETHER_ADDR_COPY",
5983# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5984# $fix) {
5985# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5986# }
5987# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005988
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005989# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07005990# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07005991# defined $stat &&
5992# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5993# WARN("PREFER_ETHER_ADDR_EQUAL",
5994# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5995# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005996
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005997# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5998# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07005999# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006000# defined $stat &&
6001# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6002#
6003# my $ms_val = $7;
6004#
6005# if ($ms_val =~ /^(?:0x|)0+$/i) {
6006# if (WARN("PREFER_ETH_ZERO_ADDR",
6007# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6008# $fix) {
6009# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6010# }
6011# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6012# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6013# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6014# $fix) {
6015# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6016# }
6017# }
6018# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006019
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006020# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006021 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006022 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006023 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006024 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006025 my $call = $1;
6026 my $cast1 = deparenthesize($2);
6027 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006028 my $cast2 = deparenthesize($7);
6029 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006030 my $cast;
6031
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006032 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006033 $cast = "$cast1 or $cast2";
6034 } elsif ($cast1 ne "") {
6035 $cast = $cast1;
6036 } else {
6037 $cast = $cast2;
6038 }
6039 WARN("MINMAX",
6040 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006041 }
6042 }
6043
Joe Perches4a273192012-07-30 14:41:20 -07006044# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006045 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006046 defined $stat &&
6047 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6048 my $min = $1;
6049 my $max = $7;
6050 if ($min eq $max) {
6051 WARN("USLEEP_RANGE",
6052 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6053 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6054 $min > $max) {
6055 WARN("USLEEP_RANGE",
6056 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6057 }
6058 }
6059
Joe Perches823b7942013-11-12 15:10:15 -08006060# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006061 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006062 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006063 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006064 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6065 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6066 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6067 my $lc = $stat =~ tr@\n@@;
6068 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006069 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006070 WARN("NAKED_SSCANF",
6071 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6072 }
6073
Joe Perchesafc819a2014-06-04 16:12:08 -07006074# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006075 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006076 defined $stat &&
6077 $line =~ /\bsscanf\b/) {
6078 my $lc = $stat =~ tr@\n@@;
6079 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006080 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006081 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6082 my $format = $6;
6083 my $count = $format =~ tr@%@%@;
6084 if ($count == 1 &&
6085 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6086 WARN("SSCANF_TO_KSTRTO",
6087 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6088 }
6089 }
6090 }
6091
Joe Perches70dc8a42013-09-11 14:23:58 -07006092# check for new externs in .h files.
6093 if ($realfile =~ /\.h$/ &&
6094 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006095 if (CHK("AVOID_EXTERNS",
6096 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006097 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006098 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006099 }
6100 }
6101
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006102# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006103 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006104 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006105 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006106 my $function_name = $1;
6107 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006108
6109 my $s = $stat;
6110 if (defined $cond) {
6111 substr($s, 0, length($cond), '');
6112 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006113 if ($s =~ /^\s*;/ &&
6114 $function_name ne 'uninitialized_var')
6115 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006116 WARN("AVOID_EXTERNS",
6117 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006118 }
6119
6120 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006121 WARN("FUNCTION_ARGUMENTS",
6122 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006123 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006124
6125 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6126 $stat =~ /^.\s*extern\s+/)
6127 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006128 WARN("AVOID_EXTERNS",
6129 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006130 }
6131
Joe Perchesa0ad7592017-07-10 15:52:19 -07006132# check for function declarations that have arguments without identifier names
6133 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006134 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006135 $1 ne "void") {
6136 my $args = trim($1);
6137 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6138 my $arg = trim($1);
6139 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6140 WARN("FUNCTION_ARGUMENTS",
6141 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6142 }
6143 }
6144 }
6145
Joe Perchesa0ad7592017-07-10 15:52:19 -07006146# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006147 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006148 defined $stat &&
6149 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6150 $context_function = $1;
6151
6152# check for multiline function definition with misplaced open brace
6153 my $ok = 0;
6154 my $cnt = statement_rawlines($stat);
6155 my $herectx = $here . "\n";
6156 for (my $n = 0; $n < $cnt; $n++) {
6157 my $rl = raw_line($linenr, $n);
6158 $herectx .= $rl . "\n";
6159 $ok = 1 if ($rl =~ /^[ \+]\{/);
6160 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6161 last if $rl =~ /^[ \+].*\{/;
6162 }
6163 if (!$ok) {
6164 ERROR("OPEN_BRACE",
6165 "open brace '{' following function definitions go on the next line\n" . $herectx);
6166 }
6167 }
6168
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006169# checks for new __setup's
6170 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6171 my $name = $1;
6172
6173 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006174 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006175 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006176 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006177 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006178
6179# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006180 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006181 WARN("UNNECESSARY_CASTS",
6182 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006183 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006184
Joe Perchesa640d252013-07-03 15:05:21 -07006185# alloc style
6186# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006187 if ($perl_version_ok &&
Joe Perchesa640d252013-07-03 15:05:21 -07006188 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6189 CHK("ALLOC_SIZEOF_STRUCT",
6190 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6191 }
6192
Joe Perches60a55362014-06-04 16:12:07 -07006193# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006194 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006195 defined $stat &&
6196 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07006197 my $oldfunc = $3;
6198 my $a1 = $4;
6199 my $a2 = $10;
6200 my $newfunc = "kmalloc_array";
6201 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006202 my $r1 = $a1;
6203 my $r2 = $a2;
6204 if ($a1 =~ /^sizeof\s*\S/) {
6205 $r1 = $a2;
6206 $r2 = $a1;
6207 }
6208 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6209 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006210 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006211 my $herectx = get_stat_here($linenr, $cnt, $here);
6212
Joe Perches60a55362014-06-04 16:12:07 -07006213 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006214 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6215 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006216 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006217 $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 -07006218 }
6219 }
6220 }
6221
Joe Perches972fdea2013-04-29 16:18:12 -07006222# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006223 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006224 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6225 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006226 WARN("KREALLOC_ARG_REUSE",
6227 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6228 }
6229
Joe Perches5ce59ae2013-02-21 16:44:18 -08006230# check for alloc argument mismatch
6231 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6232 WARN("ALLOC_ARRAY_ARGS",
6233 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6234 }
6235
Joe Perchescaf2a542011-01-12 16:59:56 -08006236# check for multiple semicolons
6237 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006238 if (WARN("ONE_SEMICOLON",
6239 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6240 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006241 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006242 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006243 }
6244
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006245# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6246 if ($realfile !~ m@^include/uapi/@ &&
6247 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006248 my $ull = "";
6249 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6250 if (CHK("BIT_MACRO",
6251 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6252 $fix) {
6253 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6254 }
6255 }
6256
Joe Perches2d632742016-05-20 17:04:00 -07006257# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6258 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6259 my $config = $1;
6260 if (WARN("PREFER_IS_ENABLED",
6261 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6262 $fix) {
6263 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6264 }
6265 }
6266
Joe Perchese81f2392014-08-06 16:11:25 -07006267# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006268 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6269 my $has_break = 0;
6270 my $has_statement = 0;
6271 my $count = 0;
6272 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006273 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006274 $prevline--;
6275 my $rline = $rawlines[$prevline - 1];
6276 my $fline = $lines[$prevline - 1];
6277 last if ($fline =~ /^\@\@/);
6278 next if ($fline =~ /^\-/);
6279 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6280 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6281 next if ($fline =~ /^.[\s$;]*$/);
6282 $has_statement = 1;
6283 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006284 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006285 }
6286 if (!$has_break && $has_statement) {
6287 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006288 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006289 }
6290 }
6291
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006292# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006293 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006294 defined $stat &&
6295 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006296 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006297 my $herectx = get_stat_here($linenr, $cnt, $here);
6298
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006299 WARN("DEFAULT_NO_BREAK",
6300 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006301 }
6302
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006303# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006304 if ($line =~ /\b__FUNCTION__\b/) {
6305 if (WARN("USE_FUNC",
6306 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6307 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006308 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006309 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006310 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006311
Joe Perches62ec8182015-02-13 14:38:18 -08006312# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6313 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6314 ERROR("DATE_TIME",
6315 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6316 }
6317
Joe Perches2c924882012-03-23 15:02:20 -07006318# check for use of yield()
6319 if ($line =~ /\byield\s*\(\s*\)/) {
6320 WARN("YIELD",
6321 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6322 }
6323
Joe Perches179f8f42013-07-03 15:05:30 -07006324# check for comparisons against true and false
6325 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6326 my $lead = $1;
6327 my $arg = $2;
6328 my $test = $3;
6329 my $otype = $4;
6330 my $trail = $5;
6331 my $op = "!";
6332
6333 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6334
6335 my $type = lc($otype);
6336 if ($type =~ /^(?:true|false)$/) {
6337 if (("$test" eq "==" && "$type" eq "true") ||
6338 ("$test" eq "!=" && "$type" eq "false")) {
6339 $op = "";
6340 }
6341
6342 CHK("BOOL_COMPARISON",
6343 "Using comparison to $otype is error prone\n" . $herecurr);
6344
6345## maybe suggesting a correct construct would better
6346## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6347
6348 }
6349 }
6350
Joe Perches5d430902018-04-10 16:34:25 -07006351# check for bool bitfields
6352 if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) {
6353 WARN("BOOL_BITFIELD",
6354 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6355 }
6356
Joe Perchesd7295932018-08-21 21:57:26 -07006357# check for bool use in .h files
6358 if ($realfile =~ /\.h$/ &&
6359 $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) {
6360 CHK("BOOL_MEMBER",
6361 "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr);
6362 }
6363
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006364# check for semaphores initialized locked
6365 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006366 WARN("CONSIDER_COMPLETION",
6367 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006368 }
Joe Perches6712d852012-03-23 15:02:20 -07006369
Joe Perches67d0a072011-10-31 17:13:10 -07006370# recommend kstrto* over simple_strto* and strict_strto*
6371 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006372 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006373 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006374 }
Joe Perches6712d852012-03-23 15:02:20 -07006375
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006376# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006377 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006378 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006379 "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 -07006380 }
Joe Perches6712d852012-03-23 15:02:20 -07006381
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006382# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006383# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006384 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006385 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006386 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006387 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006388 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006389
6390# use of NR_CPUS is usually wrong
6391# ignore definitions of NR_CPUS and usage to define arrays as likely right
6392 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006393 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6394 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006395 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6396 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6397 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006398 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006399 WARN("NR_CPUS",
6400 "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 -07006401 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006402
Joe Perches52ea8502013-11-12 15:10:09 -08006403# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6404 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6405 ERROR("DEFINE_ARCH_HAS",
6406 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6407 }
6408
Joe Perchesacd93622015-02-13 14:38:38 -08006409# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006410 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006411 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6412 WARN("LIKELY_MISUSE",
6413 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6414 }
6415
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006416# whine mightly about in_atomic
6417 if ($line =~ /\bin_atomic\s*\(/) {
6418 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006419 ERROR("IN_ATOMIC",
6420 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006421 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006422 WARN("IN_ATOMIC",
6423 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006424 }
6425 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006426
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006427# check for mutex_trylock_recursive usage
6428 if ($line =~ /mutex_trylock_recursive/) {
6429 ERROR("LOCKING",
6430 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6431 }
6432
Peter Zijlstra1704f472010-03-19 01:37:42 +01006433# check for lockdep_set_novalidate_class
6434 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6435 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6436 if ($realfile !~ m@^kernel/lockdep@ &&
6437 $realfile !~ m@^include/linux/lockdep@ &&
6438 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006439 ERROR("LOCKDEP",
6440 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006441 }
6442 }
Dave Jones88f88312011-01-12 16:59:59 -08006443
Joe Perchesb392c642015-04-16 12:44:16 -07006444 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6445 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006446 WARN("EXPORTED_WORLD_WRITABLE",
6447 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006448 }
Joe Perches24358802014-04-03 14:49:13 -07006449
Joe Perches00180462018-02-06 15:38:55 -08006450# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6451# and whether or not function naming is typical and if
6452# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006453 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006454 defined $stat &&
6455 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6456 my $var = $1;
6457 my $perms = $2;
6458 my $show = $3;
6459 my $store = $4;
6460 my $octal_perms = perms_to_octal($perms);
6461 if ($show =~ /^${var}_show$/ &&
6462 $store =~ /^${var}_store$/ &&
6463 $octal_perms eq "0644") {
6464 if (WARN("DEVICE_ATTR_RW",
6465 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6466 $fix) {
6467 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6468 }
6469 } elsif ($show =~ /^${var}_show$/ &&
6470 $store =~ /^NULL$/ &&
6471 $octal_perms eq "0444") {
6472 if (WARN("DEVICE_ATTR_RO",
6473 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6474 $fix) {
6475 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6476 }
6477 } elsif ($show =~ /^NULL$/ &&
6478 $store =~ /^${var}_store$/ &&
6479 $octal_perms eq "0200") {
6480 if (WARN("DEVICE_ATTR_WO",
6481 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6482 $fix) {
6483 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6484 }
6485 } elsif ($octal_perms eq "0644" ||
6486 $octal_perms eq "0444" ||
6487 $octal_perms eq "0200") {
6488 my $newshow = "$show";
6489 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6490 my $newstore = $store;
6491 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6492 my $rename = "";
6493 if ($show ne $newshow) {
6494 $rename .= " '$show' to '$newshow'";
6495 }
6496 if ($store ne $newstore) {
6497 $rename .= " '$store' to '$newstore'";
6498 }
6499 WARN("DEVICE_ATTR_FUNCTIONS",
6500 "Consider renaming function(s)$rename\n" . $herecurr);
6501 } else {
6502 WARN("DEVICE_ATTR_PERMS",
6503 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6504 }
6505 }
6506
Joe Perches515a2352014-04-03 14:49:24 -07006507# Mode permission misuses where it seems decimal should be octal
6508# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006509# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6510# specific definition of not visible in sysfs.
6511# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6512# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006513 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006514 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006515 $line =~ /$mode_perms_search/) {
6516 foreach my $entry (@mode_permission_funcs) {
6517 my $func = $entry->[0];
6518 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006519
Joe Perches459cf0a2016-10-11 13:52:19 -07006520 my $lc = $stat =~ tr@\n@@;
6521 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006522 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006523
Joe Perches515a2352014-04-03 14:49:24 -07006524 my $skip_args = "";
6525 if ($arg_pos > 1) {
6526 $arg_pos--;
6527 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6528 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006529 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006530 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006531 my $val = $1;
6532 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006533 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6534 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6535 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006536 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006537 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006538 }
6539 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006540 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006541 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006542 }
Joe Perches24358802014-04-03 14:49:13 -07006543 }
6544 }
6545 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006546
Joe Perches459cf0a2016-10-11 13:52:19 -07006547# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006548 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006549 my $oval = $1;
6550 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006551 if (WARN("SYMBOLIC_PERMS",
6552 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6553 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006554 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006555 }
6556 }
6557
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006558# validate content of MODULE_LICENSE against list from include/linux/module.h
6559 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6560 my $extracted_string = get_quoted_string($line, $rawline);
6561 my $valid_licenses = qr{
6562 GPL|
6563 GPL\ v2|
6564 GPL\ and\ additional\ rights|
6565 Dual\ BSD/GPL|
6566 Dual\ MIT/GPL|
6567 Dual\ MPL/GPL|
6568 Proprietary
6569 }x;
6570 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6571 WARN("MODULE_LICENSE",
6572 "unknown module license " . $extracted_string . "\n" . $herecurr);
6573 }
6574 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006575 }
6576
6577 # If we have no input at all, then there is nothing to report on
6578 # so just keep quiet.
6579 if ($#rawlines == -1) {
6580 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006581 }
6582
Andy Whitcroft8905a672007-11-28 16:21:06 -08006583 # In mailback mode only produce a report in the negative, for
6584 # things that appear to be patches.
6585 if ($mailback && ($clean == 1 || !$is_patch)) {
6586 exit(0);
6587 }
6588
6589 # This is not a patch, and we are are in 'no-patch' mode so
6590 # just keep quiet.
6591 if (!$chk_patch && !$is_patch) {
6592 exit(0);
6593 }
6594
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006595 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006596 ERROR("NOT_UNIFIED_DIFF",
6597 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006598 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006599 if ($is_patch && $has_commit_log && $chk_signoff) {
6600 if ($signoff == 0) {
6601 ERROR("MISSING_SIGN_OFF",
6602 "Missing Signed-off-by: line(s)\n");
6603 } elsif (!$authorsignoff) {
6604 WARN("NO_AUTHOR_SIGN_OFF",
6605 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6606 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006607 }
6608
Andy Whitcroft8905a672007-11-28 16:21:06 -08006609 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006610 if ($summary && !($clean == 1 && $quiet == 1)) {
6611 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006612 print "total: $cnt_error errors, $cnt_warn warnings, " .
6613 (($check)? "$cnt_chk checks, " : "") .
6614 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006615 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006616
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006617 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006618 # If there were any defects found and not already fixing them
6619 if (!$clean and !$fix) {
6620 print << "EOM"
6621
6622NOTE: For some of the reported defects, checkpatch may be able to
6623 mechanically convert to the typical style using --fix or --fix-inplace.
6624EOM
6625 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006626 # If there were whitespace errors which cleanpatch can fix
6627 # then suggest that.
6628 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006629 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006630 print << "EOM"
6631
6632NOTE: Whitespace errors detected.
6633 You may wish to use scripts/cleanpatch or scripts/cleanfile
6634EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006635 }
6636 }
6637
Joe Perchesd752fcc2014-08-06 16:11:05 -07006638 if ($clean == 0 && $fix &&
6639 ("@rawlines" ne "@fixed" ||
6640 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006641 my $newfile = $filename;
6642 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006643 my $linecount = 0;
6644 my $f;
6645
Joe Perchesd752fcc2014-08-06 16:11:05 -07006646 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6647
Joe Perches3705ce52013-07-03 15:05:31 -07006648 open($f, '>', $newfile)
6649 or die "$P: Can't open $newfile for write\n";
6650 foreach my $fixed_line (@fixed) {
6651 $linecount++;
6652 if ($file) {
6653 if ($linecount > 3) {
6654 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006655 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006656 }
6657 } else {
6658 print $f $fixed_line . "\n";
6659 }
6660 }
6661 close($f);
6662
6663 if (!$quiet) {
6664 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006665
Joe Perches3705ce52013-07-03 15:05:31 -07006666Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6667
6668Do _NOT_ trust the results written to this file.
6669Do _NOT_ submit these changes without inspecting them for correctness.
6670
6671This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6672No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006673EOM
6674 }
6675 }
6676
Joe Perchesd8469f12015-06-25 15:03:00 -07006677 if ($quiet == 0) {
6678 print "\n";
6679 if ($clean == 1) {
6680 print "$vname has no obvious style problems and is ready for submission.\n";
6681 } else {
6682 print "$vname has style problems, please review.\n";
6683 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006684 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006685 return $clean;
6686}