blob: 23697a6b1eaada0ca51ec27e5e073638064a3387 [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 Whitcroft015830be2010-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -070017
18my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080019my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070020
Joe Perches000d1cc12011-07-25 17:13:25 -070021my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070022
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
Dwaipayan Ray52178ce2021-02-26 15:08:26 +053026my $verbose = 0;
27my %verbose_messages = ();
28my %verbose_emitted = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070029my $tree = 1;
30my $chk_signoff = 1;
31my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070032my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070035my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070037my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070038my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070039my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070040my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080041my $summary = 1;
42my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070044my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070045my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070046my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080047my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070048my $root;
Joe Perches0f7f6352020-10-24 16:59:04 -070049my $gitroot = $ENV{'GIT_DIR'};
50$gitroot = ".git" if !defined($gitroot);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080051my %debug;
Joe Perches34456862013-07-03 15:05:34 -070052my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070053my %use_type = ();
54my @use = ();
55my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070056my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070057my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070058my $configuration_file = ".checkpatch.conf";
Joe Perchesbdc48fa2020-05-29 16:12:21 -070059my $max_line_length = 100;
Dave Hansend62a2012013-09-11 14:23:56 -070060my $ignore_perl_version = 0;
61my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070062my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070063my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070064my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070065my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070066my $conststructsfile = "$D/const_structs.checkpatch";
Dwaipayan Ray52178ce2021-02-26 15:08:26 +053067my $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst";
Quentin Monnetced69da12020-08-11 18:35:13 -070068my $typedefsfile;
John Brooks737c0762017-07-10 15:52:24 -070069my $color = "auto";
Vadim Bendebury98005e82019-03-07 16:28:38 -080070my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
Joe Perchesdbbf8692019-09-25 16:46:52 -070071# git output parsing needs US English output, so first set backtick child process LANGUAGE
72my $git_command ='export LANGUAGE=en_US.UTF-8; git';
Antonio Borneo713a09d2020-04-06 20:11:07 -070073my $tabsize = 8;
Jerome Forissier3e89ad82020-10-15 20:11:49 -070074my ${CONFIG_} = "CONFIG_";
Hannes Eder77f5b102009-09-21 17:04:37 -070075
76sub help {
77 my ($exitcode) = @_;
78
79 print << "EOM";
80Usage: $P [OPTION]... [FILE]...
81Version: $V
82
83Options:
84 -q, --quiet quiet
Dwaipayan Ray52178ce2021-02-26 15:08:26 +053085 -v, --verbose verbose mode
Hannes Eder77f5b102009-09-21 17:04:37 -070086 --no-tree run without a kernel tree
87 --no-signoff do not check for 'Signed-off-by' line
88 --patch treat FILE as patchfile (default)
89 --emacs emacs compile window format
90 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070091 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070092 -g, --git treat FILE as a single commit or git revision range
93 single git commit with:
94 <rev>
95 <rev>^
96 <rev>~n
97 multiple git commits with:
98 <rev1>..<rev2>
99 <rev1>...<rev2>
100 <rev>-<count>
101 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -0700102 -f, --file treat FILE as regular source file
103 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -0700104 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -0700105 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -0700106 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -0700107 --show-types show the specific message type in the output
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700108 --max-line-length=n set the maximum line length, (default $max_line_length)
109 if exceeded, warn on patches
110 requires --strict for use with --file
Vadim Bendebury56193272014-10-13 15:51:48 -0700111 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700112 --tab-size=n set the number of spaces for tab (default $tabsize)
Hannes Eder77f5b102009-09-21 17:04:37 -0700113 --root=PATH PATH to the kernel tree root
114 --no-summary suppress the per-file summary
115 --mailback only produce a report in case of warnings/errors
116 --summary-file include the filename in summary
117 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
118 'values', 'possible', 'type', and 'attr' (default
119 is all off)
120 --test-only=WORD report only warnings/errors containing WORD
121 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700122 --fix EXPERIMENTAL - may create horrible results
123 If correctable single-line errors exist, create
124 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
125 with potential errors corrected to the preferred
126 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800127 --fix-inplace EXPERIMENTAL - may create horrible results
128 Is the same as --fix, but overwrites the input
129 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700130 --ignore-perl-version override checking of perl version. expect
131 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700132 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700133 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700134 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700135 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700136 --color[=WHEN] Use colors 'always', 'never', or only when output
137 is a terminal ('auto'). Default is 'auto'.
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700138 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default
139 ${CONFIG_})
Hannes Eder77f5b102009-09-21 17:04:37 -0700140 -h, --help, --version display this help and exit
141
142When FILE is - read standard input.
143EOM
144
145 exit($exitcode);
146}
147
Joe Perches3beb42e2016-05-20 17:04:14 -0700148sub uniq {
149 my %seen;
150 return grep { !$seen{$_}++ } @_;
151}
152
153sub list_types {
154 my ($exitcode) = @_;
155
156 my $count = 0;
157
158 local $/ = undef;
159
160 open(my $script, '<', abs_path($P)) or
161 die "$P: Can't read '$P' $!\n";
162
163 my $text = <$script>;
164 close($script);
165
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530166 my %types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700167 # Also catch when type or level is passed through a variable
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530168 while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
169 if (defined($1)) {
170 if (exists($types{$2})) {
171 $types{$2} .= ",$1" if ($types{$2} ne $1);
172 } else {
173 $types{$2} = $1;
174 }
175 } else {
176 $types{$2} = "UNDETERMINED";
177 }
Joe Perches3beb42e2016-05-20 17:04:14 -0700178 }
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530179
Joe Perches3beb42e2016-05-20 17:04:14 -0700180 print("#\tMessage type\n\n");
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530181 if ($color) {
182 print(" ( Color coding: ");
183 print(RED . "ERROR" . RESET);
184 print(" | ");
185 print(YELLOW . "WARNING" . RESET);
186 print(" | ");
187 print(GREEN . "CHECK" . RESET);
188 print(" | ");
189 print("Multiple levels / Undetermined");
190 print(" )\n\n");
191 }
192
193 foreach my $type (sort keys %types) {
194 my $orig_type = $type;
195 if ($color) {
196 my $level = $types{$type};
197 if ($level eq "ERROR") {
198 $type = RED . $type . RESET;
199 } elsif ($level eq "WARN") {
200 $type = YELLOW . $type . RESET;
201 } elsif ($level eq "CHK") {
202 $type = GREEN . $type . RESET;
203 }
204 }
Joe Perches3beb42e2016-05-20 17:04:14 -0700205 print(++$count . "\t" . $type . "\n");
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530206 if ($verbose && exists($verbose_messages{$orig_type})) {
207 my $message = $verbose_messages{$orig_type};
208 $message =~ s/\n/\n\t/g;
209 print("\t" . $message . "\n\n");
210 }
Joe Perches3beb42e2016-05-20 17:04:14 -0700211 }
212
213 exit($exitcode);
214}
215
Joe Perches000d1cc12011-07-25 17:13:25 -0700216my $conf = which_conf($configuration_file);
217if (-f $conf) {
218 my @conf_args;
219 open(my $conffile, '<', "$conf")
220 or warn "$P: Can't find a readable $configuration_file file $!\n";
221
222 while (<$conffile>) {
223 my $line = $_;
224
225 $line =~ s/\s*\n?$//g;
226 $line =~ s/^\s*//g;
227 $line =~ s/\s+/ /g;
228
229 next if ($line =~ m/^\s*#/);
230 next if ($line =~ m/^\s*$/);
231
232 my @words = split(" ", $line);
233 foreach my $word (@words) {
234 last if ($word =~ m/^#/);
235 push (@conf_args, $word);
236 }
237 }
238 close($conffile);
239 unshift(@ARGV, @conf_args) if @conf_args;
240}
241
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530242sub load_docs {
243 open(my $docs, '<', "$docsfile")
244 or warn "$P: Can't read the documentation file $docsfile $!\n";
245
246 my $type = '';
247 my $desc = '';
248 my $in_desc = 0;
249
250 while (<$docs>) {
251 chomp;
252 my $line = $_;
253 $line =~ s/\s+$//;
254
255 if ($line =~ /^\s*\*\*(.+)\*\*$/) {
256 if ($desc ne '') {
257 $verbose_messages{$type} = trim($desc);
258 }
259 $type = $1;
260 $desc = '';
261 $in_desc = 1;
262 } elsif ($in_desc) {
263 if ($line =~ /^(?:\s{4,}|$)/) {
264 $line =~ s/^\s{4}//;
265 $desc .= $line;
266 $desc .= "\n";
267 } else {
268 $verbose_messages{$type} = trim($desc);
269 $type = '';
270 $desc = '';
271 $in_desc = 0;
272 }
273 }
274 }
275
276 if ($desc ne '') {
277 $verbose_messages{$type} = trim($desc);
278 }
279 close($docs);
280}
281
John Brooks737c0762017-07-10 15:52:24 -0700282# Perl's Getopt::Long allows options to take optional arguments after a space.
283# Prevent --color by itself from consuming other arguments
284foreach (@ARGV) {
285 if ($_ eq "--color" || $_ eq "-color") {
286 $_ = "--color=$color";
287 }
288}
289
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700290GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700291 'q|quiet+' => \$quiet,
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530292 'v|verbose!' => \$verbose,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700293 'tree!' => \$tree,
294 'signoff!' => \$chk_signoff,
295 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700296 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800297 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700298 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700299 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700300 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700301 'subjective!' => \$check,
302 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700303 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700304 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700305 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700306 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800307 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700308 'min-conf-desc-length=i' => \$min_conf_desc_length,
Antonio Borneo713a09d2020-04-06 20:11:07 -0700309 'tab-size=i' => \$tabsize,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700310 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311 'summary!' => \$summary,
312 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800313 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700314 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800315 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700316 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800317 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700318 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700319 'codespell!' => \$codespell,
320 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700321 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700322 'color=s' => \$color,
323 'no-color' => \$color, #keep old behaviors of -nocolor
324 'nocolor' => \$color, #keep old behaviors of -nocolor
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700325 'kconfig-prefix=s' => \${CONFIG_},
Hannes Eder77f5b102009-09-21 17:04:37 -0700326 'h|help' => \$help,
327 'version' => \$help
328) or help(1);
329
330help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700331
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530332die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
333die "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse);
334
335if ($color =~ /^[01]$/) {
336 $color = !$color;
337} elsif ($color =~ /^always$/i) {
338 $color = 1;
339} elsif ($color =~ /^never$/i) {
340 $color = 0;
341} elsif ($color =~ /^auto$/i) {
342 $color = (-t STDOUT);
343} else {
344 die "$P: Invalid color mode: $color\n";
345}
346
347load_docs() if ($verbose);
Joe Perches3beb42e2016-05-20 17:04:14 -0700348list_types(0) if ($list_types);
349
Joe Perches9624b8d2014-01-23 15:54:44 -0800350$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700351$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800352
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700353my $exit = 0;
354
Joe Perches5b579802018-08-21 21:57:33 -0700355my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700356if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700357 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700358 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700359 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700360}
361
Allen Hubbe45107ff2016-08-02 14:04:47 -0700362#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700363if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700364 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700365}
366
Antonio Borneo713a09d2020-04-06 20:11:07 -0700367# skip TAB size 1 to avoid additional checks on $tabsize - 1
Joe Perches32f30ca2020-06-04 16:50:40 -0700368die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
Antonio Borneo713a09d2020-04-06 20:11:07 -0700369
Joe Perches91bfe482013-09-11 14:23:59 -0700370sub hash_save_array_words {
371 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700372
Joe Perches91bfe482013-09-11 14:23:59 -0700373 my @array = split(/,/, join(',', @$arrayRef));
374 foreach my $word (@array) {
375 $word =~ s/\s*\n?$//g;
376 $word =~ s/^\s*//g;
377 $word =~ s/\s+/ /g;
378 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700379
Joe Perches91bfe482013-09-11 14:23:59 -0700380 next if ($word =~ m/^\s*#/);
381 next if ($word =~ m/^\s*$/);
382
383 $hashRef->{$word}++;
384 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700385}
386
Joe Perches91bfe482013-09-11 14:23:59 -0700387sub hash_show_words {
388 my ($hashRef, $prefix) = @_;
389
Joe Perches3c816e42015-06-25 15:03:29 -0700390 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700391 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700392 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700393 print " $word";
394 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700395 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700396 }
397}
398
399hash_save_array_words(\%ignore_type, \@ignore);
400hash_save_array_words(\%use_type, \@use);
401
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800402my $dbg_values = 0;
403my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700404my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700405my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800406for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800407 ## no critic
408 eval "\${dbg_$key} = '$debug{$key}';";
409 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800410}
411
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700412my $rpt_cleaners = 0;
413
Andy Whitcroft8905a672007-11-28 16:21:06 -0800414if ($terse) {
415 $emacs = 1;
416 $quiet++;
417}
418
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700419if ($tree) {
420 if (defined $root) {
421 if (!top_of_kernel_tree($root)) {
422 die "$P: $root: --root does not point at a valid tree\n";
423 }
424 } else {
425 if (top_of_kernel_tree('.')) {
426 $root = '.';
427 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
428 top_of_kernel_tree($1)) {
429 $root = $1;
430 }
431 }
432
433 if (!defined $root) {
434 print "Must be run from the top-level dir. of a kernel tree\n";
435 exit(2);
436 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700437}
438
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700439my $emitted_corrupt = 0;
440
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700441our $Ident = qr{
442 [A-Za-z_][A-Za-z\d_]*
443 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
444 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700445our $Storage = qr{extern|static|asmlinkage};
446our $Sparse = qr{
447 __user|
448 __kernel|
449 __force|
450 __iomem|
451 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800452 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700453 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700454 __refconst|
455 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800456 __rcu|
457 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700458 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800459our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
460our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
461our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
462our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
463our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700464
Wolfram Sang52131292010-03-05 13:43:51 -0800465# Notes to $Attribute:
466# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700467our $Attribute = qr{
468 const|
Joe Perchesb5e87362021-02-25 17:21:40 -0800469 volatile|
Joe Perches03f1df72010-10-26 14:23:16 -0700470 __percpu|
471 __nocast|
472 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200473 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700474 __packed__|
475 __packed2__|
476 __naked|
477 __maybe_unused|
478 __always_unused|
479 __noreturn|
480 __used|
481 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800482 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700483 __noclone|
484 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700485 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700486 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700487 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700488 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700489 ____cacheline_aligned|
490 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800491 ____cacheline_internodealigned_in_smp|
492 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700493 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700494our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700495our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700496our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
497our $Lval = qr{$Ident(?:$Member)*};
498
Joe Perches95e2c602013-07-03 15:05:20 -0700499our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
500our $Binary = qr{(?i)0b[01]+$Int_type?};
501our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
502our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700503our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800504our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800505our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
506our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
507our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800508our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700509our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800510our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700511our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700512our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700513our $Operators = qr{
514 <=|>=|==|!=|
515 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700516 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700517 }x;
518
Joe Perches91cb5192014-04-03 14:49:32 -0700519our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
520
Joe Perchesab7e23f2015-04-16 12:44:22 -0700521our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800522our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700523our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700524our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800525our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700526our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800527our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700528our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800529
Joe Perches15662b32011-10-31 17:13:12 -0700530our $NON_ASCII_UTF8 = qr{
531 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700532 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
533 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
534 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
535 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
536 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
537 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
538}x;
539
Joe Perches15662b32011-10-31 17:13:12 -0700540our $UTF8 = qr{
541 [\x09\x0A\x0D\x20-\x7E] # ASCII
542 | $NON_ASCII_UTF8
543}x;
544
Joe Perchese6176fa2015-06-25 15:02:49 -0700545our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800546our $typeOtherOSTypedefs = qr{(?x:
547 u_(?:char|short|int|long) | # bsd
548 u(?:nchar|short|int|long) # sysv
549)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700550our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700551 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700552 atomic_t
553)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700554our $typeTypedefs = qr{(?x:
555 $typeC99Typedefs\b|
556 $typeOtherOSTypedefs\b|
557 $typeKernelTypedefs\b
558)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700559
Joe Perches6d32f7a2015-11-06 16:31:37 -0800560our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
561
Joe Perches691e6692010-03-05 13:43:51 -0800562our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800563 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700564 (?:[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 -0800565 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700566 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700567 panic|
Joe Perches06668722013-11-12 15:10:07 -0800568 MODULE_[A-Z_]+|
569 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800570)};
571
Joe Perchese29a70f2019-03-07 16:28:35 -0800572our $allocFunctions = qr{(?x:
573 (?:(?:devm_)?
Joe Perches58f02262021-02-25 17:22:01 -0800574 (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800575 kstrdup(?:_const)? |
576 kmemdup(?:_nul)?) |
Christophe JAILLET461e1562020-04-20 18:13:58 -0700577 (?:\w+)?alloc_skb(?:_ip_align)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800578 # dev_alloc_skb/netdev_alloc_skb, et al
579 dma_alloc_coherent
580)};
581
Joe Perches20112472011-07-25 17:13:23 -0700582our $signature_tags = qr{(?xi:
583 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800584 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700585 Acked-by:|
586 Tested-by:|
587 Reviewed-by:|
588 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700589 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700590 To:|
591 Cc:
592)};
593
Joe Perchesadb2da82021-02-25 17:21:50 -0800594our $tracing_logging_tags = qr{(?xi:
595 [=-]*> |
596 <[=-]* |
597 \[ |
598 \] |
599 start |
600 called |
601 entered |
602 entry |
603 enter |
604 in |
605 inside |
606 here |
607 begin |
608 exit |
609 end |
610 done |
611 leave |
612 completed |
613 out |
614 return |
615 [\.\!:\s]*
616)};
617
Aditya Srivastava831242a2020-12-15 20:45:12 -0800618sub edit_distance_min {
619 my (@arr) = @_;
620 my $len = scalar @arr;
621 if ((scalar @arr) < 1) {
622 # if underflow, return
623 return;
624 }
625 my $min = $arr[0];
626 for my $i (0 .. ($len-1)) {
627 if ($arr[$i] < $min) {
628 $min = $arr[$i];
629 }
630 }
631 return $min;
632}
633
634sub get_edit_distance {
635 my ($str1, $str2) = @_;
636 $str1 = lc($str1);
637 $str2 = lc($str2);
638 $str1 =~ s/-//g;
639 $str2 =~ s/-//g;
640 my $len1 = length($str1);
641 my $len2 = length($str2);
642 # two dimensional array storing minimum edit distance
643 my @distance;
644 for my $i (0 .. $len1) {
645 for my $j (0 .. $len2) {
646 if ($i == 0) {
647 $distance[$i][$j] = $j;
648 } elsif ($j == 0) {
649 $distance[$i][$j] = $i;
650 } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) {
651 $distance[$i][$j] = $distance[$i - 1][$j - 1];
652 } else {
653 my $dist1 = $distance[$i][$j - 1]; #insert distance
654 my $dist2 = $distance[$i - 1][$j]; # remove
655 my $dist3 = $distance[$i - 1][$j - 1]; #replace
656 $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3);
657 }
658 }
659 }
660 return $distance[$len1][$len2];
661}
662
663sub find_standard_signature {
664 my ($sign_off) = @_;
665 my @standard_signature_tags = (
666 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
667 'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
668 );
669 foreach my $signature (@standard_signature_tags) {
670 return $signature if (get_edit_distance($sign_off, $signature) <= 2);
671 }
672
673 return "";
674}
675
Joe Perches18130872014-08-06 16:11:22 -0700676our @typeListMisordered = (
677 qr{char\s+(?:un)?signed},
678 qr{int\s+(?:(?:un)?signed\s+)?short\s},
679 qr{int\s+short(?:\s+(?:un)?signed)},
680 qr{short\s+int(?:\s+(?:un)?signed)},
681 qr{(?:un)?signed\s+int\s+short},
682 qr{short\s+(?:un)?signed},
683 qr{long\s+int\s+(?:un)?signed},
684 qr{int\s+long\s+(?:un)?signed},
685 qr{long\s+(?:un)?signed\s+int},
686 qr{int\s+(?:un)?signed\s+long},
687 qr{int\s+(?:un)?signed},
688 qr{int\s+long\s+long\s+(?:un)?signed},
689 qr{long\s+long\s+int\s+(?:un)?signed},
690 qr{long\s+long\s+(?:un)?signed\s+int},
691 qr{long\s+long\s+(?:un)?signed},
692 qr{long\s+(?:un)?signed},
693);
694
Andy Whitcroft8905a672007-11-28 16:21:06 -0800695our @typeList = (
696 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700697 qr{(?:(?:un)?signed\s+)?char},
698 qr{(?:(?:un)?signed\s+)?short\s+int},
699 qr{(?:(?:un)?signed\s+)?short},
700 qr{(?:(?:un)?signed\s+)?int},
701 qr{(?:(?:un)?signed\s+)?long\s+int},
702 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
703 qr{(?:(?:un)?signed\s+)?long\s+long},
704 qr{(?:(?:un)?signed\s+)?long},
705 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800706 qr{float},
707 qr{double},
708 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800709 qr{struct\s+$Ident},
710 qr{union\s+$Ident},
711 qr{enum\s+$Ident},
712 qr{${Ident}_t},
713 qr{${Ident}_handler},
714 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700715 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800716);
Joe Perches938224b2016-01-20 14:59:15 -0800717
718our $C90_int_types = qr{(?x:
719 long\s+long\s+int\s+(?:un)?signed|
720 long\s+long\s+(?:un)?signed\s+int|
721 long\s+long\s+(?:un)?signed|
722 (?:(?:un)?signed\s+)?long\s+long\s+int|
723 (?:(?:un)?signed\s+)?long\s+long|
724 int\s+long\s+long\s+(?:un)?signed|
725 int\s+(?:(?:un)?signed\s+)?long\s+long|
726
727 long\s+int\s+(?:un)?signed|
728 long\s+(?:un)?signed\s+int|
729 long\s+(?:un)?signed|
730 (?:(?:un)?signed\s+)?long\s+int|
731 (?:(?:un)?signed\s+)?long|
732 int\s+long\s+(?:un)?signed|
733 int\s+(?:(?:un)?signed\s+)?long|
734
735 int\s+(?:un)?signed|
736 (?:(?:un)?signed\s+)?int
737)};
738
Alex Dowad485ff232015-06-25 15:02:52 -0700739our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700740our @typeListWithAttr = (
741 @typeList,
742 qr{struct\s+$InitAttribute\s+$Ident},
743 qr{union\s+$InitAttribute\s+$Ident},
744);
745
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700746our @modifierList = (
747 qr{fastcall},
748);
Alex Dowad485ff232015-06-25 15:02:52 -0700749our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800750
Joe Perches24358802014-04-03 14:49:13 -0700751our @mode_permission_funcs = (
752 ["module_param", 3],
753 ["module_param_(?:array|named|string)", 4],
754 ["module_param_array_named", 5],
755 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
756 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700757 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
758 ["IIO_DEV_ATTR_[A-Z_]+", 1],
759 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
760 ["SENSOR_TEMPLATE(?:_2|)", 3],
761 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700762);
763
Joe Perches1a3dcf22020-08-11 18:35:16 -0700764my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
765
Joe Perches515a2352014-04-03 14:49:24 -0700766#Create a search pattern for all these functions to speed up a loop below
767our $mode_perms_search = "";
768foreach my $entry (@mode_permission_funcs) {
769 $mode_perms_search .= '|' if ($mode_perms_search ne "");
770 $mode_perms_search .= $entry->[0];
771}
Joe Perches00180462018-02-06 15:38:55 -0800772$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700773
Joe Perches9189c7e2018-09-07 15:26:18 -0700774our %deprecated_apis = (
775 "synchronize_rcu_bh" => "synchronize_rcu",
776 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
777 "call_rcu_bh" => "call_rcu",
778 "rcu_barrier_bh" => "rcu_barrier",
779 "synchronize_sched" => "synchronize_rcu",
780 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
781 "call_rcu_sched" => "call_rcu",
782 "rcu_barrier_sched" => "rcu_barrier",
783 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
784 "cond_synchronize_sched" => "cond_synchronize_rcu",
785);
786
787#Create a search pattern for all these strings to speed up a loop below
788our $deprecated_apis_search = "";
789foreach my $entry (keys %deprecated_apis) {
790 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
791 $deprecated_apis_search .= $entry;
792}
793$deprecated_apis_search = "(?:${deprecated_apis_search})";
794
Joe Perchesb392c642015-04-16 12:44:16 -0700795our $mode_perms_world_writable = qr{
796 S_IWUGO |
797 S_IWOTH |
798 S_IRWXUGO |
799 S_IALLUGO |
800 0[0-7][0-7][2367]
801}x;
802
Joe Perchesf90774e2016-10-11 13:51:47 -0700803our %mode_permission_string_types = (
804 "S_IRWXU" => 0700,
805 "S_IRUSR" => 0400,
806 "S_IWUSR" => 0200,
807 "S_IXUSR" => 0100,
808 "S_IRWXG" => 0070,
809 "S_IRGRP" => 0040,
810 "S_IWGRP" => 0020,
811 "S_IXGRP" => 0010,
812 "S_IRWXO" => 0007,
813 "S_IROTH" => 0004,
814 "S_IWOTH" => 0002,
815 "S_IXOTH" => 0001,
816 "S_IRWXUGO" => 0777,
817 "S_IRUGO" => 0444,
818 "S_IWUGO" => 0222,
819 "S_IXUGO" => 0111,
820);
821
822#Create a search pattern for all these strings to speed up a loop below
823our $mode_perms_string_search = "";
824foreach my $entry (keys %mode_permission_string_types) {
825 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
826 $mode_perms_string_search .= $entry;
827}
Joe Perches00180462018-02-06 15:38:55 -0800828our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
829our $multi_mode_perms_string_search = qr{
830 ${single_mode_perms_string_search}
831 (?:\s*\|\s*${single_mode_perms_string_search})*
832}x;
833
834sub perms_to_octal {
835 my ($string) = @_;
836
837 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
838
839 my $val = "";
840 my $oval = "";
841 my $to = 0;
842 my $curpos = 0;
843 my $lastpos = 0;
844 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
845 $curpos = pos($string);
846 my $match = $2;
847 my $omatch = $1;
848 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
849 $lastpos = $curpos;
850 $to |= $mode_permission_string_types{$match};
851 $val .= '\s*\|\s*' if ($val ne "");
852 $val .= $match;
853 $oval .= $omatch;
854 }
855 $oval =~ s/^\s*\|\s*//;
856 $oval =~ s/\s*\|\s*$//;
857 return sprintf("%04o", $to);
858}
Joe Perchesf90774e2016-10-11 13:51:47 -0700859
Wolfram Sang7840a942010-08-09 17:20:57 -0700860our $allowed_asm_includes = qr{(?x:
861 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700862 memory|
863 time|
864 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700865)};
866# memory.h: ARM has a custom one
867
Kees Cook66b47b42014-10-13 15:51:57 -0700868# Load common spelling mistakes and build regular expression list.
869my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700870my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700871
Joe Perches36061e32014-12-10 15:51:43 -0800872if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800873 while (<$spelling>) {
874 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700875
Joe Perches36061e32014-12-10 15:51:43 -0800876 $line =~ s/\s*\n?$//g;
877 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700878
Joe Perches36061e32014-12-10 15:51:43 -0800879 next if ($line =~ m/^\s*#/);
880 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700881
Joe Perches36061e32014-12-10 15:51:43 -0800882 my ($suspect, $fix) = split(/\|\|/, $line);
883
Joe Perches36061e32014-12-10 15:51:43 -0800884 $spelling_fix{$suspect} = $fix;
885 }
886 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800887} else {
888 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700889}
Kees Cook66b47b42014-10-13 15:51:57 -0700890
Joe Perchesebfd7d62015-04-16 12:44:14 -0700891if ($codespell) {
892 if (open(my $spelling, '<', $codespellfile)) {
893 while (<$spelling>) {
894 my $line = $_;
895
896 $line =~ s/\s*\n?$//g;
897 $line =~ s/^\s*//g;
898
899 next if ($line =~ m/^\s*#/);
900 next if ($line =~ m/^\s*$/);
901 next if ($line =~ m/, disabled/i);
902
903 $line =~ s/,.*$//;
904
905 my ($suspect, $fix) = split(/->/, $line);
906
907 $spelling_fix{$suspect} = $fix;
908 }
909 close($spelling);
910 } else {
911 warn "No codespell typos will be found - file '$codespellfile': $!\n";
912 }
913}
914
915$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
916
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700917sub read_words {
918 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700919
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700920 if (open(my $words, '<', $file)) {
921 while (<$words>) {
922 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700923
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700924 $line =~ s/\s*\n?$//g;
925 $line =~ s/^\s*//g;
926
927 next if ($line =~ m/^\s*#/);
928 next if ($line =~ m/^\s*$/);
929 if ($line =~ /\s/) {
930 print("$file: '$line' invalid - ignored\n");
931 next;
932 }
933
Quentin Monnetced69da12020-08-11 18:35:13 -0700934 $$wordsRef .= '|' if (defined $$wordsRef);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700935 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700936 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700937 close($file);
938 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700939 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700940
941 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700942}
943
Quentin Monnetced69da12020-08-11 18:35:13 -0700944my $const_structs;
945if (show_type("CONST_STRUCT")) {
946 read_words(\$const_structs, $conststructsfile)
947 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
948}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700949
Quentin Monnetced69da12020-08-11 18:35:13 -0700950if (defined($typedefsfile)) {
951 my $typeOtherTypedefs;
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700952 read_words(\$typeOtherTypedefs, $typedefsfile)
953 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
Quentin Monnetced69da12020-08-11 18:35:13 -0700954 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700955}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700956
Andy Whitcroft8905a672007-11-28 16:21:06 -0800957sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700958 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
959 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700960 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700961 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700962 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700963 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700964 (?:$typeTypedefs\b)|
965 (?:${all}\b)
966 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800967 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700968 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800969 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800970 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700971 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700972 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800973 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700974 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800975 }x;
Joe Perches18130872014-08-06 16:11:22 -0700976 $NonptrTypeMisordered = qr{
977 (?:$Modifier\s+|const\s+)*
978 (?:
979 (?:${Misordered}\b)
980 )
981 (?:\s+$Modifier|\s+const)*
982 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700983 $NonptrTypeWithAttr = qr{
984 (?:$Modifier\s+|const\s+)*
985 (?:
986 (?:typeof|__typeof__)\s*\([^\)]*\)|
987 (?:$typeTypedefs\b)|
988 (?:${allWithAttr}\b)
989 )
990 (?:\s+$Modifier|\s+const)*
991 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800992 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700993 $NonptrType
Antonio Borneo7b184962020-04-06 20:11:04 -0700994 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700995 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800996 }x;
Joe Perches18130872014-08-06 16:11:22 -0700997 $TypeMisordered = qr{
998 $NonptrTypeMisordered
Antonio Borneo7b184962020-04-06 20:11:04 -0700999 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Perches18130872014-08-06 16:11:22 -07001000 (?:\s+$Inline|\s+$Modifier)*
1001 }x;
Joe Perches91cb5192014-04-03 14:49:32 -07001002 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -07001003 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -08001004}
1005build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001006
Joe Perches7d2367a2011-07-25 17:13:22 -07001007our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001008
1009# Using $balanced_parens, $LvalOrFunc, or $FuncArg
1010# requires at least perl version v5.10.0
1011# Any use must be runtime checked with $^V
1012
1013our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -07001014our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -08001015our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -07001016
Joe Perchesf8422302014-08-06 16:11:31 -07001017our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -07001018 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -07001019 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -07001020 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -07001021)};
1022
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08001023our %allow_repeated_words = (
1024 add => '',
1025 added => '',
1026 bad => '',
1027 be => '',
1028);
1029
Joe Perches7d2367a2011-07-25 17:13:22 -07001030sub deparenthesize {
1031 my ($string) = @_;
1032 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -07001033
1034 while ($string =~ /^\s*\(.*\)\s*$/) {
1035 $string =~ s@^\s*\(\s*@@;
1036 $string =~ s@\s*\)\s*$@@;
1037 }
1038
Joe Perches7d2367a2011-07-25 17:13:22 -07001039 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -07001040
Joe Perches7d2367a2011-07-25 17:13:22 -07001041 return $string;
1042}
1043
Joe Perches34456862013-07-03 15:05:34 -07001044sub seed_camelcase_file {
1045 my ($file) = @_;
1046
1047 return if (!(-f $file));
1048
1049 local $/;
1050
1051 open(my $include_file, '<', "$file")
1052 or warn "$P: Can't read '$file' $!\n";
1053 my $text = <$include_file>;
1054 close($include_file);
1055
1056 my @lines = split('\n', $text);
1057
1058 foreach my $line (@lines) {
1059 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
1060 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
1061 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -08001062 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
1063 $camelcase{$1} = 1;
1064 } 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 -07001065 $camelcase{$1} = 1;
1066 }
1067 }
1068}
1069
Joe Perchescd28b112019-12-04 16:52:09 -08001070our %maintained_status = ();
1071
Joe Perches85b0ee12016-10-11 13:51:44 -07001072sub is_maintained_obsolete {
1073 my ($filename) = @_;
1074
Jerome Forissierf2c19c22016-12-12 16:46:23 -08001075 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -07001076
Joe Perchescd28b112019-12-04 16:52:09 -08001077 if (!exists($maintained_status{$filename})) {
1078 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1079 }
Joe Perches85b0ee12016-10-11 13:51:44 -07001080
Joe Perchescd28b112019-12-04 16:52:09 -08001081 return $maintained_status{$filename} =~ /obsolete/i;
Joe Perches85b0ee12016-10-11 13:51:44 -07001082}
1083
Joe Perches3b6e8ac2018-08-21 21:57:47 -07001084sub is_SPDX_License_valid {
1085 my ($license) = @_;
1086
Joe Perches0f7f6352020-10-24 16:59:04 -07001087 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -07001088
Joe Perches56294112018-08-21 21:58:04 -07001089 my $root_path = abs_path($root);
1090 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -07001091 return 0 if ($status ne "");
1092 return 1;
1093}
1094
Joe Perches34456862013-07-03 15:05:34 -07001095my $camelcase_seeded = 0;
1096sub seed_camelcase_includes {
1097 return if ($camelcase_seeded);
1098
1099 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -07001100 my $camelcase_cache = "";
1101 my @include_files = ();
1102
1103 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -07001104
Joe Perches0f7f6352020-10-24 16:59:04 -07001105 if (-e "$gitroot") {
Joe Perchesdbbf8692019-09-25 16:46:52 -07001106 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -07001107 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -07001108 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -07001109 } else {
Joe Perchesc707a812013-07-08 16:00:43 -07001110 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -07001111 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -07001112 @include_files = split('\n', $files);
1113 foreach my $file (@include_files) {
1114 my $date = POSIX::strftime("%Y%m%d%H%M",
1115 localtime((stat $file)[9]));
1116 $last_mod_date = $date if ($last_mod_date < $date);
1117 }
1118 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -07001119 }
Joe Perchesc707a812013-07-08 16:00:43 -07001120
1121 if ($camelcase_cache ne "" && -f $camelcase_cache) {
1122 open(my $camelcase_file, '<', "$camelcase_cache")
1123 or warn "$P: Can't read '$camelcase_cache' $!\n";
1124 while (<$camelcase_file>) {
1125 chomp;
1126 $camelcase{$_} = 1;
1127 }
1128 close($camelcase_file);
1129
1130 return;
1131 }
1132
Joe Perches0f7f6352020-10-24 16:59:04 -07001133 if (-e "$gitroot") {
Joe Perchesdbbf8692019-09-25 16:46:52 -07001134 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -07001135 @include_files = split('\n', $files);
1136 }
1137
Joe Perches34456862013-07-03 15:05:34 -07001138 foreach my $file (@include_files) {
1139 seed_camelcase_file($file);
1140 }
Joe Perches351b2a12013-07-03 15:05:36 -07001141
Joe Perchesc707a812013-07-08 16:00:43 -07001142 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -07001143 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -07001144 open(my $camelcase_file, '>', "$camelcase_cache")
1145 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -07001146 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
1147 print $camelcase_file ("$_\n");
1148 }
1149 close($camelcase_file);
1150 }
Joe Perches34456862013-07-03 15:05:34 -07001151}
1152
Joe Perchesf5f61322020-10-15 20:12:12 -07001153sub git_is_single_file {
1154 my ($filename) = @_;
1155
1156 return 0 if ((which("git") eq "") || !(-e "$gitroot"));
1157
1158 my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
1159 my $count = $output =~ tr/\n//;
1160 return $count eq 1 && $output =~ m{^${filename}$};
1161}
1162
Joe Perchesd311cd42014-08-06 16:10:57 -07001163sub git_commit_info {
1164 my ($commit, $id, $desc) = @_;
1165
Joe Perches0f7f6352020-10-24 16:59:04 -07001166 return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
Joe Perchesd311cd42014-08-06 16:10:57 -07001167
Joe Perchesdbbf8692019-09-25 16:46:52 -07001168 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -07001169 $output =~ s/^\s*//gm;
1170 my @lines = split("\n", $output);
1171
Joe Perches0d7835f2015-02-13 14:38:35 -08001172 return ($id, $desc) if ($#lines < 0);
1173
Sean Christopherson5a7f4452019-09-25 16:46:49 -07001174 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -07001175# Maybe one day convert this block of bash into something that returns
1176# all matching commit ids, but it's very slow...
1177#
1178# echo "checking commits $1..."
1179# git rev-list --remotes | grep -i "^$1" |
1180# while read line ; do
1181# git log --format='%H %s' -1 $line |
1182# echo "commit $(cut -c 1-12,41-)"
1183# done
1184 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07001185 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -07001186 } else {
1187 $id = substr($lines[0], 0, 12);
1188 $desc = substr($lines[0], 41);
1189 }
1190
1191 return ($id, $desc);
1192}
1193
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194$chk_signoff = 0 if ($file);
1195
Andy Whitcroft00df3442007-06-08 13:47:06 -07001196my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001197my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001198my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001199my @fixed_inserted = ();
1200my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001201my $fixlinenr = -1;
1202
Du, Changbin4a593c32016-05-20 17:04:16 -07001203# If input is git commits, extract all commits from the commit expressions.
1204# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
Joe Perches0f7f6352020-10-24 16:59:04 -07001205die "$P: No git repository found\n" if ($git && !-e "$gitroot");
Du, Changbin4a593c32016-05-20 17:04:16 -07001206
1207if ($git) {
1208 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001209 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001210 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001211 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1212 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001213 } elsif ($commit_expr =~ m/\.\./) {
1214 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001215 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001216 $git_range = "-1 $commit_expr";
1217 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001218 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001219 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001220 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1221 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001222 my $sha1 = $1;
1223 my $subject = $2;
1224 unshift(@commits, $sha1);
1225 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001226 }
1227 }
1228 die "$P: no git commits after extraction!\n" if (@commits == 0);
1229 @ARGV = @commits;
1230}
1231
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001232my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001233$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001234for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001235 my $FILE;
Joe Perchesf5f61322020-10-15 20:12:12 -07001236 my $is_git_file = git_is_single_file($filename);
1237 my $oldfile = $file;
1238 $file = 1 if ($is_git_file);
Du, Changbin4a593c32016-05-20 17:04:16 -07001239 if ($git) {
1240 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1241 die "$P: $filename: git format-patch failed - $!\n";
1242 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001243 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001244 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001245 } elsif ($filename eq '-') {
1246 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001247 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001248 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001249 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001250 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001251 if ($filename eq '-') {
1252 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001253 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001254 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001255 } else {
1256 $vname = $filename;
1257 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001258 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001259 chomp;
1260 push(@rawlines, $_);
Geert Uytterhoevenc7f574d2020-06-04 16:50:43 -07001261 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001262 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001263 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001264
1265 if ($#ARGV > 0 && $quiet == 0) {
1266 print '-' x length($vname) . "\n";
1267 print "$vname\n";
1268 print '-' x length($vname) . "\n";
1269 }
1270
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001271 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001272 $exit = 1;
1273 }
1274 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001275 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001276 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001277 @fixed_inserted = ();
1278 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001279 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001280 @modifierListFile = ();
1281 @typeListFile = ();
1282 build_types();
Joe Perchesf5f61322020-10-15 20:12:12 -07001283 $file = $oldfile if ($is_git_file);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001284}
1285
Joe Perchesd8469f12015-06-25 15:03:00 -07001286if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001287 hash_show_words(\%use_type, "Used");
1288 hash_show_words(\%ignore_type, "Ignored");
1289
Joe Perches5b579802018-08-21 21:57:33 -07001290 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001291 print << "EOM"
1292
1293NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001294 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001295EOM
1296 }
1297 if ($exit) {
1298 print << "EOM"
1299
1300NOTE: If any of the errors are false positives, please report
1301 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1302EOM
1303 }
1304}
1305
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001306exit($exit);
1307
1308sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001309 my ($root) = @_;
1310
1311 my @tree_check = (
1312 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1313 "README", "Documentation", "arch", "include", "drivers",
1314 "fs", "init", "ipc", "kernel", "lib", "scripts",
1315 );
1316
1317 foreach my $check (@tree_check) {
1318 if (! -e $root . '/' . $check) {
1319 return 0;
1320 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001321 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001322 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001323}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001324
Joe Perches20112472011-07-25 17:13:23 -07001325sub parse_email {
1326 my ($formatted_email) = @_;
1327
1328 my $name = "";
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001329 my $quoted = "";
Joe Perchesdfa05c22020-04-06 20:10:48 -07001330 my $name_comment = "";
Joe Perches20112472011-07-25 17:13:23 -07001331 my $address = "";
1332 my $comment = "";
1333
1334 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1335 $name = $1;
1336 $address = $2;
1337 $comment = $3 if defined $3;
1338 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1339 $address = $1;
1340 $comment = $2 if defined $2;
1341 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1342 $address = $1;
1343 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001344 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001345 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001346 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001347 $name =~ s/^\"|\"$//g;
1348 # If there's a name left after stripping spaces and
1349 # leading quotes, and the address doesn't have both
1350 # leading and trailing angle brackets, the address
1351 # is invalid. ie:
1352 # "joe smith joe@smith.com" bad
1353 # "joe smith <joe@smith.com" bad
1354 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1355 $name = "";
1356 $address = "";
1357 $comment = "";
1358 }
1359 }
1360
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001361 # Extract comments from names excluding quoted parts
1362 # "John D. (Doe)" - Do not extract
1363 if ($name =~ s/\"(.+)\"//) {
1364 $quoted = $1;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001365 }
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001366 while ($name =~ s/\s*($balanced_parens)\s*/ /) {
1367 $name_comment .= trim($1);
1368 }
1369 $name =~ s/^[ \"]+|[ \"]+$//g;
1370 $name = trim("$quoted $name");
1371
Joe Perches3705ce52013-07-03 15:05:31 -07001372 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001373 $address =~ s/^\<|\>$//g;
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001374 $comment = trim($comment);
Joe Perches20112472011-07-25 17:13:23 -07001375
1376 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1377 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1378 $name = "\"$name\"";
1379 }
1380
Joe Perchesdfa05c22020-04-06 20:10:48 -07001381 return ($name, $name_comment, $address, $comment);
Joe Perches20112472011-07-25 17:13:23 -07001382}
1383
1384sub format_email {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001385 my ($name, $name_comment, $address, $comment) = @_;
Joe Perches20112472011-07-25 17:13:23 -07001386
1387 my $formatted_email;
1388
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001389 $name =~ s/^[ \"]+|[ \"]+$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001390 $address = trim($address);
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001391 $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes
Joe Perches20112472011-07-25 17:13:23 -07001392
1393 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1394 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1395 $name = "\"$name\"";
1396 }
1397
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001398 $name_comment = trim($name_comment);
1399 $name_comment = " $name_comment" if ($name_comment ne "");
1400 $comment = trim($comment);
1401 $comment = " $comment" if ($comment ne "");
1402
Joe Perches20112472011-07-25 17:13:23 -07001403 if ("$name" eq "") {
1404 $formatted_email = "$address";
1405 } else {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001406 $formatted_email = "$name$name_comment <$address>";
Joe Perches20112472011-07-25 17:13:23 -07001407 }
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001408 $formatted_email .= "$comment";
Joe Perches20112472011-07-25 17:13:23 -07001409 return $formatted_email;
1410}
1411
Joe Perchesdfa05c22020-04-06 20:10:48 -07001412sub reformat_email {
1413 my ($email) = @_;
1414
1415 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001416 return format_email($email_name, $name_comment, $email_address, $comment);
Joe Perchesdfa05c22020-04-06 20:10:48 -07001417}
1418
1419sub same_email_addresses {
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001420 my ($email1, $email2) = @_;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001421
1422 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1423 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1424
1425 return $email1_name eq $email2_name &&
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001426 $email1_address eq $email2_address &&
1427 $name1_comment eq $name2_comment &&
1428 $comment1 eq $comment2;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001429}
1430
Joe Perchesd311cd42014-08-06 16:10:57 -07001431sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001432 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001433
Joe Perchesbd474ca2014-08-06 16:11:10 -07001434 foreach my $path (split(/:/, $ENV{PATH})) {
1435 if (-e "$path/$bin") {
1436 return "$path/$bin";
1437 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001438 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001439
Joe Perchesbd474ca2014-08-06 16:11:10 -07001440 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001441}
1442
Joe Perches000d1cc12011-07-25 17:13:25 -07001443sub which_conf {
1444 my ($conf) = @_;
1445
1446 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1447 if (-e "$path/$conf") {
1448 return "$path/$conf";
1449 }
1450 }
1451
1452 return "";
1453}
1454
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001455sub expand_tabs {
1456 my ($str) = @_;
1457
1458 my $res = '';
1459 my $n = 0;
1460 for my $c (split(//, $str)) {
1461 if ($c eq "\t") {
1462 $res .= ' ';
1463 $n++;
Antonio Borneo713a09d2020-04-06 20:11:07 -07001464 for (; ($n % $tabsize) != 0; $n++) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001465 $res .= ' ';
1466 }
1467 next;
1468 }
1469 $res .= $c;
1470 $n++;
1471 }
1472
1473 return $res;
1474}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001475sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001476 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001477 return $res;
1478}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001479
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001480sub line_stats {
1481 my ($line) = @_;
1482
1483 # Drop the diff line leader and expand tabs
1484 $line =~ s/^.//;
1485 $line = expand_tabs($line);
1486
1487 # Pick the indent from the front of the line.
1488 my ($white) = ($line =~ /^(\s*)/);
1489
1490 return (length($line), length($white));
1491}
1492
Andy Whitcroft773647a2008-03-28 14:15:58 -07001493my $sanitise_quote = '';
1494
1495sub sanitise_line_reset {
1496 my ($in_comment) = @_;
1497
1498 if ($in_comment) {
1499 $sanitise_quote = '*/';
1500 } else {
1501 $sanitise_quote = '';
1502 }
1503}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001504sub sanitise_line {
1505 my ($line) = @_;
1506
1507 my $res = '';
1508 my $l = '';
1509
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001510 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001511 my $off = 0;
1512 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001513
Andy Whitcroft773647a2008-03-28 14:15:58 -07001514 # Always copy over the diff marker.
1515 $res = substr($line, 0, 1);
1516
1517 for ($off = 1; $off < length($line); $off++) {
1518 $c = substr($line, $off, 1);
1519
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001520 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001521 # and end, all to $;.
1522 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1523 $sanitise_quote = '*/';
1524
1525 substr($res, $off, 2, "$;$;");
1526 $off++;
1527 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001528 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001529 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001530 $sanitise_quote = '';
1531 substr($res, $off, 2, "$;$;");
1532 $off++;
1533 next;
1534 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001535 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1536 $sanitise_quote = '//';
1537
1538 substr($res, $off, 2, $sanitise_quote);
1539 $off++;
1540 next;
1541 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001542
1543 # A \ in a string means ignore the next character.
1544 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1545 $c eq "\\") {
1546 substr($res, $off, 2, 'XX');
1547 $off++;
1548 next;
1549 }
1550 # Regular quotes.
1551 if ($c eq "'" || $c eq '"') {
1552 if ($sanitise_quote eq '') {
1553 $sanitise_quote = $c;
1554
1555 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001556 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001557 } elsif ($sanitise_quote eq $c) {
1558 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001559 }
1560 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001561
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001562 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001563 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1564 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001565 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1566 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001567 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1568 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001569 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001570 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001571 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001572 }
1573
Daniel Walker113f04a2009-09-21 17:04:35 -07001574 if ($sanitise_quote eq '//') {
1575 $sanitise_quote = '';
1576 }
1577
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001578 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001579 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001580 my $clean = 'X' x length($1);
1581 $res =~ s@\<.*\>@<$clean>@;
1582
1583 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001584 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001585 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001586 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001587 }
1588
Joe Perchesdadf6802016-08-02 14:04:33 -07001589 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1590 my $match = $1;
1591 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1592 }
1593
Andy Whitcroft00df3442007-06-08 13:47:06 -07001594 return $res;
1595}
1596
Joe Perchesa6962d72013-04-29 16:18:13 -07001597sub get_quoted_string {
1598 my ($line, $rawline) = @_;
1599
Joe Perches478b1792018-04-10 16:33:34 -07001600 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001601 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001602 return substr($rawline, $-[0], $+[0] - $-[0]);
1603}
1604
Andy Whitcroft8905a672007-11-28 16:21:06 -08001605sub ctx_statement_block {
1606 my ($linenr, $remain, $off) = @_;
1607 my $line = $linenr - 1;
1608 my $blk = '';
1609 my $soff = $off;
1610 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001611 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001612
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001613 my $loff = 0;
1614
Andy Whitcroft8905a672007-11-28 16:21:06 -08001615 my $type = '';
1616 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001617 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001618 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001619 my $c;
1620 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001621
1622 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001623 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001624 @stack = (['', 0]) if ($#stack == -1);
1625
Andy Whitcroft773647a2008-03-28 14:15:58 -07001626 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001627 # If we are about to drop off the end, pull in more
1628 # context.
1629 if ($off >= $len) {
1630 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001631 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001632 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001633 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001634 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001636 $len = length($blk);
1637 $line++;
1638 last;
1639 }
1640 # Bail if there is no further context.
1641 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001642 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001643 last;
1644 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001645 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1646 $level++;
1647 $type = '#';
1648 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001649 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001650 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001651 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001652 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001653
Andy Whitcroft773647a2008-03-28 14:15:58 -07001654 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001655
1656 # Handle nested #if/#else.
1657 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1658 push(@stack, [ $type, $level ]);
1659 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1660 ($type, $level) = @{$stack[$#stack - 1]};
1661 } elsif ($remainder =~ /^#\s*endif\b/) {
1662 ($type, $level) = @{pop(@stack)};
1663 }
1664
Andy Whitcroft8905a672007-11-28 16:21:06 -08001665 # Statement ends at the ';' or a close '}' at the
1666 # outermost level.
1667 if ($level == 0 && $c eq ';') {
1668 last;
1669 }
1670
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001671 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001672 if ($level == 0 && $coff_set == 0 &&
1673 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1674 $remainder =~ /^(else)(?:\s|{)/ &&
1675 $remainder !~ /^else\s+if\b/) {
1676 $coff = $off + length($1) - 1;
1677 $coff_set = 1;
1678 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1679 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001680 }
1681
Andy Whitcroft8905a672007-11-28 16:21:06 -08001682 if (($type eq '' || $type eq '(') && $c eq '(') {
1683 $level++;
1684 $type = '(';
1685 }
1686 if ($type eq '(' && $c eq ')') {
1687 $level--;
1688 $type = ($level != 0)? '(' : '';
1689
1690 if ($level == 0 && $coff < $soff) {
1691 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001692 $coff_set = 1;
1693 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001694 }
1695 }
1696 if (($type eq '' || $type eq '{') && $c eq '{') {
1697 $level++;
1698 $type = '{';
1699 }
1700 if ($type eq '{' && $c eq '}') {
1701 $level--;
1702 $type = ($level != 0)? '{' : '';
1703
1704 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001705 if (substr($blk, $off + 1, 1) eq ';') {
1706 $off++;
1707 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001708 last;
1709 }
1710 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001711 # Preprocessor commands end at the newline unless escaped.
1712 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1713 $level--;
1714 $type = '';
1715 $off++;
1716 last;
1717 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001718 $off++;
1719 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001720 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001721 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001722 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001723 $line++;
1724 $remain--;
1725 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001726
1727 my $statement = substr($blk, $soff, $off - $soff + 1);
1728 my $condition = substr($blk, $soff, $coff - $soff + 1);
1729
1730 #warn "STATEMENT<$statement>\n";
1731 #warn "CONDITION<$condition>\n";
1732
Andy Whitcroft773647a2008-03-28 14:15:58 -07001733 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001734
1735 return ($statement, $condition,
1736 $line, $remain + 1, $off - $loff + 1, $level);
1737}
1738
Andy Whitcroftcf655042008-03-04 14:28:20 -08001739sub statement_lines {
1740 my ($stmt) = @_;
1741
1742 # Strip the diff line prefixes and rip blank lines at start and end.
1743 $stmt =~ s/(^|\n)./$1/g;
1744 $stmt =~ s/^\s*//;
1745 $stmt =~ s/\s*$//;
1746
1747 my @stmt_lines = ($stmt =~ /\n/g);
1748
1749 return $#stmt_lines + 2;
1750}
1751
1752sub statement_rawlines {
1753 my ($stmt) = @_;
1754
1755 my @stmt_lines = ($stmt =~ /\n/g);
1756
1757 return $#stmt_lines + 2;
1758}
1759
1760sub statement_block_size {
1761 my ($stmt) = @_;
1762
1763 $stmt =~ s/(^|\n)./$1/g;
1764 $stmt =~ s/^\s*{//;
1765 $stmt =~ s/}\s*$//;
1766 $stmt =~ s/^\s*//;
1767 $stmt =~ s/\s*$//;
1768
1769 my @stmt_lines = ($stmt =~ /\n/g);
1770 my @stmt_statements = ($stmt =~ /;/g);
1771
1772 my $stmt_lines = $#stmt_lines + 2;
1773 my $stmt_statements = $#stmt_statements + 1;
1774
1775 if ($stmt_lines > $stmt_statements) {
1776 return $stmt_lines;
1777 } else {
1778 return $stmt_statements;
1779 }
1780}
1781
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001782sub ctx_statement_full {
1783 my ($linenr, $remain, $off) = @_;
1784 my ($statement, $condition, $level);
1785
1786 my (@chunks);
1787
Andy Whitcroftcf655042008-03-04 14:28:20 -08001788 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001789 ($statement, $condition, $linenr, $remain, $off, $level) =
1790 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001791 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001792 push(@chunks, [ $condition, $statement ]);
1793 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1794 return ($level, $linenr, @chunks);
1795 }
1796
1797 # Pull in the following conditional/block pairs and see if they
1798 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001799 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001800 ($statement, $condition, $linenr, $remain, $off, $level) =
1801 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001802 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001803 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001804 #print "C: push\n";
1805 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001806 }
1807
1808 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001809}
1810
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001811sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001812 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001813 my $line;
1814 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001815 my $blk = '';
1816 my @o;
1817 my @c;
1818 my @res = ();
1819
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001820 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001821 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001822 for ($line = $start; $remain > 0; $line++) {
1823 next if ($rawlines[$line] =~ /^-/);
1824 $remain--;
1825
1826 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001827
1828 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001829 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001830 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001831 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001832 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001833 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001834 $level = pop(@stack);
1835 }
1836
Andy Whitcroft01464f32010-10-26 14:23:19 -07001837 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001838 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1839 if ($off > 0) {
1840 $off--;
1841 next;
1842 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001843
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001844 if ($c eq $close && $level > 0) {
1845 $level--;
1846 last if ($level == 0);
1847 } elsif ($c eq $open) {
1848 $level++;
1849 }
1850 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001851
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001852 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001853 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001854 }
1855
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001856 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001857 }
1858
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001859 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001860}
1861sub ctx_block_outer {
1862 my ($linenr, $remain) = @_;
1863
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001864 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1865 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001866}
1867sub ctx_block {
1868 my ($linenr, $remain) = @_;
1869
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001870 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1871 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001872}
1873sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001874 my ($linenr, $remain, $off) = @_;
1875
1876 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1877 return @r;
1878}
1879sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001880 my ($linenr, $remain) = @_;
1881
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001882 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001883}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001884sub ctx_statement_level {
1885 my ($linenr, $remain, $off) = @_;
1886
1887 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1888}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001889
1890sub ctx_locate_comment {
1891 my ($first_line, $end_line) = @_;
1892
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001893 # If c99 comment on the current line, or the line before or after
1894 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1895 return $current_comment if (defined $current_comment);
1896 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1897 return $current_comment if (defined $current_comment);
1898 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1899 return $current_comment if (defined $current_comment);
1900
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001901 # Catch a comment on the end of the line itself.
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001902 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001903 return $current_comment if (defined $current_comment);
1904
1905 # Look through the context and try and figure out if there is a
1906 # comment.
1907 my $in_comment = 0;
1908 $current_comment = '';
1909 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001910 my $line = $rawlines[$linenr - 1];
1911 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001912 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1913 $in_comment = 1;
1914 }
1915 if ($line =~ m@/\*@) {
1916 $in_comment = 1;
1917 }
1918 if (!$in_comment && $current_comment ne '') {
1919 $current_comment = '';
1920 }
1921 $current_comment .= $line . "\n" if ($in_comment);
1922 if ($line =~ m@\*/@) {
1923 $in_comment = 0;
1924 }
1925 }
1926
1927 chomp($current_comment);
1928 return($current_comment);
1929}
1930sub ctx_has_comment {
1931 my ($first_line, $end_line) = @_;
1932 my $cmt = ctx_locate_comment($first_line, $end_line);
1933
Andy Whitcroft00df3442007-06-08 13:47:06 -07001934 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001935 ##print "CMMT: $cmt\n";
1936
1937 return ($cmt ne '');
1938}
1939
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001940sub raw_line {
1941 my ($linenr, $cnt) = @_;
1942
1943 my $offset = $linenr - 1;
1944 $cnt++;
1945
1946 my $line;
1947 while ($cnt) {
1948 $line = $rawlines[$offset++];
1949 next if (defined($line) && $line =~ /^-/);
1950 $cnt--;
1951 }
1952
1953 return $line;
1954}
1955
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001956sub get_stat_real {
1957 my ($linenr, $lc) = @_;
1958
1959 my $stat_real = raw_line($linenr, 0);
1960 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1961 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1962 }
1963
1964 return $stat_real;
1965}
1966
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001967sub get_stat_here {
1968 my ($linenr, $cnt, $here) = @_;
1969
1970 my $herectx = $here . "\n";
1971 for (my $n = 0; $n < $cnt; $n++) {
1972 $herectx .= raw_line($linenr, $n) . "\n";
1973 }
1974
1975 return $herectx;
1976}
1977
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001978sub cat_vet {
1979 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001980 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001981
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001982 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001983 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1984 $res .= $1;
1985 if ($2 ne '') {
1986 $coded = sprintf("^%c", unpack('C', $2) + 64);
1987 $res .= $coded;
1988 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001989 }
1990 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001991
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001992 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001993}
1994
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001995my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001996my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001997my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001998my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001999
2000sub annotate_reset {
2001 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002002 $av_pending = '_';
2003 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002004 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002005}
2006
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002007sub annotate_values {
2008 my ($stream, $type) = @_;
2009
2010 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002011 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002012 my $cur = $stream;
2013
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002014 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002015
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002016 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002017 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002018 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002019 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002020 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002021 print "WS($1)\n" if ($dbg_values > 1);
2022 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002023 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002024 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002025 }
2026
Florian Micklerc023e4732011-01-12 16:59:58 -08002027 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07002028 print "CAST($1)\n" if ($dbg_values > 1);
2029 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08002030 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07002031
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07002032 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002033 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002034 $type = 'T';
2035
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07002036 } elsif ($cur =~ /^($Modifier)\s*/) {
2037 print "MODIFIER($1)\n" if ($dbg_values > 1);
2038 $type = 'T';
2039
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002040 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002041 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002042 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002043 push(@av_paren_type, $type);
2044 if ($2 ne '') {
2045 $av_pending = 'N';
2046 }
2047 $type = 'E';
2048
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002049 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002050 print "UNDEF($1)\n" if ($dbg_values > 1);
2051 $av_preprocessor = 1;
2052 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002053
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002054 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002055 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002056 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002057
2058 push(@av_paren_type, $type);
2059 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002060 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08002061
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002062 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002063 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
2064 $av_preprocessor = 1;
2065
2066 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
2067
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002068 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08002069
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002070 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002071 print "PRE_END($1)\n" if ($dbg_values > 1);
2072
2073 $av_preprocessor = 1;
2074
2075 # Assume all arms of the conditional end as this
2076 # one does, and continue as if the #endif was not here.
2077 pop(@av_paren_type);
2078 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002079 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002080
2081 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002082 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002083
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002084 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
2085 print "ATTR($1)\n" if ($dbg_values > 1);
2086 $av_pending = $type;
2087 $type = 'N';
2088
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002089 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002090 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002091 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002092 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002093 }
2094 $type = 'N';
2095
Andy Whitcroft14b111c2008-10-15 22:02:16 -07002096 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002097 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07002098 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002099 $type = 'N';
2100
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002101 } elsif ($cur =~/^(case)/o) {
2102 print "CASE($1)\n" if ($dbg_values > 1);
2103 $av_pend_colon = 'C';
2104 $type = 'N';
2105
Andy Whitcroft14b111c2008-10-15 22:02:16 -07002106 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002107 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002108 $type = 'N';
2109
2110 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002111 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002112 push(@av_paren_type, $av_pending);
2113 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002114 $type = 'N';
2115
2116 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002117 my $new_type = pop(@av_paren_type);
2118 if ($new_type ne '_') {
2119 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002120 print "PAREN('$1') -> $type\n"
2121 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002122 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002123 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002124 }
2125
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07002126 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002127 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07002128 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08002129 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002130
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002131 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
2132 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002133 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002134 } elsif ($type eq 'E') {
2135 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002136 }
2137 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
2138 $type = 'V';
2139
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002140 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002141 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002142 $type = 'V';
2143
2144 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002145 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002146 $type = 'N';
2147
Andy Whitcroftcf655042008-03-04 14:28:20 -08002148 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002149 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002150 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002151 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002152
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002153 } elsif ($cur =~/^(,)/) {
2154 print "COMMA($1)\n" if ($dbg_values > 1);
2155 $type = 'C';
2156
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002157 } elsif ($cur =~ /^(\?)/o) {
2158 print "QUESTION($1)\n" if ($dbg_values > 1);
2159 $type = 'N';
2160
2161 } elsif ($cur =~ /^(:)/o) {
2162 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
2163
2164 substr($var, length($res), 1, $av_pend_colon);
2165 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
2166 $type = 'E';
2167 } else {
2168 $type = 'N';
2169 }
2170 $av_pend_colon = 'O';
2171
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002172 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002173 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002174 $type = 'N';
2175
Andy Whitcroft0d413862008-10-15 22:02:16 -07002176 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002177 my $variant;
2178
2179 print "OPV($1)\n" if ($dbg_values > 1);
2180 if ($type eq 'V') {
2181 $variant = 'B';
2182 } else {
2183 $variant = 'U';
2184 }
2185
2186 substr($var, length($res), 1, $variant);
2187 $type = 'N';
2188
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002189 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002190 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002191 if ($1 ne '++' && $1 ne '--') {
2192 $type = 'N';
2193 }
2194
2195 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002196 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002197 }
2198 if (defined $1) {
2199 $cur = substr($cur, length($1));
2200 $res .= $type x length($1);
2201 }
2202 }
2203
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002204 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002205}
2206
Andy Whitcroft8905a672007-11-28 16:21:06 -08002207sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002208 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002209 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002210 ^(?:
2211 $Modifier|
2212 $Storage|
2213 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002214 DEFINE_\S+
2215 )$|
2216 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002217 goto|
2218 return|
2219 case|
2220 else|
2221 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08002222 do|
2223 \#|
2224 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002225 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07002226 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002227 )}x;
2228 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2229 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002230 # Check for modifiers.
2231 $possible =~ s/\s*$Storage\s*//g;
2232 $possible =~ s/\s*$Sparse\s*//g;
2233 if ($possible =~ /^\s*$/) {
2234
2235 } elsif ($possible =~ /\s/) {
2236 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07002237 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002238 if ($modifier !~ $notPermitted) {
2239 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002240 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002241 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07002242 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002243
2244 } else {
2245 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002246 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002247 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002248 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07002249 } else {
2250 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002251 }
2252}
2253
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002254my $prefix = '';
2255
Joe Perches000d1cc12011-07-25 17:13:25 -07002256sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002257 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002258
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002259 $type =~ tr/[a-z]/[A-Z]/;
2260
Joe Perchescbec18a2014-04-03 14:49:19 -07002261 return defined $use_type{$type} if (scalar keys %use_type > 0);
2262
2263 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002264}
2265
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002266sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002267 my ($level, $type, $msg) = @_;
2268
2269 if (!show_type($type) ||
2270 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002271 return 0;
2272 }
Joe Perches57230292015-06-25 15:03:03 -07002273 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002274 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002275 if ($level eq 'ERROR') {
2276 $output .= RED;
2277 } elsif ($level eq 'WARNING') {
2278 $output .= YELLOW;
2279 } else {
2280 $output .= GREEN;
2281 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002282 }
Joe Perches57230292015-06-25 15:03:03 -07002283 $output .= $prefix . $level . ':';
2284 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002285 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002286 $output .= "$type:";
2287 }
John Brooks737c0762017-07-10 15:52:24 -07002288 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002289 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002290
2291 if ($showfile) {
2292 my @lines = split("\n", $output, -1);
2293 splice(@lines, 1, 1);
2294 $output = join("\n", @lines);
2295 }
Dwaipayan Ray52178ce2021-02-26 15:08:26 +05302296
2297 if ($terse) {
2298 $output = (split('\n', $output))[0] . "\n";
2299 }
2300
2301 if ($verbose && exists($verbose_messages{$type}) &&
2302 !exists($verbose_emitted{$type})) {
2303 $output .= $verbose_messages{$type} . "\n\n";
2304 $verbose_emitted{$type} = 1;
2305 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002306
Joe Perches57230292015-06-25 15:03:03 -07002307 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002308
2309 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002310}
Joe Perchescbec18a2014-04-03 14:49:19 -07002311
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002312sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002313 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002314}
Joe Perches000d1cc12011-07-25 17:13:25 -07002315
Joe Perchesd752fcc2014-08-06 16:11:05 -07002316sub fixup_current_range {
2317 my ($lineRef, $offset, $length) = @_;
2318
2319 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2320 my $o = $1;
2321 my $l = $2;
2322 my $no = $o + $offset;
2323 my $nl = $l + $length;
2324 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2325 }
2326}
2327
2328sub fix_inserted_deleted_lines {
2329 my ($linesRef, $insertedRef, $deletedRef) = @_;
2330
2331 my $range_last_linenr = 0;
2332 my $delta_offset = 0;
2333
2334 my $old_linenr = 0;
2335 my $new_linenr = 0;
2336
2337 my $next_insert = 0;
2338 my $next_delete = 0;
2339
2340 my @lines = ();
2341
2342 my $inserted = @{$insertedRef}[$next_insert++];
2343 my $deleted = @{$deletedRef}[$next_delete++];
2344
2345 foreach my $old_line (@{$linesRef}) {
2346 my $save_line = 1;
2347 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002348 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002349 $delta_offset = 0;
2350 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2351 $range_last_linenr = $new_linenr;
2352 fixup_current_range(\$line, $delta_offset, 0);
2353 }
2354
2355 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2356 $deleted = @{$deletedRef}[$next_delete++];
2357 $save_line = 0;
2358 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2359 }
2360
2361 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2362 push(@lines, ${$inserted}{'LINE'});
2363 $inserted = @{$insertedRef}[$next_insert++];
2364 $new_linenr++;
2365 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2366 }
2367
2368 if ($save_line) {
2369 push(@lines, $line);
2370 $new_linenr++;
2371 }
2372
2373 $old_linenr++;
2374 }
2375
2376 return @lines;
2377}
2378
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002379sub fix_insert_line {
2380 my ($linenr, $line) = @_;
2381
2382 my $inserted = {
2383 LINENR => $linenr,
2384 LINE => $line,
2385 };
2386 push(@fixed_inserted, $inserted);
2387}
2388
2389sub fix_delete_line {
2390 my ($linenr, $line) = @_;
2391
2392 my $deleted = {
2393 LINENR => $linenr,
2394 LINE => $line,
2395 };
2396
2397 push(@fixed_deleted, $deleted);
2398}
2399
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002400sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002401 my ($type, $msg) = @_;
2402
2403 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002404 our $clean = 0;
2405 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002406 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 }
Joe Perches3705ce52013-07-03 15:05:31 -07002408 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002409}
2410sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002411 my ($type, $msg) = @_;
2412
2413 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002414 our $clean = 0;
2415 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002416 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002417 }
Joe Perches3705ce52013-07-03 15:05:31 -07002418 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002419}
2420sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002421 my ($type, $msg) = @_;
2422
2423 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002424 our $clean = 0;
2425 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002426 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002427 }
Joe Perches3705ce52013-07-03 15:05:31 -07002428 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002429}
2430
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002431sub check_absolute_file {
2432 my ($absolute, $herecurr) = @_;
2433 my $file = $absolute;
2434
2435 ##print "absolute<$absolute>\n";
2436
2437 # See if any suffix of this path is a path within the tree.
2438 while ($file =~ s@^[^/]*/@@) {
2439 if (-f "$root/$file") {
2440 ##print "file<$file>\n";
2441 last;
2442 }
2443 }
2444 if (! -f _) {
2445 return 0;
2446 }
2447
2448 # It is, so see if the prefix is acceptable.
2449 my $prefix = $absolute;
2450 substr($prefix, -length($file)) = '';
2451
2452 ##print "prefix<$prefix>\n";
2453 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002454 WARN("USE_RELATIVE_PATH",
2455 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002456 }
2457}
2458
Joe Perches3705ce52013-07-03 15:05:31 -07002459sub trim {
2460 my ($string) = @_;
2461
Joe Perchesb34c6482013-09-11 14:24:01 -07002462 $string =~ s/^\s+|\s+$//g;
2463
2464 return $string;
2465}
2466
2467sub ltrim {
2468 my ($string) = @_;
2469
2470 $string =~ s/^\s+//;
2471
2472 return $string;
2473}
2474
2475sub rtrim {
2476 my ($string) = @_;
2477
2478 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002479
2480 return $string;
2481}
2482
Joe Perches52ea8502013-11-12 15:10:09 -08002483sub string_find_replace {
2484 my ($string, $find, $replace) = @_;
2485
2486 $string =~ s/$find/$replace/g;
2487
2488 return $string;
2489}
2490
Joe Perches3705ce52013-07-03 15:05:31 -07002491sub tabify {
2492 my ($leading) = @_;
2493
Antonio Borneo713a09d2020-04-06 20:11:07 -07002494 my $source_indent = $tabsize;
Joe Perches3705ce52013-07-03 15:05:31 -07002495 my $max_spaces_before_tab = $source_indent - 1;
2496 my $spaces_to_tab = " " x $source_indent;
2497
2498 #convert leading spaces to tabs
2499 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2500 #Remove spaces before a tab
2501 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2502
2503 return "$leading";
2504}
2505
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002506sub pos_last_openparen {
2507 my ($line) = @_;
2508
2509 my $pos = 0;
2510
2511 my $opens = $line =~ tr/\(/\(/;
2512 my $closes = $line =~ tr/\)/\)/;
2513
2514 my $last_openparen = 0;
2515
2516 if (($opens == 0) || ($closes >= $opens)) {
2517 return -1;
2518 }
2519
2520 my $len = length($line);
2521
2522 for ($pos = 0; $pos < $len; $pos++) {
2523 my $string = substr($line, $pos);
2524 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2525 $pos += length($1) - 1;
2526 } elsif (substr($line, $pos, 1) eq '(') {
2527 $last_openparen = $pos;
2528 } elsif (index($string, '(') == -1) {
2529 last;
2530 }
2531 }
2532
Joe Perches91cb5192014-04-03 14:49:32 -07002533 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002534}
2535
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002536sub get_raw_comment {
2537 my ($line, $rawline) = @_;
2538 my $comment = '';
2539
2540 for my $i (0 .. (length($line) - 1)) {
2541 if (substr($line, $i, 1) eq "$;") {
2542 $comment .= substr($rawline, $i, 1);
2543 }
2544 }
2545
2546 return $comment;
2547}
2548
Song Liu5b8f82e2021-02-25 17:22:08 -08002549sub exclude_global_initialisers {
2550 my ($realfile) = @_;
2551
2552 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
2553 return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ ||
2554 $realfile =~ m@^samples/bpf/.*_kern\.c$@ ||
2555 $realfile =~ m@/bpf/.*\.bpf\.c$@;
2556}
2557
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002558sub process {
2559 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002560
2561 my $linenr=0;
2562 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002563 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002564 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002565 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002566
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002567 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002568 my $indent;
2569 my $previndent=0;
2570 my $stashindent=0;
2571
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002572 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002573 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002574 my $author = '';
2575 my $authorsignoff = 0;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002576 my $author_sob = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002577 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002578 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002579 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002580 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches44d303e2020-04-06 20:11:10 -07002581 my $has_patch_separator = 0; #Found a --- line
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002582 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002583 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002584 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002585 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002586 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002587 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002588 my $non_utf8_charset = 0;
2589
Joe Perches365dd4e2014-08-06 16:10:42 -07002590 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002591 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002592
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002593 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002594 our $cnt_lines = 0;
2595 our $cnt_error = 0;
2596 our $cnt_warn = 0;
2597 our $cnt_chk = 0;
2598
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002599 # Trace the real file/line as we go.
2600 my $realfile = '';
2601 my $realline = 0;
2602 my $realcnt = 0;
2603 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002604 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002605 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002606 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002607 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002608 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002609
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002610 my $prev_values = 'E';
2611
2612 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002613 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002614 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002615 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002616 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002617
Joe Perches7e51f192013-09-11 14:23:57 -07002618 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002619
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002620 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002621 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002622 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002623 my @setup_docs = ();
2624 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002625
Joe Perchesd8b07712013-11-12 15:10:06 -08002626 my $camelcase_file_seeded = 0;
2627
Rob Herring9f3a8992018-04-10 16:33:13 -07002628 my $checklicenseline = 1;
2629
Andy Whitcroft773647a2008-03-28 14:15:58 -07002630 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002631 my $line;
2632 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002633 $linenr++;
2634 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002635
Joe Perches3705ce52013-07-03 15:05:31 -07002636 push(@fixed, $rawline) if ($fix);
2637
Andy Whitcroft773647a2008-03-28 14:15:58 -07002638 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002639 $setup_docs = 0;
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07002640 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002641 $setup_docs = 1;
2642 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002643 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002644 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002645 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002646 $realline=$1-1;
2647 if (defined $2) {
2648 $realcnt=$3+1;
2649 } else {
2650 $realcnt=1+1;
2651 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002652 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002653
2654 # Guestimate if this is a continuing comment. Run
2655 # the context looking for a comment "edge". If this
2656 # edge is a close comment then we must be in a comment
2657 # at context start.
2658 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002659 my $cnt = $realcnt;
2660 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2661 next if (defined $rawlines[$ln - 1] &&
2662 $rawlines[$ln - 1] =~ /^-/);
2663 $cnt--;
2664 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002665 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002666 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2667 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2668 ($edge) = $1;
2669 last;
2670 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002671 }
2672 if (defined $edge && $edge eq '*/') {
2673 $in_comment = 1;
2674 }
2675
2676 # Guestimate if this is a continuing comment. If this
2677 # is the start of a diff block and this line starts
2678 # ' *' then it is very likely a comment.
2679 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002680 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002681 {
2682 $in_comment = 1;
2683 }
2684
2685 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2686 sanitise_line_reset($in_comment);
2687
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002688 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002689 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002690 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002691 $line = sanitise_line($rawline);
2692 }
2693 push(@lines, $line);
2694
2695 if ($realcnt > 1) {
2696 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2697 } else {
2698 $realcnt = 0;
2699 }
2700
2701 #print "==>$rawline\n";
2702 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002703
2704 if ($setup_docs && $line =~ /^\+/) {
2705 push(@setup_docs, $line);
2706 }
2707 }
2708
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002709 $prefix = '';
2710
Andy Whitcroft773647a2008-03-28 14:15:58 -07002711 $realcnt = 0;
2712 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002713 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002714 foreach my $line (@lines) {
2715 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002716 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002717 my $sline = $line; #copy of $line
2718 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002719
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002720 my $rawline = $rawlines[$linenr - 1];
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002721 my $raw_comment = get_raw_comment($line, $rawline);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002722
Joe Perches12c253a2018-06-07 17:10:58 -07002723# check if it's a mode change, rename or start of a patch
2724 if (!$in_commit_log &&
2725 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2726 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2727 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2728 $is_patch = 1;
2729 }
2730
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002731#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002732 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002733 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2734 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002735 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002736 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002737 $realline=$1-1;
2738 if (defined $2) {
2739 $realcnt=$3+1;
2740 } else {
2741 $realcnt=1+1;
2742 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002743 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002744 $prev_values = 'E';
2745
Andy Whitcroft773647a2008-03-28 14:15:58 -07002746 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002747 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002748 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002749 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002750 if ($context =~ /\b(\w+)\s*\(/) {
2751 $context_function = $1;
2752 } else {
2753 undef $context_function;
2754 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002755 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002756
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002757# track the line number as we move through the hunk, note that
2758# new versions of GNU diff omit the leading space on completely
2759# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002760 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002761 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002762 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002763
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002764 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002765 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002766
2767 # Track the previous line.
2768 ($prevline, $stashline) = ($stashline, $line);
2769 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002770 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2771
Andy Whitcroft773647a2008-03-28 14:15:58 -07002772 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002773
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002774 } elsif ($realcnt == 1) {
2775 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002776 }
2777
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002778 my $hunk_line = ($realcnt != 0);
2779
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002780 $here = "#$linenr: " if (!$file);
2781 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002782
Joe Perches2ac73b42014-06-04 16:12:05 -07002783 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002784 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002785 if ($line =~ /^diff --git.*?(\S+)$/) {
2786 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002787 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002788 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002789 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002790 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002791 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002792 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002793 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002794
2795 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002796 if (!$file && $tree && $p1_prefix ne '' &&
2797 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002798 WARN("PATCH_PREFIX",
2799 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002800 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002801
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002802 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002803 ERROR("MODIFIED_INCLUDE_ASM",
2804 "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 -07002805 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002806 $found_file = 1;
2807 }
2808
Joe Perches34d88152015-06-25 15:03:05 -07002809#make up the handle for any error we report on this line
2810 if ($showfile) {
2811 $prefix = "$realfile:$realline: "
2812 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002813 if ($file) {
2814 $prefix = "$filename:$realline: ";
2815 } else {
2816 $prefix = "$filename:$linenr: ";
2817 }
Joe Perches34d88152015-06-25 15:03:05 -07002818 }
2819
Joe Perches2ac73b42014-06-04 16:12:05 -07002820 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002821 if (is_maintained_obsolete($realfile)) {
2822 WARN("OBSOLETE",
2823 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2824 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002825 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002826 $check = 1;
2827 } else {
2828 $check = $check_orig;
2829 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002830 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002831
2832 if ($realfile !~ /^MAINTAINERS/) {
2833 my $last_binding_patch = $is_binding_patch;
2834
2835 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2836
2837 if (($last_binding_patch != -1) &&
2838 ($last_binding_patch ^ $is_binding_patch)) {
2839 WARN("DT_SPLIT_BINDING_PATCH",
Mauro Carvalho Chehab858e6842020-04-15 16:45:25 +02002840 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
Rob Herring133712a2018-08-21 21:58:16 -07002841 }
2842 }
2843
Andy Whitcroft773647a2008-03-28 14:15:58 -07002844 next;
2845 }
2846
Randy Dunlap389834b2007-06-08 13:47:03 -07002847 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002848
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002849 my $hereline = "$here\n$rawline\n";
2850 my $herecurr = "$here\n$rawline\n";
2851 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002852
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002853 $cnt_lines++ if ($realcnt != 0);
2854
Joe Perches490b2922018-08-21 21:58:01 -07002855# Verify the existence of a commit log if appropriate
2856# 2 is used because a $signature is counted in $commit_log_lines
2857 if ($in_commit_log) {
2858 if ($line !~ /^\s*$/) {
2859 $commit_log_lines++; #could be a $signature
2860 }
2861 } elsif ($has_commit_log && $commit_log_lines < 2) {
2862 WARN("COMMIT_MESSAGE",
2863 "Missing commit description - Add an appropriate one\n");
2864 $commit_log_lines = 2; #warn only once
2865 }
2866
Joe Perchese518e9a2015-06-25 15:03:27 -07002867# Check if the commit log has what seems like a diff which can confuse patch
2868 if ($in_commit_log && !$commit_log_has_diff &&
Mrinal Pandey13e45412020-09-04 16:35:52 -07002869 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
2870 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
Joe Perchese518e9a2015-06-25 15:03:27 -07002871 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2872 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2873 ERROR("DIFF_IN_COMMIT_MSG",
2874 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2875 $commit_log_has_diff = 1;
2876 }
2877
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002878# Check for incorrect file permissions
2879 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2880 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002881 if ($realfile !~ m@scripts/@ &&
2882 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002883 ERROR("EXECUTE_PERMISSIONS",
2884 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002885 }
2886 }
2887
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002888# Check the patch for a From:
2889 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2890 $author = $1;
Dwaipayan Raye7f929f2020-10-15 20:12:15 -07002891 my $curline = $linenr;
2892 while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) {
2893 $author .= $1;
2894 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002895 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2896 $author =~ s/"//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07002897 $author = reformat_email($author);
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002898 }
2899
Joe Perches20112472011-07-25 17:13:23 -07002900# Check the patch for a signoff:
Joe Perchesdfa05c22020-04-06 20:10:48 -07002901 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002902 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002903 $in_commit_log = 0;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002904 if ($author ne '' && $authorsignoff != 1) {
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08002905 if (same_email_addresses($1, $author)) {
Joe Perchesdfa05c22020-04-06 20:10:48 -07002906 $authorsignoff = 1;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002907 } else {
2908 my $ctx = $1;
2909 my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
2910 my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);
2911
2912 if ($email_address eq $author_address && $email_name eq $author_name) {
2913 $author_sob = $ctx;
2914 $authorsignoff = 2;
2915 } elsif ($email_address eq $author_address) {
2916 $author_sob = $ctx;
2917 $authorsignoff = 3;
2918 } elsif ($email_name eq $author_name) {
2919 $author_sob = $ctx;
2920 $authorsignoff = 4;
2921
2922 my $address1 = $email_address;
2923 my $address2 = $author_address;
2924
2925 if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
2926 $address1 = "$1$2";
2927 }
2928 if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
2929 $address2 = "$1$2";
2930 }
2931 if ($address1 eq $address2) {
2932 $authorsignoff = 5;
2933 }
2934 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002935 }
2936 }
Joe Perches20112472011-07-25 17:13:23 -07002937 }
2938
Joe Perches44d303e2020-04-06 20:11:10 -07002939# Check for patch separator
2940 if ($line =~ /^---$/) {
2941 $has_patch_separator = 1;
2942 $in_commit_log = 0;
2943 }
2944
Joe Perchese0d975b2014-12-10 15:51:49 -08002945# Check if MAINTAINERS is being updated. If so, there's probably no need to
2946# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2947 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2948 $reported_maintainer_file = 1;
2949 }
2950
Joe Perches20112472011-07-25 17:13:23 -07002951# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002952 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002953 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002954 my $space_before = $1;
2955 my $sign_off = $2;
2956 my $space_after = $3;
2957 my $email = $4;
2958 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2959
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002960 if ($sign_off !~ /$signature_tags/) {
Aditya Srivastava831242a2020-12-15 20:45:12 -08002961 my $suggested_signature = find_standard_signature($sign_off);
2962 if ($suggested_signature eq "") {
2963 WARN("BAD_SIGN_OFF",
2964 "Non-standard signature: $sign_off\n" . $herecurr);
2965 } else {
2966 if (WARN("BAD_SIGN_OFF",
2967 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) &&
2968 $fix) {
2969 $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/;
2970 }
2971 }
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002972 }
Joe Perches20112472011-07-25 17:13:23 -07002973 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002974 if (WARN("BAD_SIGN_OFF",
2975 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2976 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002977 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002978 "$ucfirst_sign_off $email";
2979 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002980 }
Joe Perches20112472011-07-25 17:13:23 -07002981 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002982 if (WARN("BAD_SIGN_OFF",
2983 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2984 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002985 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002986 "$ucfirst_sign_off $email";
2987 }
2988
Joe Perches20112472011-07-25 17:13:23 -07002989 }
2990 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002991 if (WARN("BAD_SIGN_OFF",
2992 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2993 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002994 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002995 "$ucfirst_sign_off $email";
2996 }
Joe Perches20112472011-07-25 17:13:23 -07002997 }
2998
Joe Perchesdfa05c22020-04-06 20:10:48 -07002999 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07003000 my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment));
Joe Perches20112472011-07-25 17:13:23 -07003001 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07003002 ERROR("BAD_SIGN_OFF",
3003 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07003004 } else {
3005 my $dequoted = $suggested_email;
3006 $dequoted =~ s/^"//;
3007 $dequoted =~ s/" </ </;
3008 # Don't force email to have quotes
3009 # Allow just an angle bracketed address
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08003010 if (!same_email_addresses($email, $suggested_email)) {
3011 if (WARN("BAD_SIGN_OFF",
3012 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) &&
3013 $fix) {
3014 $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/;
3015 }
3016 }
3017
3018 # Address part shouldn't have comments
3019 my $stripped_address = $email_address;
3020 $stripped_address =~ s/\([^\(\)]*\)//g;
3021 if ($email_address ne $stripped_address) {
3022 if (WARN("BAD_SIGN_OFF",
3023 "address part of email should not have comments: '$email_address'\n" . $herecurr) &&
3024 $fix) {
3025 $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/;
3026 }
3027 }
3028
3029 # Only one name comment should be allowed
3030 my $comment_count = () = $name_comment =~ /\([^\)]+\)/g;
3031 if ($comment_count > 1) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003032 WARN("BAD_SIGN_OFF",
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08003033 "Use a single name comment in email: '$email'\n" . $herecurr);
3034 }
3035
3036
3037 # stable@vger.kernel.org or stable@kernel.org shouldn't
Dwaipayan Raye73d2712020-12-15 20:44:56 -08003038 # have an email name. In addition comments should strictly
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08003039 # begin with a #
3040 if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) {
3041 if (($comment ne "" && $comment !~ /^#.+/) ||
3042 ($email_name ne "")) {
3043 my $cur_name = $email_name;
3044 my $new_comment = $comment;
3045 $cur_name =~ s/[a-zA-Z\s\-\"]+//g;
3046
3047 # Remove brackets enclosing comment text
3048 # and # from start of comments to get comment text
3049 $new_comment =~ s/^\((.*)\)$/$1/;
3050 $new_comment =~ s/^\[(.*)\]$/$1/;
3051 $new_comment =~ s/^[\s\#]+|\s+$//g;
3052
3053 $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment);
3054 $new_comment = " # $new_comment" if ($new_comment ne "");
3055 my $new_email = "$email_address$new_comment";
3056
3057 if (WARN("BAD_STABLE_ADDRESS_STYLE",
3058 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) &&
3059 $fix) {
3060 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3061 }
3062 }
3063 } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) {
3064 my $new_comment = $comment;
3065
3066 # Extract comment text from within brackets or
3067 # c89 style /*...*/ comments
3068 $new_comment =~ s/^\[(.*)\]$/$1/;
3069 $new_comment =~ s/^\/\*(.*)\*\/$/$1/;
3070
3071 $new_comment = trim($new_comment);
3072 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
3073 $new_comment = "($new_comment)" if ($new_comment ne "");
3074 my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment);
3075
3076 if (WARN("BAD_SIGN_OFF",
3077 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) &&
3078 $fix) {
3079 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3080 }
Joe Perches20112472011-07-25 17:13:23 -07003081 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003082 }
Joe Perches7e51f192013-09-11 14:23:57 -07003083
3084# Check for duplicate signatures
3085 my $sig_nospace = $line;
3086 $sig_nospace =~ s/\s//g;
3087 $sig_nospace = lc($sig_nospace);
3088 if (defined $signatures{$sig_nospace}) {
3089 WARN("BAD_SIGN_OFF",
3090 "Duplicate signature\n" . $herecurr);
3091 } else {
3092 $signatures{$sig_nospace} = 1;
3093 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07003094
3095# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
3096 if ($sign_off =~ /^co-developed-by:$/i) {
3097 if ($email eq $author) {
3098 WARN("BAD_SIGN_OFF",
3099 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
3100 }
3101 if (!defined $lines[$linenr]) {
3102 WARN("BAD_SIGN_OFF",
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08003103 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07003104 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
3105 WARN("BAD_SIGN_OFF",
3106 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3107 } elsif ($1 ne $email) {
3108 WARN("BAD_SIGN_OFF",
3109 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3110 }
3111 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003112 }
3113
Joe Perchesa2fe16b2015-02-13 14:39:02 -08003114# Check email subject for common tools that don't need to be mentioned
3115 if ($in_header_lines &&
3116 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
3117 WARN("EMAIL_SUBJECT",
3118 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
3119 }
3120
Joe Perches44d303e2020-04-06 20:11:10 -07003121# Check for Gerrit Change-Ids not in any patch context
3122 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Aditya Srivastava7580c5b2020-12-15 20:44:47 -08003123 if (ERROR("GERRIT_CHANGE_ID",
3124 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
3125 $fix) {
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08003126 fix_delete_line($fixlinenr, $rawline);
3127 }
Christopher Covington7ebd05e2014-04-03 14:49:31 -07003128 }
3129
Joe Perches369c8dd2015-11-06 16:31:34 -08003130# Check if the commit log is in a possible stack dump
3131 if ($in_commit_log && !$commit_log_possible_stack_dump &&
3132 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
3133 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
3134 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07003135 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
3136 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
3137 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
3138 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08003139 $commit_log_possible_stack_dump = 1;
3140 }
3141
Joe Perches2a076f42015-04-16 12:44:28 -07003142# Check for line lengths > 75 in commit log, warn once
3143 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08003144 length($line) > 75 &&
3145 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
3146 # file delta changes
3147 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
3148 # filename then :
Aditya Srivastava27b379a2020-12-15 20:44:59 -08003149 $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
3150 # A Fixes: or Link: line or signature tag line
Joe Perches369c8dd2015-11-06 16:31:34 -08003151 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07003152 WARN("COMMIT_LOG_LONG_LINE",
3153 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
3154 $commit_log_long_line = 1;
3155 }
3156
Joe Perchesbf4daf12015-09-09 15:37:50 -07003157# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08003158 if ($in_commit_log && $commit_log_possible_stack_dump &&
3159 $line =~ /^\s*$/) {
3160 $commit_log_possible_stack_dump = 0;
3161 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07003162
Dwaipayan Ray084a6172020-12-15 20:45:18 -08003163# Check for lines starting with a #
3164 if ($in_commit_log && $line =~ /^#/) {
3165 if (WARN("COMMIT_COMMENT_SYMBOL",
3166 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
3167 $fix) {
3168 $fixed[$fixlinenr] =~ s/^/ /;
3169 }
3170 }
3171
Joe Perches0d7835f2015-02-13 14:38:35 -08003172# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08003173 if ($in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07003174 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07003175 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07003176 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07003177 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08003178 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
3179 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07003180 my $init_char = "c";
3181 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08003182 my $short = 1;
3183 my $long = 0;
3184 my $case = 1;
3185 my $space = 1;
3186 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08003187 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08003188 my $id = '0123456789ab';
3189 my $orig_desc = "commit description";
3190 my $description = "";
3191
Joe Perchesfe043ea2015-09-09 15:37:25 -07003192 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
3193 $init_char = $1;
3194 $orig_commit = lc($2);
3195 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
3196 $orig_commit = lc($1);
3197 }
3198
Joe Perches0d7835f2015-02-13 14:38:35 -08003199 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
3200 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
3201 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
3202 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
3203 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
3204 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003205 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08003206 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
3207 defined $rawlines[$linenr] &&
3208 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
3209 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003210 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08003211 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
3212 defined $rawlines[$linenr] &&
3213 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
3214 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
3215 $orig_desc = $1;
3216 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
3217 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003218 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08003219 }
3220
3221 ($id, $description) = git_commit_info($orig_commit,
3222 $id, $orig_desc);
3223
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07003224 if (defined($id) &&
3225 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08003226 ERROR("GIT_COMMIT_ID",
3227 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
3228 }
Joe Perchesd311cd42014-08-06 16:10:57 -07003229 }
3230
Joe Perches13f19372014-08-06 16:10:59 -07003231# Check for added, moved or deleted files
3232 if (!$reported_maintainer_file && !$in_commit_log &&
3233 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
3234 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
3235 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
3236 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08003237 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07003238 $reported_maintainer_file = 1;
3239 WARN("FILE_PATH_CHANGES",
3240 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
3241 }
3242
Rob Herringe400edb2019-09-12 15:18:20 +01003243# Check for adding new DT bindings not in schema format
3244 if (!$in_commit_log &&
3245 ($line =~ /^new file mode\s*\d+\s*$/) &&
3246 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
3247 WARN("DT_SCHEMA_BINDING_PATCH",
Mauro Carvalho Chehab56ddc4c2021-04-01 14:17:49 +02003248 "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
Rob Herringe400edb2019-09-12 15:18:20 +01003249 }
3250
Andy Whitcroft00df3442007-06-08 13:47:06 -07003251# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08003252 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003253 ERROR("CORRUPTED_PATCH",
3254 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003255 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003256 }
3257
3258# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3259 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003260 $rawline !~ m/^$UTF8*$/) {
3261 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3262
3263 my $blank = copy_spacing($rawline);
3264 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3265 my $hereptr = "$hereline$ptr\n";
3266
Joe Perches34d99212011-07-25 17:13:26 -07003267 CHK("INVALID_UTF8",
3268 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003269 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003270
Joe Perches15662b32011-10-31 17:13:12 -07003271# Check if it's the start of a commit log
3272# (not a header line and we haven't seen the patch filename)
3273 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07003274 !($rawline =~ /^\s+(?:\S|$)/ ||
3275 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07003276 $in_header_lines = 0;
3277 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07003278 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07003279 }
3280
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003281# Check if there is UTF-8 in a commit log when a mail header has explicitly
3282# declined it, i.e defined some charset where it is missing.
3283 if ($in_header_lines &&
3284 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3285 $1 !~ /utf-8/i) {
3286 $non_utf8_charset = 1;
3287 }
3288
3289 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07003290 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003291 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07003292 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3293 }
3294
Joe Perchesd6430f72016-12-12 16:46:28 -08003295# Check for absolute kernel paths in commit message
3296 if ($tree && $in_commit_log) {
3297 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3298 my $file = $1;
3299
3300 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3301 check_absolute_file($1, $herecurr)) {
3302 #
3303 } else {
3304 check_absolute_file($file, $herecurr);
3305 }
3306 }
3307 }
3308
Kees Cook66b47b42014-10-13 15:51:57 -07003309# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07003310 if (defined($misspellings) &&
3311 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Dwaipayan Ray7da07c32020-12-15 20:45:21 -08003312 while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07003313 my $typo = $1;
Dwaipayan Ray7da07c32020-12-15 20:45:21 -08003314 my $blank = copy_spacing($rawline);
3315 my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
3316 my $hereptr = "$hereline$ptr\n";
Kees Cook66b47b42014-10-13 15:51:57 -07003317 my $typo_fix = $spelling_fix{lc($typo)};
3318 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3319 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07003320 my $msg_level = \&WARN;
3321 $msg_level = \&CHK if ($file);
3322 if (&{$msg_level}("TYPO_SPELLING",
Dwaipayan Ray7da07c32020-12-15 20:45:21 -08003323 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07003324 $fix) {
3325 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3326 }
3327 }
3328 }
3329
Matteo Crocea8dd86b2019-09-25 16:46:38 -07003330# check for invalid commit id
3331 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3332 my $id;
3333 my $description;
3334 ($id, $description) = git_commit_info($2, undef, undef);
3335 if (!defined($id)) {
3336 WARN("UNKNOWN_COMMIT_ID",
3337 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3338 }
3339 }
3340
Joe Perches310cd062020-10-15 20:11:52 -07003341# check for repeated words separated by a single space
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003342# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3343 if (($rawline =~ /^\+/ || $in_commit_log) &&
3344 $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003345 pos($rawline) = 1 if (!$in_commit_log);
Joe Perches310cd062020-10-15 20:11:52 -07003346 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3347
3348 my $first = $1;
3349 my $second = $2;
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003350 my $start_pos = $-[1];
3351 my $end_pos = $+[2];
Joe Perches310cd062020-10-15 20:11:52 -07003352 if ($first =~ /(?:struct|union|enum)/) {
3353 pos($rawline) += length($first) + length($second) + 1;
3354 next;
3355 }
3356
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003357 next if (lc($first) ne lc($second));
Joe Perches310cd062020-10-15 20:11:52 -07003358 next if ($first eq 'long');
3359
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003360 # check for character before and after the word matches
3361 my $start_char = '';
3362 my $end_char = '';
3363 $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
3364 $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
3365
3366 next if ($start_char =~ /^\S$/);
3367 next if (index(" \t.,;?!", $end_char) == -1);
3368
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08003369 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3370 if ($first =~ /\b[0-9a-f]{2,}\b/i) {
3371 next if (!exists($allow_repeated_words{lc($first)}));
3372 }
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003373
Joe Perches310cd062020-10-15 20:11:52 -07003374 if (WARN("REPEATED_WORD",
3375 "Possible repeated word: '$first'\n" . $herecurr) &&
3376 $fix) {
3377 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3378 }
3379 }
3380
3381 # if it's a repeated word on consecutive lines in a comment block
3382 if ($prevline =~ /$;+\s*$/ &&
3383 $prevrawline =~ /($word_pattern)\s*$/) {
3384 my $last_word = $1;
3385 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3386 if (WARN("REPEATED_WORD",
3387 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3388 $fix) {
3389 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3390 }
3391 }
3392 }
3393 }
3394
Andy Whitcroft306708542008-10-15 22:02:28 -07003395# ignore non-hunk lines and lines being removed
3396 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003397
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003398#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003399 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003400 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07003401 if (ERROR("DOS_LINE_ENDINGS",
3402 "DOS line endings\n" . $herevet) &&
3403 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003404 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003405 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003406 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3407 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003408 if (ERROR("TRAILING_WHITESPACE",
3409 "trailing whitespace\n" . $herevet) &&
3410 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003411 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07003412 }
3413
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003414 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003415 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07003416
Josh Triplett4783f892013-11-12 15:10:12 -08003417# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08003418 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08003419 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08003420 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3421 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003422 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003423 my $msg_level = \&ERROR;
3424 $msg_level = \&CHK if ($file);
3425 &{$msg_level}("FSF_MAILING_ADDRESS",
3426 "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 -08003427 }
3428
Andi Kleen33549572010-05-24 14:33:29 -07003429# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003430# Only applies when adding the entry originally, after that we do not have
3431# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003432 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003433 # 'choice' is usually the last thing on the line (though
3434 # Kconfig supports named choices), so use a word boundary
3435 # (\b) rather than a whitespace character (\s)
3436 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07003437 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003438 my $cnt = $realcnt;
3439 my $ln = $linenr + 1;
3440 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003441 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003442 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003443 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003444 $f = $lines[$ln - 1];
3445 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3446 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003447
3448 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07003449 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08003450
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01003451 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003452 $is_start = 1;
Masahiro Yamada22a4ac02020-06-17 12:02:20 +09003453 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003454 $length = -1;
3455 }
3456
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003457 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07003458 $f =~ s/#.*//;
3459 $f =~ s/^\s+//;
3460 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01003461
3462 # This only checks context lines in the patch
3463 # and so hopefully shouldn't trigger false
3464 # positives, even though some of these are
3465 # common words in help texts
3466 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3467 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003468 $is_end = 1;
3469 last;
3470 }
Andi Kleen33549572010-05-24 14:33:29 -07003471 $length++;
3472 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003473 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3474 WARN("CONFIG_DESCRIPTION",
3475 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3476 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003477 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003478 }
3479
Joe Perches7ccf41a2020-06-04 16:50:33 -07003480# check MAINTAINERS entries
3481 if ($realfile =~ /^MAINTAINERS$/) {
3482# check MAINTAINERS entries for the right form
3483 if ($rawline =~ /^\+[A-Z]:/ &&
3484 $rawline !~ /^\+[A-Z]:\t\S/) {
3485 if (WARN("MAINTAINERS_STYLE",
3486 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3487 $fix) {
3488 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3489 }
3490 }
3491# check MAINTAINERS entries for the right ordering too
3492 my $preferred_order = 'MRLSWQBCPTFXNK';
3493 if ($rawline =~ /^\+[A-Z]:/ &&
3494 $prevrawline =~ /^[\+ ][A-Z]:/) {
3495 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3496 my $cur = $1;
3497 my $curval = $2;
3498 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3499 my $prev = $1;
3500 my $prevval = $2;
3501 my $curindex = index($preferred_order, $cur);
3502 my $previndex = index($preferred_order, $prev);
3503 if ($curindex < 0) {
3504 WARN("MAINTAINERS_STYLE",
3505 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3506 } else {
3507 if ($previndex >= 0 && $curindex < $previndex) {
3508 WARN("MAINTAINERS_STYLE",
3509 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3510 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3511 ($prev eq 'X' && $cur eq 'X')) &&
3512 ($prevval cmp $curval) > 0) {
3513 WARN("MAINTAINERS_STYLE",
3514 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3515 }
3516 }
Joe Perches628f91a2017-07-10 15:52:07 -07003517 }
3518 }
3519
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003520 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3521 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3522 my $flag = $1;
3523 my $replacement = {
3524 'EXTRA_AFLAGS' => 'asflags-y',
3525 'EXTRA_CFLAGS' => 'ccflags-y',
3526 'EXTRA_CPPFLAGS' => 'cppflags-y',
3527 'EXTRA_LDFLAGS' => 'ldflags-y',
3528 };
3529
3530 WARN("DEPRECATED_VARIABLE",
3531 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3532 }
3533
Rob Herringbff5da42014-01-23 15:54:51 -08003534# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003535 if (defined $root &&
3536 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3537 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3538
Rob Herringbff5da42014-01-23 15:54:51 -08003539 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3540
Florian Vaussardcc933192014-04-03 14:49:27 -07003541 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003542 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003543
Rob Herringbff5da42014-01-23 15:54:51 -08003544 foreach my $compat (@compats) {
3545 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003546 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3547 my $compat3 = $compat;
3548 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3549 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003550 if ( $? >> 8 ) {
3551 WARN("UNDOCUMENTED_DT_STRING",
3552 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3553 }
3554
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003555 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3556 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003557 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003558 if ( $? >> 8 ) {
3559 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003560 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003561 }
3562 }
3563 }
3564
Rob Herring9f3a8992018-04-10 16:33:13 -07003565# check for using SPDX license tag at beginning of files
3566 if ($realline == $checklicenseline) {
3567 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3568 $checklicenseline = 2;
3569 } elsif ($rawline =~ /^\+/) {
3570 my $comment = "";
3571 if ($realfile =~ /\.(h|s|S)$/) {
3572 $comment = '/*';
3573 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3574 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003575 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003576 $comment = '#';
3577 } elsif ($realfile =~ /\.rst$/) {
3578 $comment = '..';
3579 }
3580
Joe Perchesfdf13692019-03-07 16:28:32 -08003581# check SPDX comment style for .[chsS] files
3582 if ($realfile =~ /\.[chsS]$/ &&
3583 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003584 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003585 WARN("SPDX_LICENSE_TAG",
3586 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3587 }
3588
Rob Herring9f3a8992018-04-10 16:33:13 -07003589 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003590 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3591 WARN("SPDX_LICENSE_TAG",
3592 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003593 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003594 my $spdx_license = $1;
3595 if (!is_SPDX_License_valid($spdx_license)) {
3596 WARN("SPDX_LICENSE_TAG",
3597 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3598 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003599 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3600 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3601 my $msg_level = \&WARN;
3602 $msg_level = \&CHK if ($file);
3603 if (&{$msg_level}("SPDX_LICENSE_TAG",
3604
3605 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3606 $fix) {
3607 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3608 }
3609 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003610 }
3611 }
3612 }
3613
Joe Perchesa0154cd2020-10-15 20:12:19 -07003614# check for embedded filenames
3615 if ($rawline =~ /^\+.*\Q$realfile\E/) {
3616 WARN("EMBEDDED_FILENAME",
3617 "It's generally not useful to have the filename in the file\n" . $herecurr);
3618 }
3619
Andy Whitcroft5368df202008-10-15 22:02:27 -07003620# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003621 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003622
Joe Perchesa8da38a2019-03-07 16:28:42 -08003623# check for using SPDX-License-Identifier on the wrong line number
3624 if ($realline != $checklicenseline &&
3625 $rawline =~ /\bSPDX-License-Identifier:/ &&
3626 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3627 WARN("SPDX_LICENSE_TAG",
3628 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3629 }
3630
Joe Perches47e0c882015-06-25 15:02:57 -07003631# line length limit (with some exclusions)
3632#
3633# There are a few types of lines that may extend beyond $max_line_length:
3634# logging functions like pr_info that end in a string
3635# lines with a single string
3636# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003637# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003638#
3639# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003640# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003641# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3642# LONG_LINE all other lines longer than $max_line_length
3643#
3644# if LONG_LINE is ignored, the other 2 types are also ignored
3645#
3646
Joe Perchesb4749e92015-07-17 16:24:01 -07003647 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003648 my $msg_type = "LONG_LINE";
3649
3650 # Check the allowed long line types first
3651
3652 # logging functions that end in a string that starts
3653 # before $max_line_length
3654 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3655 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3656 $msg_type = "";
3657
3658 # lines with only strings (w/ possible termination)
3659 # #defines with only strings
3660 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3661 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3662 $msg_type = "";
3663
Joe Perchescc147502017-11-17 15:28:44 -08003664 # More special cases
3665 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3666 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003667 $msg_type = "";
3668
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003669 # URL ($rawline is used in case the URL is in a comment)
3670 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3671 $msg_type = "";
3672
Joe Perches47e0c882015-06-25 15:02:57 -07003673 # Otherwise set the alternate message types
3674
3675 # a comment starts before $max_line_length
3676 } elsif ($line =~ /($;[\s$;]*)$/ &&
3677 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3678 $msg_type = "LONG_LINE_COMMENT"
3679
3680 # a quoted string starts before $max_line_length
3681 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3682 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3683 $msg_type = "LONG_LINE_STRING"
3684 }
3685
3686 if ($msg_type ne "" &&
3687 (show_type("LONG_LINE") || show_type($msg_type))) {
Joe Perchesbdc48fa2020-05-29 16:12:21 -07003688 my $msg_level = \&WARN;
3689 $msg_level = \&CHK if ($file);
3690 &{$msg_level}($msg_type,
3691 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Joe Perches47e0c882015-06-25 15:02:57 -07003692 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003693 }
3694
Andy Whitcroft8905a672007-11-28 16:21:06 -08003695# check for adding lines without a newline.
3696 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Tom Rix47ca69b2020-12-15 20:44:40 -08003697 if (WARN("MISSING_EOF_NEWLINE",
3698 "adding a line without newline at end of file\n" . $herecurr) &&
3699 $fix) {
3700 fix_delete_line($fixlinenr+1, "No newline at end of file");
3701 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003702 }
3703
Aditya Srivastavade932452021-02-25 17:21:57 -08003704# check for .L prefix local symbols in .S files
3705 if ($realfile =~ /\.S$/ &&
3706 $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {
3707 WARN("AVOID_L_PREFIX",
3708 "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/asm-annotations.rst\n" . $herecurr);
3709 }
3710
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003711# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003712 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003713
3714# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003715# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003716 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3717 $rawline =~ /^\+\s* \s*/) {
3718 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003719 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003720 if (ERROR("CODE_INDENT",
3721 "code indent should use tabs where possible\n" . $herevet) &&
3722 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003723 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003724 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003725 }
3726
Alberto Panizzo08e44362010-03-05 13:43:54 -08003727# check for space before tabs.
3728 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3729 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003730 if (WARN("SPACE_BEFORE_TAB",
3731 "please, no space before tabs\n" . $herevet) &&
3732 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003733 while ($fixed[$fixlinenr] =~
Antonio Borneo713a09d2020-04-06 20:11:07 -07003734 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003735 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003736 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003737 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003738 }
3739
Joe Perches6a487212018-04-10 16:34:04 -07003740# check for assignments on the start of a line
3741 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
Aditya Srivastavada7355a2020-12-15 20:45:06 -08003742 my $operator = $1;
3743 if (CHK("ASSIGNMENT_CONTINUATIONS",
3744 "Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
3745 $fix && $prevrawline =~ /^\+/) {
3746 # add assignment operator to the previous line, remove from current line
3747 $fixed[$fixlinenr - 1] .= " $operator";
3748 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3749 }
Joe Perches6a487212018-04-10 16:34:04 -07003750 }
3751
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003752# check for && or || at the start of a line
3753 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
Aditya Srivastava8e08f072020-12-15 20:45:09 -08003754 my $operator = $1;
3755 if (CHK("LOGICAL_CONTINUATIONS",
3756 "Logical continuations should be on the previous line\n" . $hereprev) &&
3757 $fix && $prevrawline =~ /^\+/) {
3758 # insert logical operator at last non-comment, non-whitepsace char on previous line
3759 $prevline =~ /[\s$;]*$/;
3760 my $line_end = substr($prevrawline, $-[0]);
3761 $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
3762 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3763 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003764 }
3765
Joe Perchesa91e8992016-05-20 17:04:05 -07003766# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003767 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003768 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003769 my $indent = length($1);
Antonio Borneo713a09d2020-04-06 20:11:07 -07003770 if ($indent % $tabsize) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003771 if (WARN("TABSTOP",
3772 "Statements should start on a tabstop\n" . $herecurr) &&
3773 $fix) {
Antonio Borneo713a09d2020-04-06 20:11:07 -07003774 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Joe Perchesa91e8992016-05-20 17:04:05 -07003775 }
3776 }
3777 }
3778
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003779# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003780 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003781 $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 -07003782 $prevline =~ /^\+(\t*)(.*)$/;
3783 my $oldindent = $1;
3784 my $rest = $2;
3785
3786 my $pos = pos_last_openparen($rest);
3787 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003788 $line =~ /^(\+| )([ \t]*)/;
3789 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003790
3791 my $goodtabindent = $oldindent .
Antonio Borneo713a09d2020-04-06 20:11:07 -07003792 "\t" x ($pos / $tabsize) .
3793 " " x ($pos % $tabsize);
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003794 my $goodspaceindent = $oldindent . " " x $pos;
3795
3796 if ($newindent ne $goodtabindent &&
3797 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003798
3799 if (CHK("PARENTHESIS_ALIGNMENT",
3800 "Alignment should match open parenthesis\n" . $hereprev) &&
3801 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003802 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003803 s/^\+[ \t]*/\+$goodtabindent/;
3804 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003805 }
3806 }
3807 }
3808
Joe Perches6ab3a972015-04-16 12:44:05 -07003809# check for space after cast like "(int) foo" or "(struct foo) bar"
3810# avoid checking a few false positives:
3811# "sizeof(<type>)" or "__alignof__(<type>)"
3812# function pointer declarations like "(*foo)(int) = bar;"
3813# structure definitions like "(struct foo) { 0 };"
3814# multiline macros that define functions
3815# known attributes or the __attribute__ keyword
3816 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3817 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003818 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003819 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003820 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003821 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003822 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003823 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003824 }
3825
Joe Perches86406b12015-09-09 15:37:41 -07003826# Block comment styles
3827# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003828 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003829 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003830 $rawline =~ /^\+[ \t]*\*/ &&
Łukasz Stelmachc70735c2020-10-15 20:12:25 -07003831 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
Joe Perches05880602012-10-04 17:13:35 -07003832 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3833 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3834 }
3835
Joe Perches86406b12015-09-09 15:37:41 -07003836# Block comments use * on subsequent lines
3837 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3838 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003839 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003840 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003841 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003842 WARN("BLOCK_COMMENT_STYLE",
3843 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003844 }
3845
Joe Perches86406b12015-09-09 15:37:41 -07003846# Block comments use */ on trailing lines
3847 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003848 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3849 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3850 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003851 WARN("BLOCK_COMMENT_STYLE",
3852 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003853 }
3854
Joe Perches08eb9b82016-10-11 13:51:50 -07003855# Block comment * alignment
3856 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003857 $line =~ /^\+[ \t]*$;/ && #leading comment
3858 $rawline =~ /^\+[ \t]*\*/ && #leading *
3859 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003860 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003861 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3862 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003863 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003864 if (defined($1)) {
3865 $oldindent = expand_tabs($1);
3866 } else {
3867 $prevrawline =~ m@^\+(.*/?)\*@;
3868 $oldindent = expand_tabs($1);
3869 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003870 $rawline =~ m@^\+([ \t]*)\*@;
3871 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003872 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003873 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003874 WARN("BLOCK_COMMENT_STYLE",
3875 "Block comments should align the * on each line\n" . $hereprev);
3876 }
3877 }
3878
Joe Perches7f619192014-08-06 16:10:39 -07003879# check for missing blank lines after struct/union declarations
3880# with exceptions for various attributes and macros
3881 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3882 $line =~ /^\+/ &&
3883 !($line =~ /^\+\s*$/ ||
3884 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3885 $line =~ /^\+\s*MODULE_/i ||
3886 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3887 $line =~ /^\+[a-z_]*init/ ||
3888 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3889 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003890 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003891 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003892 if (CHK("LINE_SPACING",
3893 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3894 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003895 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003896 }
Joe Perches7f619192014-08-06 16:10:39 -07003897 }
3898
Joe Perches365dd4e2014-08-06 16:10:42 -07003899# check for multiple consecutive blank lines
3900 if ($prevline =~ /^[\+ ]\s*$/ &&
3901 $line =~ /^\+\s*$/ &&
3902 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003903 if (CHK("LINE_SPACING",
3904 "Please don't use multiple blank lines\n" . $hereprev) &&
3905 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003906 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003907 }
3908
Joe Perches365dd4e2014-08-06 16:10:42 -07003909 $last_blank_line = $linenr;
3910 }
3911
Joe Perches3b617e32014-04-03 14:49:28 -07003912# check for missing blank lines after declarations
Joe Perchesb5e87362021-02-25 17:21:40 -08003913# (declarations must have the same indentation and not be at the start of line)
3914 if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) {
3915 # use temporaries
3916 my $sl = $sline;
3917 my $pl = $prevline;
3918 # remove $Attribute/$Sparse uses to simplify comparisons
3919 $sl =~ s/\b(?:$Attribute|$Sparse)\b//g;
3920 $pl =~ s/\b(?:$Attribute|$Sparse)\b//g;
3921 if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003922 # function pointer declarations
Joe Perchesb5e87362021-02-25 17:21:40 -08003923 $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003924 # foo bar; where foo is some local typedef or #define
Joe Perchesb5e87362021-02-25 17:21:40 -08003925 $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003926 # known declaration macros
Joe Perchesb5e87362021-02-25 17:21:40 -08003927 $pl =~ /^\+\s+$declaration_macros/) &&
Joe Perches3f7bac02014-06-04 16:12:04 -07003928 # for "else if" which can look like "$Ident $Ident"
Joe Perchesb5e87362021-02-25 17:21:40 -08003929 !($pl =~ /^\+\s+$c90_Keywords\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003930 # other possible extensions of declaration lines
Joe Perchesb5e87362021-02-25 17:21:40 -08003931 $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003932 # not starting a section or a macro "\" extended line
Joe Perchesb5e87362021-02-25 17:21:40 -08003933 $pl =~ /(?:\{\s*|\\)$/) &&
Joe Perches3f7bac02014-06-04 16:12:04 -07003934 # looks like a declaration
Joe Perchesb5e87362021-02-25 17:21:40 -08003935 !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003936 # function pointer declarations
Joe Perchesb5e87362021-02-25 17:21:40 -08003937 $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003938 # foo bar; where foo is some local typedef or #define
Joe Perchesb5e87362021-02-25 17:21:40 -08003939 $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003940 # known declaration macros
Joe Perchesb5e87362021-02-25 17:21:40 -08003941 $sl =~ /^\+\s+$declaration_macros/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003942 # start of struct or union or enum
Joe Perchesb5e87362021-02-25 17:21:40 -08003943 $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003944 # start or end of block or continuation of declaration
Joe Perchesb5e87362021-02-25 17:21:40 -08003945 $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003946 # bitfield continuation
Joe Perchesb5e87362021-02-25 17:21:40 -08003947 $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003948 # other possible extensions of declaration lines
Joe Perchesb5e87362021-02-25 17:21:40 -08003949 $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
3950 if (WARN("LINE_SPACING",
3951 "Missing a blank line after declarations\n" . $hereprev) &&
3952 $fix) {
3953 fix_insert_line($fixlinenr, "\+");
3954 }
Joe Perchesd752fcc2014-08-06 16:11:05 -07003955 }
Joe Perches3b617e32014-04-03 14:49:28 -07003956 }
3957
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003958# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003959# Exceptions:
3960# 1) within comments
3961# 2) indented preprocessor commands
3962# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003963 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003964 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003965 if (WARN("LEADING_SPACE",
3966 "please, no spaces at the start of a line\n" . $herevet) &&
3967 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003968 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003969 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003970 }
3971
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003972# check we are in a valid C source file if not then ignore this hunk
3973 next if ($realfile !~ /\.(h|c)$/);
3974
Joe Perches5751a242017-11-17 15:28:52 -08003975# check for unusual line ending [ or (
3976 if ($line =~ /^\+.*([\[\(])\s*$/) {
3977 CHK("OPEN_ENDED_LINE",
3978 "Lines should not end with a '$1'\n" . $herecurr);
3979 }
3980
Joe Perches4dbed762017-05-08 15:55:39 -07003981# check if this appears to be the start function declaration, save the name
3982 if ($sline =~ /^\+\{\s*$/ &&
3983 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3984 $context_function = $1;
3985 }
3986
3987# check if this appears to be the end of function declaration
3988 if ($sline =~ /^\+\}\s*$/) {
3989 undef $context_function;
3990 }
3991
Joe Perches032a4c02014-08-06 16:10:29 -07003992# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003993# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003994# if the previous line is a break or return and is indented 1 tab more...
3995 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3996 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003997 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3998 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3999 defined $lines[$linenr] &&
4000 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07004001 WARN("UNNECESSARY_ELSE",
4002 "else is not generally useful after a break or return\n" . $hereprev);
4003 }
4004 }
4005
Joe Perchesc00df192014-08-06 16:11:01 -07004006# check indentation of a line with a break;
Joe Perchesdc58bc52020-12-15 20:44:33 -08004007# if the previous line is a goto, return or break
4008# and is indented the same # of tabs
Joe Perchesc00df192014-08-06 16:11:01 -07004009 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
4010 my $tabs = $1;
Joe Perchesdc58bc52020-12-15 20:44:33 -08004011 if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
4012 if (WARN("UNNECESSARY_BREAK",
4013 "break is not useful after a $1\n" . $hereprev) &&
4014 $fix) {
4015 fix_delete_line($fixlinenr, $rawline);
4016 }
Joe Perchesc00df192014-08-06 16:11:01 -07004017 }
4018 }
4019
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004020# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08004021 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004022 WARN("CVS_KEYWORD",
4023 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004024 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004025
Joe Perches56e77d72013-02-21 16:44:14 -08004026# check for old HOTPLUG __dev<foo> section markings
4027 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
4028 WARN("HOTPLUG_SECTION",
4029 "Using $1 is unnecessary\n" . $herecurr);
4030 }
4031
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004032# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004033 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
4034 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004035#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07004036 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07004037 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004038 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004039 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004040 $stat =~ s/\n./\n /g;
4041 $cond =~ s/\n./\n /g;
4042
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004043#print "linenr<$linenr> <$stat>\n";
4044 # If this statement has no statement boundaries within
4045 # it there is no point in retrying a statement scan
4046 # until we hit end of it.
4047 my $frag = $stat; $frag =~ s/;+\s*$//;
4048 if ($frag !~ /(?:{|;)/) {
4049#print "skip<$line_nr_next>\n";
4050 $suppress_statement = $line_nr_next;
4051 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004052
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004053 # Find the real next line.
4054 $realline_next = $line_nr_next;
4055 if (defined $realline_next &&
4056 (!defined $lines[$realline_next - 1] ||
4057 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
4058 $realline_next++;
4059 }
4060
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004061 my $s = $stat;
4062 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004063
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004064 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004065 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004066
4067 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004068 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004069
Andy Whitcroft463f2862009-09-21 17:04:34 -07004070 } elsif ($s =~ /^.\s*else\b/s) {
4071
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004072 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07004073 } 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 -07004074 my $type = $1;
4075 $type =~ s/\s+/ /g;
4076 possible($type, "A:" . $s);
4077
Andy Whitcroft8905a672007-11-28 16:21:06 -08004078 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07004079 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004080 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004081 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004082
4083 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08004084 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004085 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004086 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004087
4088 # Check for any sort of function declaration.
4089 # int foo(something bar, other baz);
4090 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004091 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 -08004092 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004093
Andy Whitcroftcf655042008-03-04 14:28:20 -08004094 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004095 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004096 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004097
Andy Whitcroft8905a672007-11-28 16:21:06 -08004098 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004099 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08004100
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004101 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004102 }
4103 }
4104 }
4105
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004106 }
4107
Andy Whitcroft653d4872007-06-23 17:16:34 -07004108#
4109# Checks which may be anchored in the context.
4110#
4111
4112# Check for switch () and associated case and default
4113# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07004114 if ($line=~/\bswitch\s*\(.*\)/) {
4115 my $err = '';
4116 my $sep = '';
4117 my @ctx = ctx_block_outer($linenr, $realcnt);
4118 shift(@ctx);
4119 for my $ctx (@ctx) {
4120 my ($clen, $cindent) = line_stats($ctx);
4121 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
4122 $indent != $cindent) {
4123 $err .= "$sep$ctx\n";
4124 $sep = '';
4125 } else {
4126 $sep = "[...]\n";
4127 }
4128 }
4129 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004130 ERROR("SWITCH_CASE_INDENT_LEVEL",
4131 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004132 }
4133 }
4134
4135# if/while/etc brace do not go on next line, unless defining a do while loop,
4136# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07004137 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 -07004138 my $pre_ctx = "$1$2";
4139
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004140 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08004141
4142 if ($line =~ /^\+\t{6,}/) {
4143 WARN("DEEP_INDENTATION",
4144 "Too many leading tabs - consider code refactoring\n" . $herecurr);
4145 }
4146
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004147 my $ctx_cnt = $realcnt - $#ctx - 1;
4148 my $ctx = join("\n", @ctx);
4149
Andy Whitcroft548596d2008-07-23 21:29:01 -07004150 my $ctx_ln = $linenr;
4151 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004152
Andy Whitcroft548596d2008-07-23 21:29:01 -07004153 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
4154 defined $lines[$ctx_ln - 1] &&
4155 $lines[$ctx_ln - 1] =~ /^-/)) {
4156 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4157 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004158 $ctx_ln++;
4159 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07004160
Andy Whitcroft53210162008-07-23 21:29:03 -07004161 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4162 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07004163
Joe Perchesd752fcc2014-08-06 16:11:05 -07004164 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004165 ERROR("OPEN_BRACE",
4166 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004167 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07004168 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004169 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
4170 $ctx =~ /\)\s*\;\s*$/ &&
4171 defined $lines[$ctx_ln - 1])
4172 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004173 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
4174 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004175 WARN("TRAILING_SEMICOLON",
4176 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004177 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004178 }
4179 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004180 }
4181
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004182# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07004183 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 -08004184 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4185 ctx_statement_block($linenr, $realcnt, 0)
4186 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004187 my ($s, $c) = ($stat, $cond);
4188
4189 substr($s, 0, length($c), '');
4190
Joe Perches9f5af482015-09-09 15:37:30 -07004191 # remove inline comments
4192 $s =~ s/$;/ /g;
4193 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004194
4195 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07004196 my @newlines = ($c =~ /\n/gs);
4197 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004198
Joe Perches9f5af482015-09-09 15:37:30 -07004199 # Make sure we remove the line prefixes as we have
4200 # none on the first line, and are going to readd them
4201 # where necessary.
4202 $s =~ s/\n./\n/gs;
4203 while ($s =~ /\n\s+\\\n/) {
4204 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
4205 }
4206
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004207 # We want to check the first line inside the block
4208 # starting at the end of the conditional, so remove:
4209 # 1) any blank line termination
4210 # 2) any opening brace { on end of the line
4211 # 3) any do (...) {
4212 my $continuation = 0;
4213 my $check = 0;
4214 $s =~ s/^.*\bdo\b//;
4215 $s =~ s/^\s*{//;
4216 if ($s =~ s/^\s*\\//) {
4217 $continuation = 1;
4218 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004219 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004220 $check = 1;
4221 $cond_lines++;
4222 }
4223
4224 # Also ignore a loop construct at the end of a
4225 # preprocessor statement.
4226 if (($prevline =~ /^.\s*#\s*define\s/ ||
4227 $prevline =~ /\\\s*$/) && $continuation == 0) {
4228 $check = 0;
4229 }
4230
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004231 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07004232 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004233 while ($cond_ptr != $cond_lines) {
4234 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004235
Andy Whitcroftf16fa282008-10-15 22:02:32 -07004236 # If we see an #else/#elif then the code
4237 # is not linear.
4238 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
4239 $check = 0;
4240 }
4241
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004242 # Ignore:
4243 # 1) blank lines, they should be at 0,
4244 # 2) preprocessor lines, and
4245 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07004246 if ($continuation ||
4247 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004248 $s =~ /^\s*#\s*?/ ||
4249 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07004250 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07004251 if ($s =~ s/^.*?\n//) {
4252 $cond_lines++;
4253 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004254 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004255 }
4256
4257 my (undef, $sindent) = line_stats("+" . $s);
4258 my $stat_real = raw_line($linenr, $cond_lines);
4259
4260 # Check if either of these lines are modified, else
4261 # this is not this patch's fault.
4262 if (!defined($stat_real) ||
4263 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
4264 $check = 0;
4265 }
4266 if (defined($stat_real) && $cond_lines > 1) {
4267 $stat_real = "[...]\n$stat_real";
4268 }
4269
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004270 #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 -07004271
Joe Perches9f5af482015-09-09 15:37:30 -07004272 if ($check && $s ne '' &&
Antonio Borneo713a09d2020-04-06 20:11:07 -07004273 (($sindent % $tabsize) != 0 ||
Joe Perches9f5af482015-09-09 15:37:30 -07004274 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07004275 ($sindent == $indent &&
4276 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Antonio Borneo713a09d2020-04-06 20:11:07 -07004277 ($sindent > $indent + $tabsize))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004278 WARN("SUSPECT_CODE_INDENT",
4279 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004280 }
4281 }
4282
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004283 # Track the 'values' across context and added lines.
4284 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004285 my ($curr_values, $curr_vars) =
4286 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004287 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004288 if ($dbg_values) {
4289 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004290 print "$linenr > .$outline\n";
4291 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004292 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004293 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004294 $prev_values = substr($curr_values, -1);
4295
Andy Whitcroft00df3442007-06-08 13:47:06 -07004296#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07004297 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07004298
Joe Perches99ca38c2020-10-15 20:12:09 -07004299# check for self assignments used to avoid compiler warnings
4300# e.g.: int foo = foo, *bar = NULL;
4301# struct foo bar = *(&(bar));
4302 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
4303 my $var = $1;
4304 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4305 WARN("SELF_ASSIGNMENT",
4306 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
4307 }
4308 }
4309
Joe Perches11ca40a2016-12-12 16:46:31 -08004310# check for dereferences that span multiple lines
4311 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
4312 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
4313 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
4314 my $ref = $1;
4315 $line =~ /^.\s*($Lval)/;
4316 $ref .= $1;
4317 $ref =~ s/\s//g;
4318 WARN("MULTILINE_DEREFERENCE",
4319 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
4320 }
4321
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004322# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07004323 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 -07004324 my $type = $1;
4325 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07004326 $var = "" if (!defined $var);
4327 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004328 my $sign = $1;
4329 my $pointer = $2;
4330
4331 $pointer = "" if (!defined $pointer);
4332
4333 if (WARN("UNSPECIFIED_INT",
4334 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4335 $fix) {
4336 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07004337 my $comp_pointer = $pointer;
4338 $comp_pointer =~ s/\s//g;
4339 $decl .= $comp_pointer;
4340 $decl = rtrim($decl) if ($var eq "");
4341 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004342 }
4343 }
4344 }
4345
Andy Whitcroft653d4872007-06-23 17:16:34 -07004346# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07004347 if ($dbg_type) {
4348 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004349 ERROR("TEST_TYPE",
4350 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004351 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004352 ERROR("TEST_NOT_TYPE",
4353 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004354 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004355 next;
4356 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004357# TEST: allow direct testing of the attribute matcher.
4358 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004359 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004360 ERROR("TEST_ATTR",
4361 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004362 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004363 ERROR("TEST_NOT_ATTR",
4364 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004365 }
4366 next;
4367 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004368
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004369# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07004370 if ($line =~ /^.\s*{/ &&
4371 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07004372 if (ERROR("OPEN_BRACE",
4373 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004374 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4375 fix_delete_line($fixlinenr - 1, $prevrawline);
4376 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004377 my $fixedline = $prevrawline;
4378 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004379 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004380 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004381 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004382 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004383 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004384 }
4385
Andy Whitcroft653d4872007-06-23 17:16:34 -07004386#
4387# Checks which are anchored on the added line.
4388#
4389
4390# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004391 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07004392 my $path = $1;
4393 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004394 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08004395 "malformed #include filename\n" . $herecurr);
4396 }
4397 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4398 ERROR("UAPI_INCLUDE",
4399 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004400 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004401 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004402
4403# no C99 // comments
4404 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07004405 if (ERROR("C99_COMMENTS",
4406 "do not use C99 // comments\n" . $herecurr) &&
4407 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004408 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07004409 if ($line =~ /\/\/(.*)$/) {
4410 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07004411 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07004412 }
4413 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004414 }
4415 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004416 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004417 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004418
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004419# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4420# the whole statement.
4421#print "APW <$lines[$realline_next - 1]>\n";
4422 if (defined $realline_next &&
4423 exists $lines[$realline_next - 1] &&
4424 !defined $suppress_export{$realline_next} &&
Christoph Hellwig36794822021-02-02 13:13:34 +01004425 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004426 # Handle definitions which produce identifiers with
4427 # a prefix:
4428 # XXX(foo);
4429 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004430 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08004431 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004432 $name =~ /^${Ident}_$2/) {
4433#print "FOO C name<$name>\n";
4434 $suppress_export{$realline_next} = 1;
4435
4436 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004437 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07004438 ^.DEFINE_$Ident\(\Q$name\E\)|
4439 ^.DECLARE_$Ident\(\Q$name\E\)|
4440 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004441 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4442 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07004443 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004444#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4445 $suppress_export{$realline_next} = 2;
4446 } else {
4447 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004448 }
4449 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004450 if (!defined $suppress_export{$linenr} &&
4451 $prevline =~ /^.\s*$/ &&
Christoph Hellwig36794822021-02-02 13:13:34 +01004452 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004453#print "FOO B <$lines[$linenr - 1]>\n";
4454 $suppress_export{$linenr} = 2;
4455 }
4456 if (defined $suppress_export{$linenr} &&
4457 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004458 WARN("EXPORT_SYMBOL",
4459 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004460 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004461
Joe Eloff5150bda2010-08-09 17:21:00 -07004462# check for global initialisers.
Song Liu5b8f82e2021-02-25 17:22:08 -08004463 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ &&
4464 !exclude_global_initialisers($realfile)) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004465 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004466 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07004467 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004468 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004469 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004470 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004471# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004472 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004473 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004474 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07004475 $herecurr) &&
4476 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004477 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004478 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004479 }
4480
Joe Perches18130872014-08-06 16:11:22 -07004481# check for misordered declarations of char/short/int/long with signed/unsigned
4482 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4483 my $tmp = trim($1);
4484 WARN("MISORDERED_TYPE",
4485 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4486 }
4487
Joe Perches809e0822018-08-21 21:58:12 -07004488# check for unnecessary <signed> int declarations of short/long/long long
4489 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4490 my $type = trim($1);
4491 next if ($type !~ /\bint\b/);
4492 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4493 my $new_type = $type;
4494 $new_type =~ s/\b\s*int\s*\b/ /;
4495 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4496 $new_type =~ s/^const\s+//;
4497 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4498 $new_type = "const $new_type" if ($type =~ /^const\b/);
4499 $new_type =~ s/\s+/ /g;
4500 $new_type = trim($new_type);
4501 if (WARN("UNNECESSARY_INT",
4502 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4503 $fix) {
4504 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4505 }
4506 }
4507
Joe Perchescb710ec2010-10-26 14:23:20 -07004508# check for static const char * arrays.
4509 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004510 WARN("STATIC_CONST_CHAR_ARRAY",
4511 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004512 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004513 }
4514
4515# check for initialized const char arrays that should be static const
4516 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4517 if (WARN("STATIC_CONST_CHAR_ARRAY",
4518 "const array should probably be static const\n" . $herecurr) &&
4519 $fix) {
4520 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4521 }
4522 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004523
4524# check for static char foo[] = "bar" declarations.
4525 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004526 WARN("STATIC_CONST_CHAR_ARRAY",
4527 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004528 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004529 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004530
Joe Perchesab7e23f2015-04-16 12:44:22 -07004531# check for const <foo> const where <foo> is not a pointer or array type
4532 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4533 my $found = $1;
4534 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4535 WARN("CONST_CONST",
4536 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4537 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4538 WARN("CONST_CONST",
4539 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4540 }
4541 }
4542
Joe Perches73169762020-12-15 20:44:30 -08004543# check for const static or static <non ptr type> const declarations
4544# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4545 if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
4546 $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
4547 if (WARN("STATIC_CONST",
4548 "Move const after static - use 'static const $1'\n" . $herecurr) &&
4549 $fix) {
4550 $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
4551 $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
4552 }
4553 }
4554
Joe Perches9b0fa602014-04-03 14:49:18 -07004555# check for non-global char *foo[] = {"bar", ...} declarations.
4556 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4557 WARN("STATIC_CONST_CHAR_ARRAY",
4558 "char * array declaration might be better as static const\n" .
4559 $herecurr);
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08004560 }
Joe Perches9b0fa602014-04-03 14:49:18 -07004561
Joe Perchesb598b672015-04-16 12:44:36 -07004562# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4563 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4564 my $array = $1;
4565 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4566 my $array_div = $1;
4567 if (WARN("ARRAY_SIZE",
4568 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4569 $fix) {
4570 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4571 }
4572 }
4573 }
4574
Joe Perchesb36190c2014-01-27 17:07:18 -08004575# check for function declarations without arguments like "int foo()"
Joe Perches16b7f3c2020-04-06 20:11:17 -07004576 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Joe Perchesb36190c2014-01-27 17:07:18 -08004577 if (ERROR("FUNCTION_WITHOUT_ARGS",
4578 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4579 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004580 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004581 }
4582 }
4583
Andy Whitcroft653d4872007-06-23 17:16:34 -07004584# check for new typedefs, only function parameters and sparse annotations
4585# make sense.
4586 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004587 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004588 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004589 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004590 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004591 WARN("NEW_TYPEDEFS",
4592 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004593 }
4594
4595# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004596 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004597 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4598 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004599 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004600
Andy Whitcroft65863862009-01-06 14:41:21 -08004601 # Should start with a space.
4602 $to =~ s/^(\S)/ $1/;
4603 # Should not end with a space.
4604 $to =~ s/\s+$//;
4605 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004606 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004607 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004608
Joe Perches3705ce52013-07-03 15:05:31 -07004609## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004610 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004611 if (ERROR("POINTER_LOCATION",
4612 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4613 $fix) {
4614 my $sub_from = $ident;
4615 my $sub_to = $ident;
4616 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004617 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004618 s@\Q$sub_from\E@$sub_to@;
4619 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004620 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004621 }
4622 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4623 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004624 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004625
Andy Whitcroft65863862009-01-06 14:41:21 -08004626 # Should start with a space.
4627 $to =~ s/^(\S)/ $1/;
4628 # Should not end with a space.
4629 $to =~ s/\s+$//;
4630 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004631 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004632 }
4633 # Modifiers should have spaces.
4634 $to =~ s/(\b$Modifier$)/$1 /;
4635
Joe Perches3705ce52013-07-03 15:05:31 -07004636## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004637 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004638 if (ERROR("POINTER_LOCATION",
4639 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4640 $fix) {
4641
4642 my $sub_from = $match;
4643 my $sub_to = $match;
4644 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004645 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004646 s@\Q$sub_from\E@$sub_to@;
4647 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004648 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004649 }
4650
Joe Perches9d3e3c72015-09-09 15:37:27 -07004651# avoid BUG() or BUG_ON()
4652 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004653 my $msg_level = \&WARN;
4654 $msg_level = \&CHK if ($file);
4655 &{$msg_level}("AVOID_BUG",
4656 "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 -07004657 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004658
Joe Perches9d3e3c72015-09-09 15:37:27 -07004659# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004660 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004661 WARN("LINUX_VERSION_CODE",
4662 "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 -08004663 }
4664
Joe Perches17441222011-06-15 15:08:17 -07004665# check for uses of printk_ratelimit
4666 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004667 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004668 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004669 }
4670
Joe Percheseeef5732017-11-17 15:28:41 -08004671# printk should use KERN_* levels
4672 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4673 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4674 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004675 }
4676
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004677# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4678 if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) {
4679 my $printk = $1;
4680 my $modifier = $2;
4681 my $orig = $3;
4682 $modifier = "" if (!defined($modifier));
Joe Perches243f3802012-05-31 16:26:09 -07004683 my $level = lc($orig);
4684 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004685 my $level2 = $level;
4686 $level2 = "dbg" if ($level eq "debug");
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004687 $level .= $modifier;
4688 $level2 .= $modifier;
Joe Perches243f3802012-05-31 16:26:09 -07004689 WARN("PREFER_PR_LEVEL",
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004690 "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 -07004691 }
4692
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004693# prefer dev_<level> to dev_printk(KERN_<LEVEL>
Joe Perchesdc139312013-02-21 16:44:13 -08004694 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4695 my $orig = $1;
4696 my $level = lc($orig);
4697 $level = "warn" if ($level eq "warning");
4698 $level = "dbg" if ($level eq "debug");
4699 WARN("PREFER_DEV_LEVEL",
4700 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4701 }
4702
Nicolas Boichat8020b252020-10-15 20:12:02 -07004703# trace_printk should not be used in production code.
4704 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4705 WARN("TRACE_PRINTK",
4706 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4707 }
4708
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004709# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4710# number of false positives, but assembly files are not checked, so at
4711# least the arch entry code will not trigger this warning.
4712 if ($line =~ /\bENOSYS\b/) {
4713 WARN("ENOSYS",
4714 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4715 }
4716
Jakub Kicinski6b9ea5f2020-05-11 10:08:07 -07004717# ENOTSUPP is not a standard error code and should be avoided in new patches.
4718# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4719# Similarly to ENOSYS warning a small number of false positives is expected.
4720 if (!$file && $line =~ /\bENOTSUPP\b/) {
4721 if (WARN("ENOTSUPP",
4722 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4723 $fix) {
4724 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4725 }
4726 }
4727
Andy Whitcroft653d4872007-06-23 17:16:34 -07004728# function brace can't be on same line, except for #defines of do while,
4729# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004730 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004731 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4732 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4733 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004734 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004735 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004736 $fix) {
4737 fix_delete_line($fixlinenr, $rawline);
4738 my $fixed_line = $rawline;
Dwaipayan Ray03f49352020-12-15 20:45:02 -08004739 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
Joe Perches8d182472014-08-06 16:11:12 -07004740 my $line1 = $1;
4741 my $line2 = $2;
4742 fix_insert_line($fixlinenr, ltrim($line1));
4743 fix_insert_line($fixlinenr, "\+{");
4744 if ($line2 !~ /^\s*$/) {
4745 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4746 }
4747 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004748 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004749
Andy Whitcroft8905a672007-11-28 16:21:06 -08004750# open braces for enum, union and struct go on the same line.
4751 if ($line =~ /^.\s*{/ &&
4752 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004753 if (ERROR("OPEN_BRACE",
4754 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4755 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4756 fix_delete_line($fixlinenr - 1, $prevrawline);
4757 fix_delete_line($fixlinenr, $rawline);
4758 my $fixedline = rtrim($prevrawline) . " {";
4759 fix_insert_line($fixlinenr, $fixedline);
4760 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004761 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004762 if ($fixedline !~ /^\+\s*$/) {
4763 fix_insert_line($fixlinenr, $fixedline);
4764 }
4765 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004766 }
4767
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004768# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004769 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4770 if (WARN("SPACING",
4771 "missing space after $1 definition\n" . $herecurr) &&
4772 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004773 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004774 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4775 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004776 }
4777
Joe Perches31070b52014-01-23 15:54:49 -08004778# Function pointer declarations
4779# check spacing between type, funcptr, and args
4780# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004781 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004782 my $declare = $1;
4783 my $pre_pointer_space = $2;
4784 my $post_pointer_space = $3;
4785 my $funcname = $4;
4786 my $post_funcname_space = $5;
4787 my $pre_args_space = $6;
4788
Joe Perches91f72e92014-04-03 14:49:12 -07004789# the $Declare variable will capture all spaces after the type
4790# so check it for a missing trailing missing space but pointer return types
4791# don't need a space so don't warn for those.
4792 my $post_declare_space = "";
4793 if ($declare =~ /(\s+)$/) {
4794 $post_declare_space = $1;
4795 $declare = rtrim($declare);
4796 }
4797 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004798 WARN("SPACING",
4799 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004800 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004801 }
4802
4803# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004804# This test is not currently implemented because these declarations are
4805# equivalent to
4806# int foo(int bar, ...)
4807# and this is form shouldn't/doesn't generate a checkpatch warning.
4808#
4809# elsif ($declare =~ /\s{2,}$/) {
4810# WARN("SPACING",
4811# "Multiple spaces after return type\n" . $herecurr);
4812# }
Joe Perches31070b52014-01-23 15:54:49 -08004813
4814# unnecessary space "type ( *funcptr)(args...)"
4815 if (defined $pre_pointer_space &&
4816 $pre_pointer_space =~ /^\s/) {
4817 WARN("SPACING",
4818 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4819 }
4820
4821# unnecessary space "type (* funcptr)(args...)"
4822 if (defined $post_pointer_space &&
4823 $post_pointer_space =~ /^\s/) {
4824 WARN("SPACING",
4825 "Unnecessary space before function pointer name\n" . $herecurr);
4826 }
4827
4828# unnecessary space "type (*funcptr )(args...)"
4829 if (defined $post_funcname_space &&
4830 $post_funcname_space =~ /^\s/) {
4831 WARN("SPACING",
4832 "Unnecessary space after function pointer name\n" . $herecurr);
4833 }
4834
4835# unnecessary space "type (*funcptr) (args...)"
4836 if (defined $pre_args_space &&
4837 $pre_args_space =~ /^\s/) {
4838 WARN("SPACING",
4839 "Unnecessary space before function pointer arguments\n" . $herecurr);
4840 }
4841
4842 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004843 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004844 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004845 }
4846 }
4847
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004848# check for spacing round square brackets; allowed:
4849# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004850# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4851# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004852 while ($line =~ /(.*?\s)\[/g) {
4853 my ($where, $prefix) = ($-[1], $1);
4854 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004855 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004856 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004857 if (ERROR("BRACKET_SPACE",
4858 "space prohibited before open square bracket '['\n" . $herecurr) &&
4859 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004860 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004861 s/^(\+.*?)\s+\[/$1\[/;
4862 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004863 }
4864 }
4865
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004866# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004867 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004868 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004869 my $ctx_before = substr($line, 0, $-[1]);
4870 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004871
4872 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004873 if ($name =~ /^(?:
4874 if|for|while|switch|return|case|
4875 volatile|__volatile__|
4876 __attribute__|format|__extension__|
4877 asm|__asm__)$/x)
4878 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004879 # cpp #define statements have non-optional spaces, ie
4880 # if there is a space between the name and the open
4881 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004882 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004883
4884 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004885 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004886
4887 # If this whole things ends with a type its most
4888 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004889 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004890
4891 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004892 if (WARN("SPACING",
4893 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4894 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004895 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004896 s/\b$name\s+\(/$name\(/;
4897 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004898 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004899 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004900
Andy Whitcroft653d4872007-06-23 17:16:34 -07004901# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004902 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004903 my $fixed_line = "";
4904 my $line_fixed = 0;
4905
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004906 my $ops = qr{
4907 <<=|>>=|<=|>=|==|!=|
4908 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4909 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004910 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004911 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004912 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004913 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004914
4915## print("element count: <" . $#elements . ">\n");
4916## foreach my $el (@elements) {
4917## print("el: <$el>\n");
4918## }
4919
4920 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004921 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004922
Joe Perches3705ce52013-07-03 15:05:31 -07004923 foreach my $el (@elements) {
4924 push(@fix_elements, substr($rawline, $off, length($el)));
4925 $off += length($el);
4926 }
4927
4928 $off = 0;
4929
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004930 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004931 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004932
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004933 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004934
4935 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4936
4937## print("n: <$n> good: <$good>\n");
4938
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004939 $off += length($elements[$n]);
4940
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004941 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004942 my $ca = substr($opline, 0, $off);
4943 my $cc = '';
4944 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4945 $cc = substr($opline, $off + length($elements[$n + 1]));
4946 }
4947 my $cb = "$ca$;$cc";
4948
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004949 my $a = '';
4950 $a = 'V' if ($elements[$n] ne '');
4951 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004952 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004953 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4954 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004955 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004956
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004957 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004958
4959 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004960 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004961 $c = 'V' if ($elements[$n + 2] ne '');
4962 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004963 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004964 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4965 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004966 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004967 } else {
4968 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004969 }
4970
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004971 my $ctx = "${a}x${c}";
4972
4973 my $at = "(ctx:$ctx)";
4974
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004975 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004976 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004977
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004978 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004979 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004980
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004981 # Get the full operator variant.
4982 my $opv = $op . substr($curr_vars, $off, 1);
4983
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004984 # Ignore operators passed as parameters.
4985 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004986 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004987
Andy Whitcroftcf655042008-03-04 14:28:20 -08004988# # Ignore comments
4989# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004990
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004991 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004992 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004993 if ($ctx !~ /.x[WEBC]/ &&
4994 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004995 if (ERROR("SPACING",
4996 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004997 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004998 $line_fixed = 1;
4999 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005000 }
5001
5002 # // is a comment
5003 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005004
Joe Perchesb00e4812014-04-03 14:49:33 -07005005 # : when part of a bitfield
5006 } elsif ($opv eq ':B') {
5007 # skip the bitfield test for now
5008
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005009 # No spaces for:
5010 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07005011 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005012 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005013 if (ERROR("SPACING",
5014 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005015 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005016 if (defined $fix_elements[$n + 2]) {
5017 $fix_elements[$n + 2] =~ s/^\s+//;
5018 }
Joe Perchesb34c6482013-09-11 14:24:01 -07005019 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07005020 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005021 }
5022
Joe Perches23810972014-12-10 15:51:32 -08005023 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005024 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08005025 my $rtrim_before = 0;
5026 my $space_after = 0;
5027 if ($ctx =~ /Wx./) {
5028 if (ERROR("SPACING",
5029 "space prohibited before that '$op' $at\n" . $hereptr)) {
5030 $line_fixed = 1;
5031 $rtrim_before = 1;
5032 }
5033 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005034 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005035 if (ERROR("SPACING",
5036 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005037 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07005038 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08005039 $space_after = 1;
5040 }
5041 }
5042 if ($rtrim_before || $space_after) {
5043 if ($rtrim_before) {
5044 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5045 } else {
5046 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
5047 }
5048 if ($space_after) {
5049 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07005050 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005051 }
5052
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005053 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07005054 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005055 #warn "'*' is part of type\n";
5056
5057 # unary operators should have a space before and
5058 # none after. May be left adjacent to another
5059 # unary operator, or a cast
5060 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07005061 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07005062 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005063 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005064 if (ERROR("SPACING",
5065 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005066 if ($n != $last_after + 2) {
5067 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
5068 $line_fixed = 1;
5069 }
Joe Perches3705ce52013-07-03 15:05:31 -07005070 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005071 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08005072 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005073 # A unary '*' may be const
5074
5075 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005076 if (ERROR("SPACING",
5077 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005078 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005079 if (defined $fix_elements[$n + 2]) {
5080 $fix_elements[$n + 2] =~ s/^\s+//;
5081 }
Joe Perchesb34c6482013-09-11 14:24:01 -07005082 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07005083 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005084 }
5085
5086 # unary ++ and unary -- are allowed no space on one side.
5087 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005088 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005089 if (ERROR("SPACING",
5090 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005091 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07005092 $line_fixed = 1;
5093 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005094 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005095 if ($ctx =~ /Wx[BE]/ ||
5096 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005097 if (ERROR("SPACING",
5098 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005099 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005100 $line_fixed = 1;
5101 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005102 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005103 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005104 if (ERROR("SPACING",
5105 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005106 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005107 if (defined $fix_elements[$n + 2]) {
5108 $fix_elements[$n + 2] =~ s/^\s+//;
5109 }
Joe Perchesb34c6482013-09-11 14:24:01 -07005110 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07005111 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005112 }
5113
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005114 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005115 } elsif ($op eq '<<' or $op eq '>>' or
5116 $op eq '&' or $op eq '^' or $op eq '|' or
5117 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005118 $op eq '*' or $op eq '/' or
5119 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005120 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08005121 if ($check) {
5122 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
5123 if (CHK("SPACING",
5124 "spaces preferred around that '$op' $at\n" . $hereptr)) {
5125 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5126 $fix_elements[$n + 2] =~ s/^\s+//;
5127 $line_fixed = 1;
5128 }
5129 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
5130 if (CHK("SPACING",
5131 "space preferred before that '$op' $at\n" . $hereptr)) {
5132 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
5133 $line_fixed = 1;
5134 }
5135 }
5136 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005137 if (ERROR("SPACING",
5138 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005139 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5140 if (defined $fix_elements[$n + 2]) {
5141 $fix_elements[$n + 2] =~ s/^\s+//;
5142 }
Joe Perches3705ce52013-07-03 15:05:31 -07005143 $line_fixed = 1;
5144 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005145 }
5146
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005147 # A colon needs no spaces before when it is
5148 # terminating a case value or a label.
5149 } elsif ($opv eq ':C' || $opv eq ':L') {
Chris Down263afd32021-02-25 17:22:04 -08005150 if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) {
Joe Perches3705ce52013-07-03 15:05:31 -07005151 if (ERROR("SPACING",
5152 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005153 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005154 $line_fixed = 1;
5155 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005156 }
5157
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005158 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08005159 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005160 my $ok = 0;
5161
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005162 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005163 if (($op eq '<' &&
5164 $cc =~ /^\S+\@\S+>/) ||
5165 ($op eq '>' &&
5166 $ca =~ /<\S+\@\S+$/))
5167 {
Antonio Borneo342d3d22020-04-06 20:11:01 -07005168 $ok = 1;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005169 }
5170
Joe Perchese0df7e12015-04-16 12:44:53 -07005171 # for asm volatile statements
5172 # ignore a colon with another
5173 # colon immediately before or after
5174 if (($op eq ':') &&
5175 ($ca =~ /:$/ || $cc =~ /^:/)) {
5176 $ok = 1;
5177 }
5178
Joe Perches84731622013-11-12 15:10:05 -08005179 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005180 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07005181 my $msg_level = \&ERROR;
5182 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08005183
Jean Delvare0675a8f2017-09-08 16:16:07 -07005184 if (&{$msg_level}("SPACING",
5185 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005186 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5187 if (defined $fix_elements[$n + 2]) {
5188 $fix_elements[$n + 2] =~ s/^\s+//;
5189 }
Joe Perches3705ce52013-07-03 15:05:31 -07005190 $line_fixed = 1;
5191 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005192 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005193 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005194 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005195
5196## print("n: <$n> GOOD: <$good>\n");
5197
5198 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005199 }
Joe Perches3705ce52013-07-03 15:05:31 -07005200
5201 if (($#elements % 2) == 0) {
5202 $fixed_line = $fixed_line . $fix_elements[$#elements];
5203 }
5204
Joe Perches194f66f2014-08-06 16:11:03 -07005205 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
5206 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07005207 }
5208
5209
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005210 }
5211
Joe Perches786b6322013-07-03 15:05:32 -07005212# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08005213 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07005214 if (WARN("SPACING",
5215 "space prohibited before semicolon\n" . $herecurr) &&
5216 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005217 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07005218 s/^(\+.*\S)\s+;/$1;/;
5219 }
5220 }
5221
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005222# check for multiple assignments
5223 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005224 CHK("MULTIPLE_ASSIGNMENTS",
5225 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005226 }
5227
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005228## # check for multiple declarations, allowing for a function declaration
5229## # continuation.
5230## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5231## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5232##
5233## # Remove any bracketed sections to ensure we do not
Dwaipayan Raye73d2712020-12-15 20:44:56 -08005234## # falsely report the parameters of functions.
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005235## my $ln = $line;
5236## while ($ln =~ s/\([^\(\)]*\)//g) {
5237## }
5238## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005239## WARN("MULTIPLE_DECLARATION",
5240## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005241## }
5242## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005243
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005244#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07005245 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005246 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005247 if (ERROR("SPACING",
5248 "space required before the open brace '{'\n" . $herecurr) &&
5249 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005250 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07005251 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005252 }
5253
Joe Perchesc4a62ef2013-07-03 15:05:28 -07005254## # check for blank lines before declarations
5255## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5256## $prevrawline =~ /^.\s*$/) {
5257## WARN("SPACING",
5258## "No blank lines before declarations\n" . $hereprev);
5259## }
5260##
5261
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005262# closing brace should have a space following it when it has anything
5263# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07005264 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005265 if (ERROR("SPACING",
5266 "space required after that close brace '}'\n" . $herecurr) &&
5267 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005268 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07005269 s/}((?!(?:,|;|\)))\S)/} $1/;
5270 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005271 }
5272
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005273# check spacing on square brackets
5274 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005275 if (ERROR("SPACING",
5276 "space prohibited after that open square bracket '['\n" . $herecurr) &&
5277 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005278 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005279 s/\[\s+/\[/;
5280 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005281 }
5282 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005283 if (ERROR("SPACING",
5284 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
5285 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005286 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005287 s/\s+\]/\]/;
5288 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005289 }
5290
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005291# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005292 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
5293 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005294 if (ERROR("SPACING",
5295 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
5296 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005297 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005298 s/\(\s+/\(/;
5299 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005300 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005301 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005302 $line !~ /for\s*\(.*;\s+\)/ &&
5303 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005304 if (ERROR("SPACING",
5305 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
5306 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005307 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005308 s/\s+\)/\)/;
5309 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005310 }
5311
Joe Perchese2826fd2014-08-06 16:10:48 -07005312# check unnecessary parentheses around addressof/dereference single $Lvals
5313# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5314
5315 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08005316 my $var = $1;
5317 if (CHK("UNNECESSARY_PARENTHESES",
5318 "Unnecessary parentheses around $var\n" . $herecurr) &&
5319 $fix) {
5320 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
5321 }
5322 }
5323
5324# check for unnecessary parentheses around function pointer uses
5325# ie: (foo->bar)(); should be foo->bar();
5326# but not "if (foo->bar) (" to avoid some false positives
5327 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
5328 my $var = $2;
5329 if (CHK("UNNECESSARY_PARENTHESES",
5330 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
5331 $fix) {
5332 my $var2 = deparenthesize($var);
5333 $var2 =~ s/\s//g;
5334 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
5335 }
5336 }
Joe Perchese2826fd2014-08-06 16:10:48 -07005337
Joe Perches63b7c732017-09-08 16:16:01 -07005338# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08005339# when !drivers/staging or command-line uses --strict
5340 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07005341 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07005342 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
5343 my $if_stat = $1;
5344 my $test = substr($2, 1, -1);
5345 my $herectx;
5346 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5347 my $match = $1;
5348 # avoid parentheses around potential macro args
5349 next if ($match =~ /^\s*\w+\s*$/);
5350 if (!defined($herectx)) {
5351 $herectx = $here . "\n";
5352 my $cnt = statement_rawlines($if_stat);
5353 for (my $n = 0; $n < $cnt; $n++) {
5354 my $rl = raw_line($linenr, $n);
5355 $herectx .= $rl . "\n";
5356 last if $rl =~ /^[ \+].*\{/;
5357 }
5358 }
5359 CHK("UNNECESSARY_PARENTHESES",
5360 "Unnecessary parentheses around '$match'\n" . $herectx);
5361 }
5362 }
5363
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005364#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005365 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005366 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005367 if (WARN("INDENTED_LABEL",
5368 "labels should not be indented\n" . $herecurr) &&
5369 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005370 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005371 s/^(.)\s+/$1/;
5372 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005373 }
5374
Joe Perches40873ab2020-10-15 20:11:56 -07005375# check if a statement with a comma should be two statements like:
5376# foo = bar(), /* comma should be semicolon */
5377# bar = baz();
5378 if (defined($stat) &&
5379 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5380 my $cnt = statement_rawlines($stat);
5381 my $herectx = get_stat_here($linenr, $cnt, $here);
5382 WARN("SUSPECT_COMMA_SEMICOLON",
5383 "Possible comma where semicolon could be used\n" . $herectx);
5384 }
5385
Joe Perches5b9553a2014-04-03 14:49:21 -07005386# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08005387 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005388 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07005389 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07005390 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
5391 my $value = $1;
5392 $value = deparenthesize($value);
5393 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
5394 ERROR("RETURN_PARENTHESES",
5395 "return is not a function, parentheses are not required\n" . $herecurr);
5396 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005397 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005398 ERROR("SPACING",
5399 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005400 }
5401 }
Joe Perches507e5142013-11-12 15:10:13 -08005402
Joe Perchesb43ae212014-06-23 13:22:07 -07005403# unnecessary return in a void function
5404# at end-of-function, with the previous line a single leading tab, then return;
5405# and the line before that not a goto label target like "out:"
5406 if ($sline =~ /^[ \+]}\s*$/ &&
5407 $prevline =~ /^\+\treturn\s*;\s*$/ &&
5408 $linenr >= 3 &&
5409 $lines[$linenr - 3] =~ /^[ +]/ &&
5410 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07005411 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07005412 "void function return statements are not generally useful\n" . $hereprev);
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08005413 }
Joe Perches9819cf22014-06-04 16:12:09 -07005414
Joe Perches189248d2014-01-23 15:54:47 -08005415# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07005416 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08005417 $line =~ /\bif\s*((?:\(\s*){2,})/) {
5418 my $openparens = $1;
5419 my $count = $openparens =~ tr@\(@\(@;
5420 my $msg = "";
5421 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5422 my $comp = $4; #Not $1 because of $LvalOrFunc
5423 $msg = " - maybe == should be = ?" if ($comp eq "==");
5424 WARN("UNNECESSARY_PARENTHESES",
5425 "Unnecessary parentheses$msg\n" . $herecurr);
5426 }
5427 }
5428
Joe Perchesc5595fa2015-09-09 15:37:58 -07005429# comparisons with a constant or upper case identifier on the left
5430# avoid cases like "foo + BAR < baz"
5431# only fix matches surrounded by parentheses to avoid incorrect
5432# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07005433 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005434 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5435 my $lead = $1;
5436 my $const = $2;
5437 my $comp = $3;
5438 my $to = $4;
5439 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07005440 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005441 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5442 WARN("CONSTANT_COMPARISON",
5443 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5444 $fix) {
5445 if ($comp eq "<") {
5446 $newcomp = ">";
5447 } elsif ($comp eq "<=") {
5448 $newcomp = ">=";
5449 } elsif ($comp eq ">") {
5450 $newcomp = "<";
5451 } elsif ($comp eq ">=") {
5452 $newcomp = "<=";
5453 }
5454 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5455 }
5456 }
5457
Joe Perchesf34e4a42015-04-16 12:44:19 -07005458# Return of what appears to be an errno should normally be negative
5459 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005460 my $name = $1;
5461 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07005462 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07005463 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005464 }
5465 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005466
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005467# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07005468 if ($line =~ /\b(if|while|for|switch)\(/) {
5469 if (ERROR("SPACING",
5470 "space required before the open parenthesis '('\n" . $herecurr) &&
5471 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005472 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005473 s/\b(if|while|for|switch)\(/$1 \(/;
5474 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005475 }
5476
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07005477# Check for illegal assignment in if conditional -- and check for trailing
5478# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005479 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08005480 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5481 ctx_statement_block($linenr, $realcnt, 0)
5482 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005483 my ($stat_next) = ctx_statement_block($line_nr_next,
5484 $remain_next, $off_next);
5485 $stat_next =~ s/\n./\n /g;
5486 ##print "stat<$stat> stat_next<$stat_next>\n";
5487
5488 if ($stat_next =~ /^\s*while\b/) {
5489 # If the statement carries leading newlines,
5490 # then count those as offsets.
5491 my ($whitespace) =
5492 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5493 my $offset =
5494 statement_rawlines($whitespace) - 1;
5495
5496 $suppress_whiletrailers{$line_nr_next +
5497 $offset} = 1;
5498 }
5499 }
5500 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08005501 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005502 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005503 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005504
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08005505 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches65b64b32020-08-11 18:35:10 -07005506 if (ERROR("ASSIGN_IN_IF",
5507 "do not use assignment in if condition\n" . $herecurr) &&
5508 $fix && $perl_version_ok) {
5509 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5510 my $space = $1;
5511 my $not = $2;
5512 my $statement = $3;
5513 my $assigned = $4;
5514 my $test = $8;
5515 my $against = $9;
5516 my $brace = $15;
5517 fix_delete_line($fixlinenr, $rawline);
5518 fix_insert_line($fixlinenr, "$space$statement;");
5519 my $newline = "${space}if (";
5520 $newline .= '!' if defined($not);
5521 $newline .= '(' if (defined $not && defined($test) && defined($against));
5522 $newline .= "$assigned";
5523 $newline .= " $test $against" if (defined($test) && defined($against));
5524 $newline .= ')' if (defined $not && defined($test) && defined($against));
5525 $newline .= ')';
5526 $newline .= " {" if (defined($brace));
5527 fix_insert_line($fixlinenr + 1, $newline);
5528 }
5529 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005530 }
5531
5532 # Find out what is on the end of the line after the
5533 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005534 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08005535 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005536 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07005537 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5538 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005539 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005540 # Find out how long the conditional actually is.
5541 my @newlines = ($c =~ /\n/gs);
5542 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005543 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005544
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005545 $stat_real = raw_line($linenr, $cond_lines)
5546 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005547 if (defined($stat_real) && $cond_lines > 1) {
5548 $stat_real = "[...]\n$stat_real";
5549 }
5550
Joe Perches000d1cc12011-07-25 17:13:25 -07005551 ERROR("TRAILING_STATEMENTS",
5552 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005553 }
5554 }
5555
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005556# Check for bitwise tests written as boolean
5557 if ($line =~ /
5558 (?:
5559 (?:\[|\(|\&\&|\|\|)
5560 \s*0[xX][0-9]+\s*
5561 (?:\&\&|\|\|)
5562 |
5563 (?:\&\&|\|\|)
5564 \s*0[xX][0-9]+\s*
5565 (?:\&\&|\|\||\)|\])
5566 )/x)
5567 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005568 WARN("HEXADECIMAL_BOOLEAN_TEST",
5569 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005570 }
5571
Andy Whitcroft8905a672007-11-28 16:21:06 -08005572# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005573 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5574 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005575 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005576 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005577 ERROR("TRAILING_STATEMENTS",
5578 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005579 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005580 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005581# if should not continue a brace
5582 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005583 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005584 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005585 $herecurr);
5586 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005587# case and default should not have general statements after them
5588 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5589 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005590 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005591 \s*return\s+
5592 )/xg)
5593 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005594 ERROR("TRAILING_STATEMENTS",
5595 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005596 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005597
5598 # Check for }<nl>else {, these must be at the same
5599 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005600 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5601 $previndent == $indent) {
5602 if (ERROR("ELSE_AFTER_BRACE",
5603 "else should follow close brace '}'\n" . $hereprev) &&
5604 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5605 fix_delete_line($fixlinenr - 1, $prevrawline);
5606 fix_delete_line($fixlinenr, $rawline);
5607 my $fixedline = $prevrawline;
5608 $fixedline =~ s/}\s*$//;
5609 if ($fixedline !~ /^\+\s*$/) {
5610 fix_insert_line($fixlinenr, $fixedline);
5611 }
5612 $fixedline = $rawline;
5613 $fixedline =~ s/^(.\s*)else/$1} else/;
5614 fix_insert_line($fixlinenr, $fixedline);
5615 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005616 }
5617
Joe Perches8b8856f2014-08-06 16:11:14 -07005618 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5619 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005620 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5621
5622 # Find out what is on the end of the line after the
5623 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005624 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005625 $s =~ s/\n.*//g;
5626
5627 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005628 if (ERROR("WHILE_AFTER_BRACE",
5629 "while should follow close brace '}'\n" . $hereprev) &&
5630 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5631 fix_delete_line($fixlinenr - 1, $prevrawline);
5632 fix_delete_line($fixlinenr, $rawline);
5633 my $fixedline = $prevrawline;
5634 my $trailing = $rawline;
5635 $trailing =~ s/^\+//;
5636 $trailing = trim($trailing);
5637 $fixedline =~ s/}\s*$/} $trailing/;
5638 fix_insert_line($fixlinenr, $fixedline);
5639 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005640 }
5641 }
5642
Joe Perches95e2c602013-07-03 15:05:20 -07005643#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005644 while ($line =~ m{($Constant|$Lval)}g) {
5645 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005646
Joe Perches95e2c602013-07-03 15:05:20 -07005647#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005648 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005649 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Łukasz Stelmach4104a202020-12-15 20:44:27 -08005650#Ignore some autogenerated defines and enum values
5651 $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005652#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005653 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005654#Ignore SI style variants like nS, mV and dB
5655#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5656 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005657#Ignore some three character SI units explicitly, like MiB and KHz
5658 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005659 while ($var =~ m{($Ident)}g) {
5660 my $word = $1;
5661 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005662 if ($check) {
5663 seed_camelcase_includes();
5664 if (!$file && !$camelcase_file_seeded) {
5665 seed_camelcase_file($realfile);
5666 $camelcase_file_seeded = 1;
5667 }
5668 }
Joe Perches7e781f62013-09-11 14:23:55 -07005669 if (!defined $camelcase{$word}) {
5670 $camelcase{$word} = 1;
5671 CHK("CAMELCASE",
5672 "Avoid CamelCase: <$word>\n" . $herecurr);
5673 }
Joe Perches34456862013-07-03 15:05:34 -07005674 }
Joe Perches323c1262012-12-17 16:02:07 -08005675 }
5676 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005677
5678#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005679 if ($line =~ /\#\s*define.*\\\s+$/) {
5680 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5681 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5682 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005683 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005684 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005685 }
5686
Fabian Frederick0e212e02015-04-16 12:44:25 -07005687# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5688# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005689 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005690 my $file = "$1.h";
5691 my $checkfile = "include/linux/$file";
5692 if (-f "$root/$checkfile" &&
5693 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005694 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005695 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005696 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5697 if ($asminclude > 0) {
5698 if ($realfile =~ m{^arch/}) {
5699 CHK("ARCH_INCLUDE_LINUX",
5700 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5701 } else {
5702 WARN("INCLUDE_LINUX",
5703 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5704 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005705 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005706 }
5707 }
5708
Andy Whitcroft653d4872007-06-23 17:16:34 -07005709# multi-statement macros should be enclosed in a do while loop, grab the
5710# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005711# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07005712 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5713 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005714 my $ln = $linenr;
5715 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005716 my ($off, $dstat, $dcond, $rest);
5717 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005718 my $has_flow_statement = 0;
5719 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005720 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005721 ctx_statement_block($linenr, $realcnt, 0);
5722 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005723 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005724 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005725
Joe Perches08a28432014-10-13 15:51:55 -07005726 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005727 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005728
Joe Perchesf59b64b2016-10-11 13:52:08 -07005729 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5730 my $define_args = $1;
5731 my $define_stmt = $dstat;
5732 my @def_args = ();
5733
5734 if (defined $define_args && $define_args ne "") {
5735 $define_args = substr($define_args, 1, length($define_args) - 2);
5736 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005737 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005738 @def_args = split(",", $define_args);
5739 }
5740
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005741 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005742 $dstat =~ s/\\\n.//g;
5743 $dstat =~ s/^\s*//s;
5744 $dstat =~ s/\s*$//s;
5745
5746 # Flatten any parentheses and braces
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005747 while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
5748 $dstat =~ s/\{[^\{\}]*\}/1u/ ||
5749 $dstat =~ s/.\[[^\[\]]*\]/1u/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005750 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005751 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005752
Antonio Borneo342d3d22020-04-06 20:11:01 -07005753 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005754 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5755 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005756 {
5757 }
5758
Joe Perches42e15292016-03-15 14:58:01 -07005759 # Make asm volatile uses seem like a generic function
5760 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5761
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005762 my $exceptions = qr{
5763 $Declare|
5764 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005765 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005766 DECLARE_PER_CPU|
5767 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005768 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005769 union|
5770 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005771 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005772 ^\"|\"$|
5773 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005774 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005775 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005776
5777 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005778 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005779 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005780
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005781 if ($dstat ne '' &&
5782 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5783 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005784 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005785 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005786 $dstat !~ /$exceptions/ &&
5787 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005788 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005789 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005790 $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...}
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005791 $dstat !~ /^for\s*$Constant$/ && # for (...)
5792 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5793 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005794 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005795 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005796 {
Joe Perchese7955562017-05-08 15:55:48 -07005797 if ($dstat =~ /^\s*if\b/) {
5798 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5799 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5800 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005801 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5802 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5803 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005804 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005805 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005806 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005807
5808 }
Joe Perches52076492016-10-11 13:52:14 -07005809
5810 # Make $define_stmt single line, comment-free, etc
5811 my @stmt_array = split('\n', $define_stmt);
5812 my $first = 1;
5813 $define_stmt = "";
5814 foreach my $l (@stmt_array) {
5815 $l =~ s/\\$//;
5816 if ($first) {
5817 $define_stmt = $l;
5818 $first = 0;
5819 } elsif ($l =~ /^[\+ ]/) {
5820 $define_stmt .= substr($l, 1);
5821 }
5822 }
5823 $define_stmt =~ s/$;//g;
5824 $define_stmt =~ s/\s+/ /g;
5825 $define_stmt = trim($define_stmt);
5826
Joe Perchesf59b64b2016-10-11 13:52:08 -07005827# check if any macro arguments are reused (ignore '...' and 'type')
5828 foreach my $arg (@def_args) {
5829 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005830 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005831 my $tmp_stmt = $define_stmt;
Vincent Mailhol7b844342021-05-06 18:03:58 -07005832 $tmp_stmt =~ s/\b(__must_be_array|offsetof|sizeof|sizeof_field|__stringify|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
Joe Perches7fe528a22017-07-10 15:52:27 -07005833 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5834 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005835 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005836 if ($use_cnt > 1) {
5837 CHK("MACRO_ARG_REUSE",
5838 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005839 }
5840# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005841 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005842 ((defined($1) && $1 ne ',') ||
5843 (defined($2) && $2 ne ','))) {
5844 CHK("MACRO_ARG_PRECEDENCE",
5845 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005846 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005847 }
Joe Perches5023d342012-12-17 16:01:47 -08005848
Joe Perches08a28432014-10-13 15:51:55 -07005849# check for macros with flow control, but without ## concatenation
5850# ## concatenation is commonly a macro that defines a function so ignore those
5851 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005852 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005853 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005854
Joe Perches08a28432014-10-13 15:51:55 -07005855 WARN("MACRO_WITH_FLOW_CONTROL",
5856 "Macros with flow control statements should be avoided\n" . "$herectx");
5857 }
5858
Joe Perches481eb482012-12-17 16:01:56 -08005859# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005860
5861 } else {
5862 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005863 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5864 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005865 $line =~ /^\+.*\\$/) {
5866 WARN("LINE_CONTINUATIONS",
5867 "Avoid unnecessary line continuations\n" . $herecurr);
5868 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005869 }
5870
Joe Perchesb13edf72012-07-30 14:41:24 -07005871# do {} while (0) macro tests:
5872# single-statement macros do not need to be enclosed in do while (0) loop,
5873# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005874 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005875 $realfile !~ m@/vmlinux.lds.h$@ &&
5876 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5877 my $ln = $linenr;
5878 my $cnt = $realcnt;
5879 my ($off, $dstat, $dcond, $rest);
5880 my $ctx = '';
5881 ($dstat, $dcond, $ln, $cnt, $off) =
5882 ctx_statement_block($linenr, $realcnt, 0);
5883 $ctx = $dstat;
5884
5885 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005886 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005887
5888 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5889 my $stmts = $2;
5890 my $semis = $3;
5891
5892 $ctx =~ s/\n*$//;
5893 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005894 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005895
Joe Perchesac8e97f2012-08-21 16:15:53 -07005896 if (($stmts =~ tr/;/;/) == 1 &&
5897 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005898 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5899 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5900 }
5901 if (defined $semis && $semis ne "") {
5902 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5903 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5904 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005905 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5906 $ctx =~ s/\n*$//;
5907 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005908 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005909
5910 WARN("TRAILING_SEMICOLON",
5911 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005912 }
5913 }
5914
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005915# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005916 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5917 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005918 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005919 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005920 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5921 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005922 my @allowed = ();
5923 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005924 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005925 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005926 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005927 for my $chunk (@chunks) {
5928 my ($cond, $block) = @{$chunk};
5929
Andy Whitcroft773647a2008-03-28 14:15:58 -07005930 # If the condition carries leading newlines, then count those as offsets.
5931 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5932 my $offset = statement_rawlines($whitespace) - 1;
5933
Joe Perchesaad4f612012-03-23 15:02:19 -07005934 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005935 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5936
5937 # We have looked at and allowed this specific line.
5938 $suppress_ifbraces{$ln + $offset} = 1;
5939
5940 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005941 $ln += statement_rawlines($block) - 1;
5942
Andy Whitcroft773647a2008-03-28 14:15:58 -07005943 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005944
5945 $seen++ if ($block =~ /^\s*{/);
5946
Joe Perchesaad4f612012-03-23 15:02:19 -07005947 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005948 if (statement_lines($cond) > 1) {
5949 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005950 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005951 }
5952 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005953 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005954 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005955 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005956 if (statement_block_size($block) > 1) {
5957 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005958 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005959 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005960 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005961 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005962 if ($seen) {
5963 my $sum_allowed = 0;
5964 foreach (@allowed) {
5965 $sum_allowed += $_;
5966 }
5967 if ($sum_allowed == 0) {
5968 WARN("BRACES",
5969 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5970 } elsif ($sum_allowed != $allow &&
5971 $seen != $allow) {
5972 CHK("BRACES",
5973 "braces {} should be used on all arms of this statement\n" . $herectx);
5974 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005975 }
5976 }
5977 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005978 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005979 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005980 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005981
Andy Whitcroftcf655042008-03-04 14:28:20 -08005982 # Check the pre-context.
5983 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5984 #print "APW: ALLOWED: pre<$1>\n";
5985 $allowed = 1;
5986 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005987
5988 my ($level, $endln, @chunks) =
5989 ctx_statement_full($linenr, $realcnt, $-[0]);
5990
Andy Whitcroftcf655042008-03-04 14:28:20 -08005991 # Check the condition.
5992 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005993 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005994 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005995 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005996 }
5997 if (statement_lines($cond) > 1) {
5998 #print "APW: ALLOWED: cond<$cond>\n";
5999 $allowed = 1;
6000 }
6001 if ($block =~/\b(?:if|for|while)\b/) {
6002 #print "APW: ALLOWED: block<$block>\n";
6003 $allowed = 1;
6004 }
6005 if (statement_block_size($block) > 1) {
6006 #print "APW: ALLOWED: lines block<$block>\n";
6007 $allowed = 1;
6008 }
6009 # Check the post-context.
6010 if (defined $chunks[1]) {
6011 my ($cond, $block) = @{$chunks[1]};
6012 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07006013 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006014 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08006015 if ($block =~ /^\s*\{/) {
6016 #print "APW: ALLOWED: chunk-1 block<$block>\n";
6017 $allowed = 1;
6018 }
6019 }
6020 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07006021 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006022 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08006023
Joe Perches000d1cc12011-07-25 17:13:25 -07006024 WARN("BRACES",
6025 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006026 }
6027 }
6028
Joe Perchese4c5bab2017-02-24 15:01:41 -08006029# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08006030 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
6031 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08006032 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
6033 }
6034
Joe Perches0979ae62012-12-17 16:01:59 -08006035# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07006036 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08006037 if (CHK("BRACES",
6038 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
6039 $fix && $prevrawline =~ /^\+/) {
6040 fix_delete_line($fixlinenr - 1, $prevrawline);
6041 }
Joe Perches0979ae62012-12-17 16:01:59 -08006042 }
Joe Perches77b9a532013-07-03 15:05:29 -07006043 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08006044 if (CHK("BRACES",
6045 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
6046 $fix) {
6047 fix_delete_line($fixlinenr, $rawline);
6048 }
Joe Perches0979ae62012-12-17 16:01:59 -08006049 }
6050
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006051# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07006052 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
6053 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006054 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006055 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006056 }
6057
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006058# Check for user-visible strings broken across lines, which breaks the ability
6059# to grep for the string. Make exceptions when the previous string ends in a
6060# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
6061# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07006062 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006063 $prevline =~ /"\s*$/ &&
6064 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
6065 if (WARN("SPLIT_STRING",
6066 "quoted string split across lines\n" . $hereprev) &&
6067 $fix &&
6068 $prevrawline =~ /^\+.*"\s*$/ &&
6069 $last_coalesced_string_linenr != $linenr - 1) {
6070 my $extracted_string = get_quoted_string($line, $rawline);
6071 my $comma_close = "";
6072 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
6073 $comma_close = $1;
6074 }
6075
6076 fix_delete_line($fixlinenr - 1, $prevrawline);
6077 fix_delete_line($fixlinenr, $rawline);
6078 my $fixedline = $prevrawline;
6079 $fixedline =~ s/"\s*$//;
6080 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
6081 fix_insert_line($fixlinenr - 1, $fixedline);
6082 $fixedline = $rawline;
6083 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
6084 if ($fixedline !~ /\+\s*$/) {
6085 fix_insert_line($fixlinenr, $fixedline);
6086 }
6087 $last_coalesced_string_linenr = $linenr;
6088 }
6089 }
6090
6091# check for missing a space in a string concatenation
6092 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
6093 WARN('MISSING_SPACE',
6094 "break quoted strings at a space character\n" . $hereprev);
6095 }
6096
Joe Perchese4b7d302017-05-08 15:55:51 -07006097# check for an embedded function name in a string when the function is known
6098# This does not work very well for -f --file checking as it depends on patch
6099# context providing the function name or a single line form for in-file
6100# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08006101 if ($line =~ /^\+.*$String/ &&
6102 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07006103 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
6104 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08006105 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07006106 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08006107 }
6108
Joe Perchesadb2da82021-02-25 17:21:50 -08006109# check for unnecessary function tracing like uses
6110# This does not use $logFunctions because there are many instances like
6111# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions
6112 if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) {
6113 if (WARN("TRACING_LOGGING",
6114 "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) &&
6115 $fix) {
6116 fix_delete_line($fixlinenr, $rawline);
6117 }
6118 }
6119
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006120# check for spaces before a quoted newline
6121 if ($rawline =~ /^.*\".*\s\\n/) {
6122 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
6123 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
6124 $fix) {
6125 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
6126 }
6127
6128 }
6129
Joe Perchesf17dba42014-10-13 15:51:51 -07006130# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07006131 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
6132 if (CHK("CONCATENATED_STRING",
6133 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
6134 $fix) {
6135 while ($line =~ /($String)/g) {
6136 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6137 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
6138 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
6139 }
6140 }
Joe Perchesf17dba42014-10-13 15:51:51 -07006141 }
6142
Joe Perches90ad30e2014-12-10 15:51:59 -08006143# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07006144 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07006145 if (WARN("STRING_FRAGMENTS",
6146 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
6147 $fix) {
6148 while ($line =~ /($String)(?=\s*")/g) {
6149 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6150 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
6151 }
6152 }
Joe Perches90ad30e2014-12-10 15:51:59 -08006153 }
6154
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006155# check for non-standard and hex prefixed decimal printf formats
6156 my $show_L = 1; #don't show the same defect twice
6157 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006158 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006159 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006160 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006161 # check for %L
6162 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006163 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006164 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
6165 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006166 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006167 # check for %Z
6168 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
6169 WARN("PRINTF_Z",
6170 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
6171 $show_Z = 0;
6172 }
6173 # check for 0x<decimal>
6174 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
6175 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07006176 "Prefixing 0x with decimal output is defective\n" . $herecurr);
6177 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006178 }
6179
6180# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08006181 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006182 WARN("LINE_CONTINUATIONS",
6183 "Avoid line continuations in quoted strings\n" . $herecurr);
6184 }
6185
Andy Whitcroft00df3442007-06-08 13:47:06 -07006186# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006187 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07006188 WARN("IF_0",
6189 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
6190 }
6191
6192# warn about #if 1
6193 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
6194 WARN("IF_1",
6195 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006196 }
6197
Andy Whitcroft03df4b52012-12-17 16:01:52 -08006198# check for needless "if (<foo>) fn(<foo>)" uses
6199 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07006200 my $tested = quotemeta($1);
6201 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
6202 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6203 my $func = $1;
6204 if (WARN('NEEDLESS_IF',
6205 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
6206 $fix) {
6207 my $do_fix = 1;
6208 my $leading_tabs = "";
6209 my $new_leading_tabs = "";
6210 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
6211 $leading_tabs = $1;
6212 } else {
6213 $do_fix = 0;
6214 }
6215 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
6216 $new_leading_tabs = $1;
6217 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
6218 $do_fix = 0;
6219 }
6220 } else {
6221 $do_fix = 0;
6222 }
6223 if ($do_fix) {
6224 fix_delete_line($fixlinenr - 1, $prevrawline);
6225 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
6226 }
6227 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07006228 }
6229 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006230
Joe Perchesebfdc402014-08-06 16:10:27 -07006231# check for unnecessary "Out of Memory" messages
6232 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
6233 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
6234 (defined $1 || defined $3) &&
6235 $linenr > 3) {
6236 my $testval = $2;
6237 my $testline = $lines[$linenr - 3];
6238
6239 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
6240# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6241
Joe Perchese29a70f2019-03-07 16:28:35 -08006242 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6243 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07006244 WARN("OOM_MESSAGE",
6245 "Possible unnecessary 'out of memory' message\n" . $hereprev);
6246 }
6247 }
6248
Joe Perchesf78d98f2014-10-13 15:52:01 -07006249# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08006250 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07006251 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
6252 my $level = $1;
6253 if (WARN("UNNECESSARY_KERN_LEVEL",
6254 "Possible unnecessary $level\n" . $herecurr) &&
6255 $fix) {
6256 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
6257 }
6258 }
6259
Joe Perches45c55e92017-02-24 15:01:31 -08006260# check for logging continuations
6261 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
6262 WARN("LOGGING_CONTINUATION",
6263 "Avoid logging continuation uses where feasible\n" . $herecurr);
6264 }
6265
Dwaipayan Ray70eb2272020-12-15 20:45:15 -08006266# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6267 if (defined $stat &&
6268 $line =~ /\b$logFunctions\s*\(/ &&
6269 index($stat, '"') >= 0) {
6270 my $lc = $stat =~ tr@\n@@;
6271 $lc = $lc + $linenr;
6272 my $stat_real = get_stat_real($linenr, $lc);
6273 pos($stat_real) = index($stat_real, '"');
6274 while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) {
6275 my $pspec = $1;
6276 my $h = $2;
6277 my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@;
6278 if (WARN("UNNECESSARY_MODIFIER",
6279 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") &&
6280 $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) {
6281 my $nspec = $pspec;
6282 $nspec =~ s/h//g;
6283 $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/;
6284 }
6285 }
6286 }
6287
Joe Perchesabb08a52014-12-10 15:51:46 -08006288# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07006289 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08006290 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
6291 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
6292 WARN("MASK_THEN_SHIFT",
6293 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
6294 }
6295
Joe Perchesb75ac612014-12-10 15:52:02 -08006296# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07006297 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08006298 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
6299 my $val = $1;
6300 my $equal = "!";
6301 $equal = "" if ($4 eq "!=");
6302 if (CHK("COMPARISON_TO_NULL",
6303 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
6304 $fix) {
6305 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
6306 }
6307 }
6308 }
6309
Joe Perches8716de32013-09-11 14:24:05 -07006310# check for bad placement of section $InitAttribute (e.g.: __initdata)
6311 if ($line =~ /(\b$InitAttribute\b)/) {
6312 my $attr = $1;
6313 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6314 my $ptr = $1;
6315 my $var = $2;
6316 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
6317 ERROR("MISPLACED_INIT",
6318 "$attr should be placed after $var\n" . $herecurr)) ||
6319 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
6320 WARN("MISPLACED_INIT",
6321 "$attr should be placed after $var\n" . $herecurr))) &&
6322 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006323 $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 -07006324 }
6325 }
6326 }
6327
Joe Perchese970b8842013-11-12 15:10:10 -08006328# check for $InitAttributeData (ie: __initdata) with const
6329 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
6330 my $attr = $1;
6331 $attr =~ /($InitAttributePrefix)(.*)/;
6332 my $attr_prefix = $1;
6333 my $attr_type = $2;
6334 if (ERROR("INIT_ATTRIBUTE",
6335 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
6336 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006337 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006338 s/$InitAttributeData/${attr_prefix}initconst/;
6339 }
6340 }
6341
6342# check for $InitAttributeConst (ie: __initconst) without const
6343 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
6344 my $attr = $1;
6345 if (ERROR("INIT_ATTRIBUTE",
6346 "Use of $attr requires a separate use of const\n" . $herecurr) &&
6347 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006348 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006349 /(^\+\s*(?:static\s+))/;
6350 $lead = rtrim($1);
6351 $lead = "$lead " if ($lead !~ /^\+$/);
6352 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07006353 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08006354 }
6355 }
6356
Joe Perchesc17893c2015-04-16 12:44:42 -07006357# check for __read_mostly with const non-pointer (should just be const)
6358 if ($line =~ /\b__read_mostly\b/ &&
6359 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
6360 if (ERROR("CONST_READ_MOSTLY",
6361 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
6362 $fix) {
6363 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
6364 }
6365 }
6366
Joe Perchesfbdb8132014-04-03 14:49:14 -07006367# don't use __constant_<foo> functions outside of include/uapi/
6368 if ($realfile !~ m@^include/uapi/@ &&
6369 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6370 my $constant_func = $1;
6371 my $func = $constant_func;
6372 $func =~ s/^__constant_//;
6373 if (WARN("CONSTANT_CONVERSION",
6374 "$constant_func should be $func\n" . $herecurr) &&
6375 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006376 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07006377 }
6378 }
6379
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006380# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08006381 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07006382 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006383 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07006384 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006385 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006386 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07006387 }
6388 if ($delay > 2000) {
6389 WARN("LONG_UDELAY",
6390 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006391 }
6392 }
6393
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006394# warn about unexpectedly long msleep's
6395 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
6396 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006397 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006398 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006399 }
6400 }
6401
Joe Perches36ec1932013-07-03 15:05:25 -07006402# check for comparisons of jiffies
6403 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
6404 WARN("JIFFIES_COMPARISON",
6405 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6406 }
6407
Joe Perches9d7a34a2013-07-03 15:05:26 -07006408# check for comparisons of get_jiffies_64()
6409 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
6410 WARN("JIFFIES_COMPARISON",
6411 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6412 }
6413
Andy Whitcroft00df3442007-06-08 13:47:06 -07006414# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006415# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07006416# print "#ifdef in C files should be avoided\n";
6417# print "$herecurr";
6418# $clean = 0;
6419# }
6420
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006421# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006422 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07006423 if (ERROR("SPACING",
6424 "exactly one space required after that #$1\n" . $herecurr) &&
6425 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006426 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07006427 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
6428 }
6429
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006430 }
6431
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006432# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006433 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
6434 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006435 my $which = $1;
6436 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006437 CHK("UNCOMMENTED_DEFINITION",
6438 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006439 }
6440 }
6441# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006442
6443 my $barriers = qr{
6444 mb|
6445 rmb|
Will Deaconad83ec62019-11-07 14:49:00 +00006446 wmb
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006447 }x;
6448 my $barrier_stems = qr{
6449 mb__before_atomic|
6450 mb__after_atomic|
6451 store_release|
6452 load_acquire|
6453 store_mb|
6454 (?:$barriers)
6455 }x;
6456 my $all_barriers = qr{
6457 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02006458 smp_(?:$barrier_stems)|
6459 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006460 }x;
6461
6462 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006463 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08006464 WARN("MEMORY_BARRIER",
6465 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006466 }
6467 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006468
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02006469 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6470
6471 if ($realfile !~ m@^include/asm-generic/@ &&
6472 $realfile !~ m@/barrier\.h$@ &&
6473 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6474 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6475 WARN("MEMORY_BARRIER",
6476 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6477 }
6478
Joe Perchescb426e92015-06-25 15:02:46 -07006479# check for waitqueue_active without a comment.
6480 if ($line =~ /\bwaitqueue_active\s*\(/) {
6481 if (!ctx_has_comment($first_line, $linenr)) {
6482 WARN("WAITQUEUE_ACTIVE",
6483 "waitqueue_active without comment\n" . $herecurr);
6484 }
6485 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006486
Marco Elver5099a722020-04-01 12:17:14 +02006487# check for data_race without a comment.
6488 if ($line =~ /\bdata_race\s*\(/) {
6489 if (!ctx_has_comment($first_line, $linenr)) {
6490 WARN("DATA_RACE",
6491 "data_race without comment\n" . $herecurr);
6492 }
6493 }
6494
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006495# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006496 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006497 CHK("ARCH_DEFINES",
6498 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006499 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006500
Joe Perches596ed452017-07-12 14:37:02 -07006501# check that the storage class is not after a type
6502 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006503 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07006504 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6505 }
6506# Check that the storage class is at the beginning of a declaration
6507 if ($line =~ /\b$Storage\b/ &&
6508 $line !~ /^.\s*$Storage/ &&
6509 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6510 $1 !~ /[\,\)]\s*$/) {
6511 WARN("STORAGE_CLASS",
6512 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07006513 }
6514
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006515# check the location of the inline attribute, that it is between
6516# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006517 if ($line =~ /\b$Type\s+$Inline\b/ ||
6518 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006519 ERROR("INLINE_LOCATION",
6520 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006521 }
6522
Andy Whitcroft8905a672007-11-28 16:21:06 -08006523# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08006524 if ($realfile !~ m@\binclude/uapi/@ &&
6525 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006526 if (WARN("INLINE",
6527 "plain inline is preferred over $1\n" . $herecurr) &&
6528 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006529 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006530
6531 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006532 }
6533
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006534# Check for compiler attributes
Joe Perches2b7ab452013-11-12 15:10:14 -08006535 if ($realfile !~ m@\binclude/uapi/@ &&
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006536 $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
6537 my $attr = $1;
6538 $attr =~ s/\s*\(\s*(.*)\)\s*/$1/;
Joe Perches3d130fd2011-01-12 17:00:00 -08006539
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006540 my %attr_list = (
Joe Perches0830aab2020-12-15 20:44:50 -08006541 "alias" => "__alias",
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006542 "aligned" => "__aligned",
6543 "always_inline" => "__always_inline",
6544 "assume_aligned" => "__assume_aligned",
6545 "cold" => "__cold",
6546 "const" => "__attribute_const__",
6547 "copy" => "__copy",
6548 "designated_init" => "__designated_init",
6549 "externally_visible" => "__visible",
6550 "format" => "printf|scanf",
6551 "gnu_inline" => "__gnu_inline",
6552 "malloc" => "__malloc",
6553 "mode" => "__mode",
6554 "no_caller_saved_registers" => "__no_caller_saved_registers",
6555 "noclone" => "__noclone",
6556 "noinline" => "noinline",
6557 "nonstring" => "__nonstring",
6558 "noreturn" => "__noreturn",
6559 "packed" => "__packed",
6560 "pure" => "__pure",
Joe Perches339f29d2020-12-15 20:44:43 -08006561 "section" => "__section",
Joe Perches0830aab2020-12-15 20:44:50 -08006562 "used" => "__used",
6563 "weak" => "__weak"
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006564 );
Joe Perches39b7e282011-07-25 17:13:24 -07006565
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006566 while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
Joe Perches339f29d2020-12-15 20:44:43 -08006567 my $orig_attr = $1;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006568 my $params = '';
6569 $params = $2 if defined($2);
Joe Perches339f29d2020-12-15 20:44:43 -08006570 my $curr_attr = $orig_attr;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006571 $curr_attr =~ s/^[\s_]+|[\s_]+$//g;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006572 if (exists($attr_list{$curr_attr})) {
Joe Perches339f29d2020-12-15 20:44:43 -08006573 my $new = $attr_list{$curr_attr};
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006574 if ($curr_attr eq "format" && $params) {
6575 $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
Joe Perches339f29d2020-12-15 20:44:43 -08006576 $new = "__$1\($2";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006577 } else {
Joe Perches339f29d2020-12-15 20:44:43 -08006578 $new = "$new$params";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006579 }
Joe Perches339f29d2020-12-15 20:44:43 -08006580 if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6581 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
6582 $fix) {
6583 my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
6584 $fixed[$fixlinenr] =~ s/$remove//;
6585 $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
6586 $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
6587 $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
6588 }
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006589 }
6590 }
6591
6592 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6593 if ($attr =~ /^_*unused/) {
6594 WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6595 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
Joe Perchesd5e616f2013-09-11 14:23:54 -07006596 }
Joe Perches6061d942012-03-23 15:02:16 -07006597 }
6598
Joe Perches619a9082014-12-10 15:51:35 -08006599# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07006600 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08006601 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6602 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6603 $line =~ /\b__weak\b/)) {
6604 ERROR("WEAK_DECLARATION",
6605 "Using weak declarations can have unintended link defects\n" . $herecurr);
6606 }
6607
Tomas Winklerfd39f902016-12-12 16:46:34 -08006608# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07006609 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08006610 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07006611 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6612 my $type = $1;
6613 if ($type =~ /\b($typeC99Typedefs)\b/) {
6614 $type = $1;
6615 my $kernel_type = 'u';
6616 $kernel_type = 's' if ($type =~ /^_*[si]/);
6617 $type =~ /(\d+)/;
6618 $kernel_type .= $1;
6619 if (CHK("PREFER_KERNEL_TYPES",
6620 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6621 $fix) {
6622 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6623 }
6624 }
6625 }
6626
Joe Perches938224b2016-01-20 14:59:15 -08006627# check for cast of C90 native int or longer types constants
6628 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6629 my $cast = $1;
6630 my $const = $2;
Joe Perches0972b8b2021-02-25 17:21:54 -08006631 my $suffix = "";
6632 my $newconst = $const;
6633 $newconst =~ s/${Int_type}$//;
6634 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6635 if ($cast =~ /\blong\s+long\b/) {
6636 $suffix .= 'LL';
6637 } elsif ($cast =~ /\blong\b/) {
6638 $suffix .= 'L';
6639 }
Joe Perches938224b2016-01-20 14:59:15 -08006640 if (WARN("TYPECAST_INT_CONSTANT",
Joe Perches0972b8b2021-02-25 17:21:54 -08006641 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
Joe Perches938224b2016-01-20 14:59:15 -08006642 $fix) {
Joe Perches938224b2016-01-20 14:59:15 -08006643 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6644 }
6645 }
6646
Joe Perches8f53a9b2010-03-05 13:43:48 -08006647# check for sizeof(&)
6648 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006649 WARN("SIZEOF_ADDRESS",
6650 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006651 }
6652
Joe Perches66c80b62012-07-30 14:41:22 -07006653# check for sizeof without parenthesis
6654 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006655 if (WARN("SIZEOF_PARENTHESIS",
6656 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6657 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006658 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006659 }
Joe Perches66c80b62012-07-30 14:41:22 -07006660 }
6661
Joe Perches88982fe2012-12-17 16:02:00 -08006662# check for struct spinlock declarations
6663 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6664 WARN("USE_SPINLOCK_T",
6665 "struct spinlock should be spinlock_t\n" . $herecurr);
6666 }
6667
Joe Perchesa6962d72013-04-29 16:18:13 -07006668# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006669 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006670 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006671 $fmt =~ s/%%//g;
6672 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006673 if (WARN("PREFER_SEQ_PUTS",
6674 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6675 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006676 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006677 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006678 }
6679 }
6680
Joe Perches478b1792018-04-10 16:33:34 -07006681# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006682 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006683 defined $stat &&
6684 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6685 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006686 my $stat_real;
6687
Joe Perches0b523762017-05-08 15:55:36 -07006688 my $lc = $stat =~ tr@\n@@;
6689 $lc = $lc + $linenr;
6690 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006691 my $specifier;
6692 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006693 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006694 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006695 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6696 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006697
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006698 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006699 $specifier = $1;
6700 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006701 $qualifier = $3;
Sakari Ailusaf612e42021-02-16 17:57:20 +02006702 if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006703 ($extension eq "f" &&
Sakari Ailusaf612e42021-02-16 17:57:20 +02006704 defined $qualifier && $qualifier !~ /^w/) ||
6705 ($extension eq "4" &&
6706 defined $qualifier && $qualifier !~ /^cc/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006707 $bad_specifier = $specifier;
6708 last;
6709 }
6710 if ($extension eq "x" && !defined($stat_real)) {
6711 if (!defined($stat_real)) {
6712 $stat_real = get_stat_real($linenr, $lc);
6713 }
6714 WARN("VSPRINTF_SPECIFIER_PX",
6715 "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");
6716 }
6717 }
6718 if ($bad_specifier ne "") {
6719 my $stat_real = get_stat_real($linenr, $lc);
6720 my $ext_type = "Invalid";
6721 my $use = "";
6722 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006723 $use = " - use %pS instead";
6724 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6725 }
6726
6727 WARN("VSPRINTF_POINTER_EXTENSION",
6728 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6729 }
Joe Perches0b523762017-05-08 15:55:36 -07006730 }
6731 }
6732
Andy Whitcroft554e1652012-01-10 15:09:57 -08006733# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006734 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006735 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006736 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006737
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006738 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006739 my $ms_val = $7;
6740 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006741
Andy Whitcroft554e1652012-01-10 15:09:57 -08006742 if ($ms_size =~ /^(0x|)0$/i) {
6743 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006744 "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 -08006745 } elsif ($ms_size =~ /^(0x|)1$/i) {
6746 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006747 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6748 }
6749 }
6750
Joe Perches98a9bba2014-01-23 15:54:52 -08006751# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006752# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006753# defined $stat &&
6754# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6755# if (WARN("PREFER_ETHER_ADDR_COPY",
6756# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6757# $fix) {
6758# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6759# }
6760# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006761
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006762# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006763# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006764# defined $stat &&
6765# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6766# WARN("PREFER_ETHER_ADDR_EQUAL",
6767# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6768# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006769
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006770# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6771# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006772# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006773# defined $stat &&
6774# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6775#
6776# my $ms_val = $7;
6777#
6778# if ($ms_val =~ /^(?:0x|)0+$/i) {
6779# if (WARN("PREFER_ETH_ZERO_ADDR",
6780# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6781# $fix) {
6782# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6783# }
6784# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6785# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6786# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6787# $fix) {
6788# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6789# }
6790# }
6791# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006792
Joe Perches5dbdb2d2020-12-29 15:14:31 -08006793# strlcpy uses that should likely be strscpy
6794 if ($line =~ /\bstrlcpy\s*\(/) {
6795 WARN("STRLCPY",
6796 "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr);
6797 }
6798
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006799# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006800 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006801 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006802 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006803 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006804 my $call = $1;
6805 my $cast1 = deparenthesize($2);
6806 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006807 my $cast2 = deparenthesize($7);
6808 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006809 my $cast;
6810
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006811 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006812 $cast = "$cast1 or $cast2";
6813 } elsif ($cast1 ne "") {
6814 $cast = $cast1;
6815 } else {
6816 $cast = $cast2;
6817 }
6818 WARN("MINMAX",
6819 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006820 }
6821 }
6822
Joe Perches4a273192012-07-30 14:41:20 -07006823# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006824 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006825 defined $stat &&
6826 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6827 my $min = $1;
6828 my $max = $7;
6829 if ($min eq $max) {
6830 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006831 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
Joe Perches4a273192012-07-30 14:41:20 -07006832 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6833 $min > $max) {
6834 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006835 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
Joe Perches4a273192012-07-30 14:41:20 -07006836 }
6837 }
6838
Joe Perches823b7942013-11-12 15:10:15 -08006839# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006840 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006841 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006842 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006843 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6844 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6845 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6846 my $lc = $stat =~ tr@\n@@;
6847 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006848 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006849 WARN("NAKED_SSCANF",
6850 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6851 }
6852
Joe Perchesafc819a2014-06-04 16:12:08 -07006853# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006854 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006855 defined $stat &&
6856 $line =~ /\bsscanf\b/) {
6857 my $lc = $stat =~ tr@\n@@;
6858 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006859 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006860 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6861 my $format = $6;
6862 my $count = $format =~ tr@%@%@;
6863 if ($count == 1 &&
6864 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6865 WARN("SSCANF_TO_KSTRTO",
6866 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6867 }
6868 }
6869 }
6870
Joe Perches70dc8a42013-09-11 14:23:58 -07006871# check for new externs in .h files.
6872 if ($realfile =~ /\.h$/ &&
6873 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006874 if (CHK("AVOID_EXTERNS",
6875 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006876 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006877 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006878 }
6879 }
6880
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006881# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006882 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006883 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006884 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006885 my $function_name = $1;
6886 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006887
6888 my $s = $stat;
6889 if (defined $cond) {
6890 substr($s, 0, length($cond), '');
6891 }
Kees Cookd8b44b52020-06-03 14:18:09 -07006892 if ($s =~ /^\s*;/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006893 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006894 WARN("AVOID_EXTERNS",
6895 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006896 }
6897
6898 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006899 WARN("FUNCTION_ARGUMENTS",
6900 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006901 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006902
6903 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6904 $stat =~ /^.\s*extern\s+/)
6905 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006906 WARN("AVOID_EXTERNS",
6907 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006908 }
6909
Joe Perchesa0ad7592017-07-10 15:52:19 -07006910# check for function declarations that have arguments without identifier names
6911 if (defined $stat &&
Kees Cookd8b44b52020-06-03 14:18:09 -07006912 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6913 $1 ne "void") {
6914 my $args = trim($1);
Joe Perchesca0d8922016-10-11 13:52:16 -07006915 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6916 my $arg = trim($1);
Kees Cookd8b44b52020-06-03 14:18:09 -07006917 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07006918 WARN("FUNCTION_ARGUMENTS",
6919 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6920 }
6921 }
6922 }
6923
Joe Perchesa0ad7592017-07-10 15:52:19 -07006924# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006925 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006926 defined $stat &&
6927 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6928 $context_function = $1;
6929
6930# check for multiline function definition with misplaced open brace
6931 my $ok = 0;
6932 my $cnt = statement_rawlines($stat);
6933 my $herectx = $here . "\n";
6934 for (my $n = 0; $n < $cnt; $n++) {
6935 my $rl = raw_line($linenr, $n);
6936 $herectx .= $rl . "\n";
6937 $ok = 1 if ($rl =~ /^[ \+]\{/);
6938 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6939 last if $rl =~ /^[ \+].*\{/;
6940 }
6941 if (!$ok) {
6942 ERROR("OPEN_BRACE",
6943 "open brace '{' following function definitions go on the next line\n" . $herectx);
6944 }
6945 }
6946
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006947# checks for new __setup's
6948 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6949 my $name = $1;
6950
6951 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006952 CHK("UNDOCUMENTED_SETUP",
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07006953 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006954 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006955 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006956
Joe Perchese29a70f2019-03-07 16:28:35 -08006957# check for pointless casting of alloc functions
6958 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006959 WARN("UNNECESSARY_CASTS",
6960 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006961 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006962
Joe Perchesa640d252013-07-03 15:05:21 -07006963# alloc style
6964# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006965 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006966 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
Joe Perchesa640d252013-07-03 15:05:21 -07006967 CHK("ALLOC_SIZEOF_STRUCT",
6968 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6969 }
6970
Joe Perches60a55362014-06-04 16:12:07 -07006971# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006972 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006973 defined $stat &&
6974 $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 -07006975 my $oldfunc = $3;
6976 my $a1 = $4;
6977 my $a2 = $10;
6978 my $newfunc = "kmalloc_array";
6979 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006980 my $r1 = $a1;
6981 my $r2 = $a2;
6982 if ($a1 =~ /^sizeof\s*\S/) {
6983 $r1 = $a2;
6984 $r2 = $a1;
6985 }
6986 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6987 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006988 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006989 my $herectx = get_stat_here($linenr, $cnt, $here);
6990
Joe Perches60a55362014-06-04 16:12:07 -07006991 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006992 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6993 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006994 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006995 $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 -07006996 }
6997 }
6998 }
6999
Joe Perches972fdea2013-04-29 16:18:12 -07007000# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07007001 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07007002 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
7003 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07007004 WARN("KREALLOC_ARG_REUSE",
7005 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
7006 }
7007
Joe Perches5ce59ae2013-02-21 16:44:18 -08007008# check for alloc argument mismatch
Christophe JAILLET7e6cdd72021-05-06 18:04:01 -07007009 if ($line =~ /\b((?:devm_)?(?:kcalloc|kmalloc_array))\s*\(\s*sizeof\b/) {
Joe Perches5ce59ae2013-02-21 16:44:18 -08007010 WARN("ALLOC_ARRAY_ARGS",
7011 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
7012 }
7013
Joe Perchescaf2a542011-01-12 16:59:56 -08007014# check for multiple semicolons
7015 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07007016 if (WARN("ONE_SEMICOLON",
7017 "Statements terminations use 1 semicolon\n" . $herecurr) &&
7018 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07007019 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07007020 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08007021 }
7022
Tomas Winklercec3aaa2016-08-02 14:04:39 -07007023# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
7024 if ($realfile !~ m@^include/uapi/@ &&
7025 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08007026 my $ull = "";
7027 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
7028 if (CHK("BIT_MACRO",
7029 "Prefer using the BIT$ull macro\n" . $herecurr) &&
7030 $fix) {
7031 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
7032 }
7033 }
7034
Joe Perches50161262020-08-11 18:35:07 -07007035# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007036 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
Joe Perches50161262020-08-11 18:35:07 -07007037 WARN("IS_ENABLED_CONFIG",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007038 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
Joe Perches50161262020-08-11 18:35:07 -07007039 }
7040
Joe Perches2d632742016-05-20 17:04:00 -07007041# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007042 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
Joe Perches2d632742016-05-20 17:04:00 -07007043 my $config = $1;
7044 if (WARN("PREFER_IS_ENABLED",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007045 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
Joe Perches2d632742016-05-20 17:04:00 -07007046 $fix) {
7047 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
7048 }
7049 }
7050
Joe Perchesf36d3eb2020-04-06 20:10:58 -07007051# check for /* fallthrough */ like comment, prefer fallthrough;
7052 my @fallthroughs = (
7053 'fallthrough',
7054 '@fallthrough@',
7055 'lint -fallthrough[ \t]*',
7056 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
7057 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
7058 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7059 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7060 );
7061 if ($raw_comment ne '') {
7062 foreach my $ft (@fallthroughs) {
7063 if ($raw_comment =~ /$ft/) {
7064 my $msg_level = \&WARN;
7065 $msg_level = \&CHK if ($file);
7066 &{$msg_level}("PREFER_FALLTHROUGH",
7067 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
7068 last;
7069 }
7070 }
7071 }
7072
Joe Perchesd1e2ad02012-12-17 16:02:01 -08007073# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07007074 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08007075 defined $stat &&
7076 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08007077 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07007078 my $herectx = get_stat_here($linenr, $cnt, $here);
7079
Joe Perchesd1e2ad02012-12-17 16:02:01 -08007080 WARN("DEFAULT_NO_BREAK",
7081 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08007082 }
7083
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007084# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07007085 if ($line =~ /\b__FUNCTION__\b/) {
7086 if (WARN("USE_FUNC",
7087 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
7088 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07007089 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07007090 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007091 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07007092
Joe Perches62ec8182015-02-13 14:38:18 -08007093# check for uses of __DATE__, __TIME__, __TIMESTAMP__
7094 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
7095 ERROR("DATE_TIME",
7096 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
7097 }
7098
Joe Perches2c924882012-03-23 15:02:20 -07007099# check for use of yield()
7100 if ($line =~ /\byield\s*\(\s*\)/) {
7101 WARN("YIELD",
7102 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
7103 }
7104
Joe Perches179f8f42013-07-03 15:05:30 -07007105# check for comparisons against true and false
7106 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
7107 my $lead = $1;
7108 my $arg = $2;
7109 my $test = $3;
7110 my $otype = $4;
7111 my $trail = $5;
7112 my $op = "!";
7113
7114 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
7115
7116 my $type = lc($otype);
7117 if ($type =~ /^(?:true|false)$/) {
7118 if (("$test" eq "==" && "$type" eq "true") ||
7119 ("$test" eq "!=" && "$type" eq "false")) {
7120 $op = "";
7121 }
7122
7123 CHK("BOOL_COMPARISON",
7124 "Using comparison to $otype is error prone\n" . $herecurr);
7125
7126## maybe suggesting a correct construct would better
7127## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
7128
7129 }
7130 }
7131
Thomas Gleixner4882720b2010-09-07 14:34:01 +00007132# check for semaphores initialized locked
7133 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007134 WARN("CONSIDER_COMPLETION",
7135 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07007136 }
Joe Perches6712d852012-03-23 15:02:20 -07007137
Joe Perches67d0a072011-10-31 17:13:10 -07007138# recommend kstrto* over simple_strto* and strict_strto*
7139 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007140 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07007141 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07007142 }
Joe Perches6712d852012-03-23 15:02:20 -07007143
Fabian Frederickae3ccc42014-06-04 16:12:10 -07007144# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07007145 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007146 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07007147 "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 -07007148 }
Joe Perches6712d852012-03-23 15:02:20 -07007149
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08007150# check for spin_is_locked(), suggest lockdep instead
7151 if ($line =~ /\bspin_is_locked\(/) {
7152 WARN("USE_LOCKDEP",
7153 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
7154 }
7155
Joe Perches9189c7e2018-09-07 15:26:18 -07007156# check for deprecated apis
7157 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
7158 my $deprecated_api = $1;
7159 my $new_api = $deprecated_apis{$deprecated_api};
7160 WARN("DEPRECATED_API",
7161 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
7162 }
7163
Joe Perches0f3c5aa2015-02-13 14:39:05 -08007164# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07007165# and avoid what seem like struct definitions 'struct foo {'
Quentin Monnetced69da12020-08-11 18:35:13 -07007166 if (defined($const_structs) &&
7167 $line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07007168 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007169 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07007170 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08007171 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07007172
7173# use of NR_CPUS is usually wrong
7174# ignore definitions of NR_CPUS and usage to define arrays as likely right
Peng Wang35cdcbf2021-02-25 17:21:44 -08007175# ignore designated initializers using NR_CPUS
Andy Whitcroft773647a2008-03-28 14:15:58 -07007176 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07007177 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
7178 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007179 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
7180 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
Peng Wang35cdcbf2021-02-25 17:21:44 -08007181 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ &&
7182 $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07007183 {
Joe Perches000d1cc12011-07-25 17:13:25 -07007184 WARN("NR_CPUS",
7185 "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 -07007186 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07007187
Joe Perches52ea8502013-11-12 15:10:09 -08007188# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7189 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
7190 ERROR("DEFINE_ARCH_HAS",
7191 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
7192 }
7193
Joe Perchesacd93622015-02-13 14:38:38 -08007194# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07007195 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08007196 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
7197 WARN("LIKELY_MISUSE",
7198 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
7199 }
7200
Joe Perchesfbe74542021-05-06 18:03:55 -07007201# return sysfs_emit(foo, fmt, ...) fmt without newline
7202 if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ &&
7203 substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) {
7204 my $offset = $+[6] - 1;
7205 if (WARN("SYSFS_EMIT",
7206 "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) &&
7207 $fix) {
7208 substr($fixed[$fixlinenr], $offset, 0) = '\\n';
7209 }
7210 }
7211
Denis Efremovde3f1862019-09-25 16:49:25 -07007212# nested likely/unlikely calls
7213 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
7214 WARN("LIKELY_MISUSE",
7215 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
7216 }
7217
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007218# whine mightly about in_atomic
7219 if ($line =~ /\bin_atomic\s*\(/) {
7220 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007221 ERROR("IN_ATOMIC",
7222 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08007223 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007224 WARN("IN_ATOMIC",
7225 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007226 }
7227 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01007228
7229# check for lockdep_set_novalidate_class
7230 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
7231 $line =~ /__lockdep_no_validate__\s*\)/ ) {
7232 if ($realfile !~ m@^kernel/lockdep@ &&
7233 $realfile !~ m@^include/linux/lockdep@ &&
7234 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007235 ERROR("LOCKDEP",
7236 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01007237 }
7238 }
Dave Jones88f88312011-01-12 16:59:59 -08007239
Joe Perchesb392c642015-04-16 12:44:16 -07007240 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
7241 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007242 WARN("EXPORTED_WORLD_WRITABLE",
7243 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08007244 }
Joe Perches24358802014-04-03 14:49:13 -07007245
Joe Perches00180462018-02-06 15:38:55 -08007246# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7247# and whether or not function naming is typical and if
7248# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07007249 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08007250 defined $stat &&
7251 $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*\)/) {
7252 my $var = $1;
7253 my $perms = $2;
7254 my $show = $3;
7255 my $store = $4;
7256 my $octal_perms = perms_to_octal($perms);
7257 if ($show =~ /^${var}_show$/ &&
7258 $store =~ /^${var}_store$/ &&
7259 $octal_perms eq "0644") {
7260 if (WARN("DEVICE_ATTR_RW",
7261 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
7262 $fix) {
7263 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7264 }
7265 } elsif ($show =~ /^${var}_show$/ &&
7266 $store =~ /^NULL$/ &&
7267 $octal_perms eq "0444") {
7268 if (WARN("DEVICE_ATTR_RO",
7269 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
7270 $fix) {
7271 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7272 }
7273 } elsif ($show =~ /^NULL$/ &&
7274 $store =~ /^${var}_store$/ &&
7275 $octal_perms eq "0200") {
7276 if (WARN("DEVICE_ATTR_WO",
7277 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
7278 $fix) {
7279 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7280 }
7281 } elsif ($octal_perms eq "0644" ||
7282 $octal_perms eq "0444" ||
7283 $octal_perms eq "0200") {
7284 my $newshow = "$show";
7285 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
7286 my $newstore = $store;
7287 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
7288 my $rename = "";
7289 if ($show ne $newshow) {
7290 $rename .= " '$show' to '$newshow'";
7291 }
7292 if ($store ne $newstore) {
7293 $rename .= " '$store' to '$newstore'";
7294 }
7295 WARN("DEVICE_ATTR_FUNCTIONS",
7296 "Consider renaming function(s)$rename\n" . $herecurr);
7297 } else {
7298 WARN("DEVICE_ATTR_PERMS",
7299 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
7300 }
7301 }
7302
Joe Perches515a2352014-04-03 14:49:24 -07007303# Mode permission misuses where it seems decimal should be octal
7304# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08007305# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7306# specific definition of not visible in sysfs.
7307# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7308# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07007309 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07007310 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07007311 $line =~ /$mode_perms_search/) {
7312 foreach my $entry (@mode_permission_funcs) {
7313 my $func = $entry->[0];
7314 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07007315
Joe Perches459cf0a2016-10-11 13:52:19 -07007316 my $lc = $stat =~ tr@\n@@;
7317 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07007318 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07007319
Joe Perches515a2352014-04-03 14:49:24 -07007320 my $skip_args = "";
7321 if ($arg_pos > 1) {
7322 $arg_pos--;
7323 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
7324 }
Joe Perchesf90774e2016-10-11 13:51:47 -07007325 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07007326 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07007327 my $val = $1;
7328 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08007329 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
7330 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
7331 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07007332 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07007333 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007334 }
7335 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08007336 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07007337 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007338 }
Joe Perches24358802014-04-03 14:49:13 -07007339 }
7340 }
7341 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007342
Joe Perches459cf0a2016-10-11 13:52:19 -07007343# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07007344 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08007345 my $oval = $1;
7346 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07007347 if (WARN("SYMBOLIC_PERMS",
7348 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7349 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08007350 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07007351 }
7352 }
7353
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007354# validate content of MODULE_LICENSE against list from include/linux/module.h
7355 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
7356 my $extracted_string = get_quoted_string($line, $rawline);
7357 my $valid_licenses = qr{
7358 GPL|
7359 GPL\ v2|
7360 GPL\ and\ additional\ rights|
7361 Dual\ BSD/GPL|
7362 Dual\ MIT/GPL|
7363 Dual\ MPL/GPL|
7364 Proprietary
7365 }x;
7366 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
7367 WARN("MODULE_LICENSE",
7368 "unknown module license " . $extracted_string . "\n" . $herecurr);
7369 }
7370 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07007371
7372# check for sysctl duplicate constants
7373 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
7374 WARN("DUPLICATED_SYSCTL_CONST",
7375 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7376 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007377 }
7378
7379 # If we have no input at all, then there is nothing to report on
7380 # so just keep quiet.
7381 if ($#rawlines == -1) {
7382 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007383 }
7384
Andy Whitcroft8905a672007-11-28 16:21:06 -08007385 # In mailback mode only produce a report in the negative, for
7386 # things that appear to be patches.
7387 if ($mailback && ($clean == 1 || !$is_patch)) {
7388 exit(0);
7389 }
7390
Dwaipayan Raye73d2712020-12-15 20:44:56 -08007391 # This is not a patch, and we are in 'no-patch' mode so
Andy Whitcroft8905a672007-11-28 16:21:06 -08007392 # just keep quiet.
7393 if (!$chk_patch && !$is_patch) {
7394 exit(0);
7395 }
7396
Stafford Hornea08ffbe2017-10-03 16:16:51 -07007397 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007398 ERROR("NOT_UNIFIED_DIFF",
7399 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007400 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007401 if ($is_patch && $has_commit_log && $chk_signoff) {
7402 if ($signoff == 0) {
7403 ERROR("MISSING_SIGN_OFF",
7404 "Missing Signed-off-by: line(s)\n");
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07007405 } elsif ($authorsignoff != 1) {
7406 # authorsignoff values:
7407 # 0 -> missing sign off
7408 # 1 -> sign off identical
7409 # 2 -> names and addresses match, comments mismatch
7410 # 3 -> addresses match, names different
7411 # 4 -> names match, addresses different
7412 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7413
7414 my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";
7415
7416 if ($authorsignoff == 0) {
7417 ERROR("NO_AUTHOR_SIGN_OFF",
7418 "Missing Signed-off-by: line by nominal patch author '$author'\n");
7419 } elsif ($authorsignoff == 2) {
7420 CHK("FROM_SIGN_OFF_MISMATCH",
7421 "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
7422 } elsif ($authorsignoff == 3) {
7423 WARN("FROM_SIGN_OFF_MISMATCH",
7424 "From:/Signed-off-by: email name mismatch: $sob_msg\n");
7425 } elsif ($authorsignoff == 4) {
7426 WARN("FROM_SIGN_OFF_MISMATCH",
7427 "From:/Signed-off-by: email address mismatch: $sob_msg\n");
7428 } elsif ($authorsignoff == 5) {
7429 WARN("FROM_SIGN_OFF_MISMATCH",
7430 "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
7431 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007432 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007433 }
7434
Andy Whitcroft8905a672007-11-28 16:21:06 -08007435 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007436 if ($summary && !($clean == 1 && $quiet == 1)) {
7437 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08007438 print "total: $cnt_error errors, $cnt_warn warnings, " .
7439 (($check)? "$cnt_chk checks, " : "") .
7440 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07007441 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08007442
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007443 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07007444 # If there were any defects found and not already fixing them
7445 if (!$clean and !$fix) {
7446 print << "EOM"
7447
7448NOTE: For some of the reported defects, checkpatch may be able to
7449 mechanically convert to the typical style using --fix or --fix-inplace.
7450EOM
7451 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007452 # If there were whitespace errors which cleanpatch can fix
7453 # then suggest that.
7454 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07007455 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07007456 print << "EOM"
7457
7458NOTE: Whitespace errors detected.
7459 You may wish to use scripts/cleanpatch or scripts/cleanfile
7460EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007461 }
7462 }
7463
Joe Perchesd752fcc2014-08-06 16:11:05 -07007464 if ($clean == 0 && $fix &&
7465 ("@rawlines" ne "@fixed" ||
7466 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08007467 my $newfile = $filename;
7468 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07007469 my $linecount = 0;
7470 my $f;
7471
Joe Perchesd752fcc2014-08-06 16:11:05 -07007472 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
7473
Joe Perches3705ce52013-07-03 15:05:31 -07007474 open($f, '>', $newfile)
7475 or die "$P: Can't open $newfile for write\n";
7476 foreach my $fixed_line (@fixed) {
7477 $linecount++;
7478 if ($file) {
7479 if ($linecount > 3) {
7480 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07007481 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07007482 }
7483 } else {
7484 print $f $fixed_line . "\n";
7485 }
7486 }
7487 close($f);
7488
7489 if (!$quiet) {
7490 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07007491
Joe Perches3705ce52013-07-03 15:05:31 -07007492Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
7493
7494Do _NOT_ trust the results written to this file.
7495Do _NOT_ submit these changes without inspecting them for correctness.
7496
7497This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7498No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07007499EOM
7500 }
7501 }
7502
Joe Perchesd8469f12015-06-25 15:03:00 -07007503 if ($quiet == 0) {
7504 print "\n";
7505 if ($clean == 1) {
7506 print "$vname has no obvious style problems and is ready for submission.\n";
7507 } else {
7508 print "$vname has style problems, please review.\n";
7509 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007510 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007511 return $clean;
7512}