blob: 78cc595b98ce1c93d3c9f4f0ab105de1371972a6 [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";
Peter Ujfalusi0ee3e7b2021-11-08 18:33:34 -080066my $user_codespellfile = "";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070067my $conststructsfile = "$D/const_structs.checkpatch";
Dwaipayan Ray52178ce2021-02-26 15:08:26 +053068my $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst";
Quentin Monnetced69da12020-08-11 18:35:13 -070069my $typedefsfile;
John Brooks737c0762017-07-10 15:52:24 -070070my $color = "auto";
Vadim Bendebury98005e82019-03-07 16:28:38 -080071my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
Joe Perchesdbbf8692019-09-25 16:46:52 -070072# git output parsing needs US English output, so first set backtick child process LANGUAGE
73my $git_command ='export LANGUAGE=en_US.UTF-8; git';
Antonio Borneo713a09d2020-04-06 20:11:07 -070074my $tabsize = 8;
Jerome Forissier3e89ad82020-10-15 20:11:49 -070075my ${CONFIG_} = "CONFIG_";
Hannes Eder77f5b102009-09-21 17:04:37 -070076
77sub help {
78 my ($exitcode) = @_;
79
80 print << "EOM";
81Usage: $P [OPTION]... [FILE]...
82Version: $V
83
84Options:
85 -q, --quiet quiet
Dwaipayan Ray52178ce2021-02-26 15:08:26 +053086 -v, --verbose verbose mode
Hannes Eder77f5b102009-09-21 17:04:37 -070087 --no-tree run without a kernel tree
88 --no-signoff do not check for 'Signed-off-by' line
89 --patch treat FILE as patchfile (default)
90 --emacs emacs compile window format
91 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070092 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070093 -g, --git treat FILE as a single commit or git revision range
94 single git commit with:
95 <rev>
96 <rev>^
97 <rev>~n
98 multiple git commits with:
99 <rev1>..<rev2>
100 <rev1>...<rev2>
101 <rev>-<count>
102 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -0700103 -f, --file treat FILE as regular source file
104 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -0700105 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -0700106 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -0700107 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -0700108 --show-types show the specific message type in the output
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700109 --max-line-length=n set the maximum line length, (default $max_line_length)
110 if exceeded, warn on patches
111 requires --strict for use with --file
Vadim Bendebury56193272014-10-13 15:51:48 -0700112 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700113 --tab-size=n set the number of spaces for tab (default $tabsize)
Hannes Eder77f5b102009-09-21 17:04:37 -0700114 --root=PATH PATH to the kernel tree root
115 --no-summary suppress the per-file summary
116 --mailback only produce a report in case of warnings/errors
117 --summary-file include the filename in summary
118 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
119 'values', 'possible', 'type', and 'attr' (default
120 is all off)
121 --test-only=WORD report only warnings/errors containing WORD
122 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700123 --fix EXPERIMENTAL - may create horrible results
124 If correctable single-line errors exist, create
125 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
126 with potential errors corrected to the preferred
127 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800128 --fix-inplace EXPERIMENTAL - may create horrible results
129 Is the same as --fix, but overwrites the input
130 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700131 --ignore-perl-version override checking of perl version. expect
132 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700133 --codespell Use the codespell dictionary for spelling/typos
Peter Ujfalusi0ee3e7b2021-11-08 18:33:34 -0800134 (default:$codespellfile)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700135 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700136 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700137 --color[=WHEN] Use colors 'always', 'never', or only when output
138 is a terminal ('auto'). Default is 'auto'.
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700139 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default
140 ${CONFIG_})
Hannes Eder77f5b102009-09-21 17:04:37 -0700141 -h, --help, --version display this help and exit
142
143When FILE is - read standard input.
144EOM
145
146 exit($exitcode);
147}
148
Joe Perches3beb42e2016-05-20 17:04:14 -0700149sub uniq {
150 my %seen;
151 return grep { !$seen{$_}++ } @_;
152}
153
154sub list_types {
155 my ($exitcode) = @_;
156
157 my $count = 0;
158
159 local $/ = undef;
160
161 open(my $script, '<', abs_path($P)) or
162 die "$P: Can't read '$P' $!\n";
163
164 my $text = <$script>;
165 close($script);
166
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530167 my %types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700168 # Also catch when type or level is passed through a variable
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530169 while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
170 if (defined($1)) {
171 if (exists($types{$2})) {
172 $types{$2} .= ",$1" if ($types{$2} ne $1);
173 } else {
174 $types{$2} = $1;
175 }
176 } else {
177 $types{$2} = "UNDETERMINED";
178 }
Joe Perches3beb42e2016-05-20 17:04:14 -0700179 }
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530180
Joe Perches3beb42e2016-05-20 17:04:14 -0700181 print("#\tMessage type\n\n");
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530182 if ($color) {
183 print(" ( Color coding: ");
184 print(RED . "ERROR" . RESET);
185 print(" | ");
186 print(YELLOW . "WARNING" . RESET);
187 print(" | ");
188 print(GREEN . "CHECK" . RESET);
189 print(" | ");
190 print("Multiple levels / Undetermined");
191 print(" )\n\n");
192 }
193
194 foreach my $type (sort keys %types) {
195 my $orig_type = $type;
196 if ($color) {
197 my $level = $types{$type};
198 if ($level eq "ERROR") {
199 $type = RED . $type . RESET;
200 } elsif ($level eq "WARN") {
201 $type = YELLOW . $type . RESET;
202 } elsif ($level eq "CHK") {
203 $type = GREEN . $type . RESET;
204 }
205 }
Joe Perches3beb42e2016-05-20 17:04:14 -0700206 print(++$count . "\t" . $type . "\n");
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530207 if ($verbose && exists($verbose_messages{$orig_type})) {
208 my $message = $verbose_messages{$orig_type};
209 $message =~ s/\n/\n\t/g;
210 print("\t" . $message . "\n\n");
211 }
Joe Perches3beb42e2016-05-20 17:04:14 -0700212 }
213
214 exit($exitcode);
215}
216
Joe Perches000d1cc12011-07-25 17:13:25 -0700217my $conf = which_conf($configuration_file);
218if (-f $conf) {
219 my @conf_args;
220 open(my $conffile, '<', "$conf")
221 or warn "$P: Can't find a readable $configuration_file file $!\n";
222
223 while (<$conffile>) {
224 my $line = $_;
225
226 $line =~ s/\s*\n?$//g;
227 $line =~ s/^\s*//g;
228 $line =~ s/\s+/ /g;
229
230 next if ($line =~ m/^\s*#/);
231 next if ($line =~ m/^\s*$/);
232
233 my @words = split(" ", $line);
234 foreach my $word (@words) {
235 last if ($word =~ m/^#/);
236 push (@conf_args, $word);
237 }
238 }
239 close($conffile);
240 unshift(@ARGV, @conf_args) if @conf_args;
241}
242
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530243sub load_docs {
244 open(my $docs, '<', "$docsfile")
245 or warn "$P: Can't read the documentation file $docsfile $!\n";
246
247 my $type = '';
248 my $desc = '';
249 my $in_desc = 0;
250
251 while (<$docs>) {
252 chomp;
253 my $line = $_;
254 $line =~ s/\s+$//;
255
256 if ($line =~ /^\s*\*\*(.+)\*\*$/) {
257 if ($desc ne '') {
258 $verbose_messages{$type} = trim($desc);
259 }
260 $type = $1;
261 $desc = '';
262 $in_desc = 1;
263 } elsif ($in_desc) {
264 if ($line =~ /^(?:\s{4,}|$)/) {
265 $line =~ s/^\s{4}//;
266 $desc .= $line;
267 $desc .= "\n";
268 } else {
269 $verbose_messages{$type} = trim($desc);
270 $type = '';
271 $desc = '';
272 $in_desc = 0;
273 }
274 }
275 }
276
277 if ($desc ne '') {
278 $verbose_messages{$type} = trim($desc);
279 }
280 close($docs);
281}
282
John Brooks737c0762017-07-10 15:52:24 -0700283# Perl's Getopt::Long allows options to take optional arguments after a space.
284# Prevent --color by itself from consuming other arguments
285foreach (@ARGV) {
286 if ($_ eq "--color" || $_ eq "-color") {
287 $_ = "--color=$color";
288 }
289}
290
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700291GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700292 'q|quiet+' => \$quiet,
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530293 'v|verbose!' => \$verbose,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700294 'tree!' => \$tree,
295 'signoff!' => \$chk_signoff,
296 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700297 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800298 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700299 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700300 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700301 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700302 'subjective!' => \$check,
303 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700304 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700305 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700306 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700307 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800308 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700309 'min-conf-desc-length=i' => \$min_conf_desc_length,
Antonio Borneo713a09d2020-04-06 20:11:07 -0700310 'tab-size=i' => \$tabsize,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700311 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800312 'summary!' => \$summary,
313 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800314 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700315 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800316 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700317 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800318 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700319 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700320 'codespell!' => \$codespell,
Peter Ujfalusi0ee3e7b2021-11-08 18:33:34 -0800321 'codespellfile=s' => \$user_codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700322 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700323 'color=s' => \$color,
324 'no-color' => \$color, #keep old behaviors of -nocolor
325 'nocolor' => \$color, #keep old behaviors of -nocolor
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700326 'kconfig-prefix=s' => \${CONFIG_},
Hannes Eder77f5b102009-09-21 17:04:37 -0700327 'h|help' => \$help,
328 'version' => \$help
Peter Ujfalusi0ee3e7b2021-11-08 18:33:34 -0800329) or $help = 2;
Hannes Eder77f5b102009-09-21 17:04:37 -0700330
Peter Ujfalusi0ee3e7b2021-11-08 18:33:34 -0800331if ($user_codespellfile) {
332 # Use the user provided codespell file unconditionally
333 $codespellfile = $user_codespellfile;
334} elsif (!(-f $codespellfile)) {
335 # If /usr/share/codespell/dictionary.txt is not present, try to find it
336 # under codespell's install directory: <codespell_root>/data/dictionary.txt
Sagar Patelc882c6b2022-03-23 16:06:05 -0700337 if (($codespell || $help) && which("python3") ne "") {
Peter Ujfalusi0ee3e7b2021-11-08 18:33:34 -0800338 my $python_codespell_dict = << "EOF";
339
340import os.path as op
341import codespell_lib
342codespell_dir = op.dirname(codespell_lib.__file__)
343codespell_file = op.join(codespell_dir, 'data', 'dictionary.txt')
344print(codespell_file, end='')
345EOF
346
Sagar Patelc882c6b2022-03-23 16:06:05 -0700347 my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`;
Peter Ujfalusi0ee3e7b2021-11-08 18:33:34 -0800348 $codespellfile = $codespell_dict if (-f $codespell_dict);
349 }
350}
351
352# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0
353# $help is 2 if invalid option is passed - exitcode: 1
354help($help - 1) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700355
Dwaipayan Ray52178ce2021-02-26 15:08:26 +0530356die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
357die "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse);
358
359if ($color =~ /^[01]$/) {
360 $color = !$color;
361} elsif ($color =~ /^always$/i) {
362 $color = 1;
363} elsif ($color =~ /^never$/i) {
364 $color = 0;
365} elsif ($color =~ /^auto$/i) {
366 $color = (-t STDOUT);
367} else {
368 die "$P: Invalid color mode: $color\n";
369}
370
371load_docs() if ($verbose);
Joe Perches3beb42e2016-05-20 17:04:14 -0700372list_types(0) if ($list_types);
373
Joe Perches9624b8d2014-01-23 15:54:44 -0800374$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700375$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800376
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700377my $exit = 0;
378
Joe Perches5b579802018-08-21 21:57:33 -0700379my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700380if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700381 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700382 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700383 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700384}
385
Allen Hubbe45107ff2016-08-02 14:04:47 -0700386#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700387if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700388 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700389}
390
Antonio Borneo713a09d2020-04-06 20:11:07 -0700391# skip TAB size 1 to avoid additional checks on $tabsize - 1
Joe Perches32f30ca2020-06-04 16:50:40 -0700392die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
Antonio Borneo713a09d2020-04-06 20:11:07 -0700393
Joe Perches91bfe482013-09-11 14:23:59 -0700394sub hash_save_array_words {
395 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700396
Joe Perches91bfe482013-09-11 14:23:59 -0700397 my @array = split(/,/, join(',', @$arrayRef));
398 foreach my $word (@array) {
399 $word =~ s/\s*\n?$//g;
400 $word =~ s/^\s*//g;
401 $word =~ s/\s+/ /g;
402 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700403
Joe Perches91bfe482013-09-11 14:23:59 -0700404 next if ($word =~ m/^\s*#/);
405 next if ($word =~ m/^\s*$/);
406
407 $hashRef->{$word}++;
408 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700409}
410
Joe Perches91bfe482013-09-11 14:23:59 -0700411sub hash_show_words {
412 my ($hashRef, $prefix) = @_;
413
Joe Perches3c816e42015-06-25 15:03:29 -0700414 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700415 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700416 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700417 print " $word";
418 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700419 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700420 }
421}
422
423hash_save_array_words(\%ignore_type, \@ignore);
424hash_save_array_words(\%use_type, \@use);
425
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800426my $dbg_values = 0;
427my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700428my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700429my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800430for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800431 ## no critic
432 eval "\${dbg_$key} = '$debug{$key}';";
433 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800434}
435
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700436my $rpt_cleaners = 0;
437
Andy Whitcroft8905a672007-11-28 16:21:06 -0800438if ($terse) {
439 $emacs = 1;
440 $quiet++;
441}
442
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700443if ($tree) {
444 if (defined $root) {
445 if (!top_of_kernel_tree($root)) {
446 die "$P: $root: --root does not point at a valid tree\n";
447 }
448 } else {
449 if (top_of_kernel_tree('.')) {
450 $root = '.';
451 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
452 top_of_kernel_tree($1)) {
453 $root = $1;
454 }
455 }
456
457 if (!defined $root) {
458 print "Must be run from the top-level dir. of a kernel tree\n";
459 exit(2);
460 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700461}
462
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700463my $emitted_corrupt = 0;
464
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700465our $Ident = qr{
466 [A-Za-z_][A-Za-z\d_]*
467 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
468 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700469our $Storage = qr{extern|static|asmlinkage};
470our $Sparse = qr{
471 __user|
472 __kernel|
473 __force|
474 __iomem|
475 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800476 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700477 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700478 __refconst|
479 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800480 __rcu|
481 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700482 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800483our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
484our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
485our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
486our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
487our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700488
Wolfram Sang52131292010-03-05 13:43:51 -0800489# Notes to $Attribute:
490# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700491our $Attribute = qr{
492 const|
Joe Perchesb5e87362021-02-25 17:21:40 -0800493 volatile|
Joe Perches03f1df72010-10-26 14:23:16 -0700494 __percpu|
495 __nocast|
496 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200497 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700498 __packed__|
499 __packed2__|
500 __naked|
501 __maybe_unused|
502 __always_unused|
503 __noreturn|
504 __used|
505 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800506 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700507 __noclone|
508 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700509 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700510 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700511 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700512 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700513 ____cacheline_aligned|
514 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800515 ____cacheline_internodealigned_in_smp|
Kees Cook86cffec2021-11-05 13:36:19 -0700516 __weak|
517 __alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\)
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700518 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700519our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700520our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700521our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
522our $Lval = qr{$Ident(?:$Member)*};
523
Joe Perches95e2c602013-07-03 15:05:20 -0700524our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
525our $Binary = qr{(?i)0b[01]+$Int_type?};
526our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
527our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700528our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesd2af5aa2021-09-07 19:59:51 -0700529our $String = qr{(?:\b[Lu])?"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800530our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
531our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
532our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800533our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700534our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800535our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700536our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700537our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700538our $Operators = qr{
539 <=|>=|==|!=|
540 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700541 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700542 }x;
543
Joe Perches91cb5192014-04-03 14:49:32 -0700544our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
545
Joe Perchesab7e23f2015-04-16 12:44:22 -0700546our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800547our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700548our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700549our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800550our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700551our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800552our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700553our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800554
Joe Perches15662b32011-10-31 17:13:12 -0700555our $NON_ASCII_UTF8 = qr{
556 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700557 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
558 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
559 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
560 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
561 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
562 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
563}x;
564
Joe Perches15662b32011-10-31 17:13:12 -0700565our $UTF8 = qr{
566 [\x09\x0A\x0D\x20-\x7E] # ASCII
567 | $NON_ASCII_UTF8
568}x;
569
Joe Perchese6176fa2015-06-25 15:02:49 -0700570our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800571our $typeOtherOSTypedefs = qr{(?x:
572 u_(?:char|short|int|long) | # bsd
573 u(?:nchar|short|int|long) # sysv
574)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700575our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700576 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700577 atomic_t
578)};
Mickaël Salaün8ea01142022-09-02 13:19:23 +0200579our $typeStdioTypedefs = qr{(?x:
580 FILE
581)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700582our $typeTypedefs = qr{(?x:
583 $typeC99Typedefs\b|
584 $typeOtherOSTypedefs\b|
Mickaël Salaün8ea01142022-09-02 13:19:23 +0200585 $typeKernelTypedefs\b|
586 $typeStdioTypedefs\b
Joe Perchese6176fa2015-06-25 15:02:49 -0700587)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700588
Joe Perches6d32f7a2015-11-06 16:31:37 -0800589our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
590
Joe Perches691e6692010-03-05 13:43:51 -0800591our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800592 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700593 (?:[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 -0800594 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700595 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700596 panic|
Joe Perches06668722013-11-12 15:10:07 -0800597 MODULE_[A-Z_]+|
598 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800599)};
600
Joe Perchese29a70f2019-03-07 16:28:35 -0800601our $allocFunctions = qr{(?x:
602 (?:(?:devm_)?
Joe Perches58f02262021-02-25 17:22:01 -0800603 (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800604 kstrdup(?:_const)? |
605 kmemdup(?:_nul)?) |
Christophe JAILLET461e1562020-04-20 18:13:58 -0700606 (?:\w+)?alloc_skb(?:_ip_align)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800607 # dev_alloc_skb/netdev_alloc_skb, et al
608 dma_alloc_coherent
609)};
610
Joe Perches20112472011-07-25 17:13:23 -0700611our $signature_tags = qr{(?xi:
612 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800613 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700614 Acked-by:|
615 Tested-by:|
616 Reviewed-by:|
617 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700618 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700619 To:|
620 Cc:
621)};
622
Joe Perchesadb2da82021-02-25 17:21:50 -0800623our $tracing_logging_tags = qr{(?xi:
624 [=-]*> |
625 <[=-]* |
626 \[ |
627 \] |
628 start |
629 called |
630 entered |
631 entry |
632 enter |
633 in |
634 inside |
635 here |
636 begin |
637 exit |
638 end |
639 done |
640 leave |
641 completed |
642 out |
643 return |
644 [\.\!:\s]*
645)};
646
Aditya Srivastava831242a2020-12-15 20:45:12 -0800647sub edit_distance_min {
648 my (@arr) = @_;
649 my $len = scalar @arr;
650 if ((scalar @arr) < 1) {
651 # if underflow, return
652 return;
653 }
654 my $min = $arr[0];
655 for my $i (0 .. ($len-1)) {
656 if ($arr[$i] < $min) {
657 $min = $arr[$i];
658 }
659 }
660 return $min;
661}
662
663sub get_edit_distance {
664 my ($str1, $str2) = @_;
665 $str1 = lc($str1);
666 $str2 = lc($str2);
667 $str1 =~ s/-//g;
668 $str2 =~ s/-//g;
669 my $len1 = length($str1);
670 my $len2 = length($str2);
671 # two dimensional array storing minimum edit distance
672 my @distance;
673 for my $i (0 .. $len1) {
674 for my $j (0 .. $len2) {
675 if ($i == 0) {
676 $distance[$i][$j] = $j;
677 } elsif ($j == 0) {
678 $distance[$i][$j] = $i;
679 } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) {
680 $distance[$i][$j] = $distance[$i - 1][$j - 1];
681 } else {
682 my $dist1 = $distance[$i][$j - 1]; #insert distance
683 my $dist2 = $distance[$i - 1][$j]; # remove
684 my $dist3 = $distance[$i - 1][$j - 1]; #replace
685 $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3);
686 }
687 }
688 }
689 return $distance[$len1][$len2];
690}
691
692sub find_standard_signature {
693 my ($sign_off) = @_;
694 my @standard_signature_tags = (
695 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
696 'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
697 );
698 foreach my $signature (@standard_signature_tags) {
699 return $signature if (get_edit_distance($sign_off, $signature) <= 2);
700 }
701
702 return "";
703}
704
Bjorn Helgaas9b71f792022-10-19 15:28:43 -0500705our $obsolete_archives = qr{(?xi:
706 \Qfreedesktop.org/archives/dri-devel\E |
707 \Qlists.infradead.org\E |
708 \Qlkml.org\E |
709 \Qmail-archive.com\E |
710 \Qmailman.alsa-project.org/pipermail\E |
711 \Qmarc.info\E |
712 \Qozlabs.org/pipermail\E |
713 \Qspinics.net\E
714)};
715
Joe Perches18130872014-08-06 16:11:22 -0700716our @typeListMisordered = (
717 qr{char\s+(?:un)?signed},
718 qr{int\s+(?:(?:un)?signed\s+)?short\s},
719 qr{int\s+short(?:\s+(?:un)?signed)},
720 qr{short\s+int(?:\s+(?:un)?signed)},
721 qr{(?:un)?signed\s+int\s+short},
722 qr{short\s+(?:un)?signed},
723 qr{long\s+int\s+(?:un)?signed},
724 qr{int\s+long\s+(?:un)?signed},
725 qr{long\s+(?:un)?signed\s+int},
726 qr{int\s+(?:un)?signed\s+long},
727 qr{int\s+(?:un)?signed},
728 qr{int\s+long\s+long\s+(?:un)?signed},
729 qr{long\s+long\s+int\s+(?:un)?signed},
730 qr{long\s+long\s+(?:un)?signed\s+int},
731 qr{long\s+long\s+(?:un)?signed},
732 qr{long\s+(?:un)?signed},
733);
734
Andy Whitcroft8905a672007-11-28 16:21:06 -0800735our @typeList = (
736 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700737 qr{(?:(?:un)?signed\s+)?char},
738 qr{(?:(?:un)?signed\s+)?short\s+int},
739 qr{(?:(?:un)?signed\s+)?short},
740 qr{(?:(?:un)?signed\s+)?int},
741 qr{(?:(?:un)?signed\s+)?long\s+int},
742 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
743 qr{(?:(?:un)?signed\s+)?long\s+long},
744 qr{(?:(?:un)?signed\s+)?long},
745 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800746 qr{float},
747 qr{double},
748 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800749 qr{struct\s+$Ident},
750 qr{union\s+$Ident},
751 qr{enum\s+$Ident},
752 qr{${Ident}_t},
753 qr{${Ident}_handler},
754 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700755 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800756);
Joe Perches938224b2016-01-20 14:59:15 -0800757
758our $C90_int_types = qr{(?x:
759 long\s+long\s+int\s+(?:un)?signed|
760 long\s+long\s+(?:un)?signed\s+int|
761 long\s+long\s+(?:un)?signed|
762 (?:(?:un)?signed\s+)?long\s+long\s+int|
763 (?:(?:un)?signed\s+)?long\s+long|
764 int\s+long\s+long\s+(?:un)?signed|
765 int\s+(?:(?:un)?signed\s+)?long\s+long|
766
767 long\s+int\s+(?:un)?signed|
768 long\s+(?:un)?signed\s+int|
769 long\s+(?:un)?signed|
770 (?:(?:un)?signed\s+)?long\s+int|
771 (?:(?:un)?signed\s+)?long|
772 int\s+long\s+(?:un)?signed|
773 int\s+(?:(?:un)?signed\s+)?long|
774
775 int\s+(?:un)?signed|
776 (?:(?:un)?signed\s+)?int
777)};
778
Alex Dowad485ff232015-06-25 15:02:52 -0700779our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700780our @typeListWithAttr = (
781 @typeList,
782 qr{struct\s+$InitAttribute\s+$Ident},
783 qr{union\s+$InitAttribute\s+$Ident},
784);
785
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700786our @modifierList = (
787 qr{fastcall},
788);
Alex Dowad485ff232015-06-25 15:02:52 -0700789our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800790
Joe Perches24358802014-04-03 14:49:13 -0700791our @mode_permission_funcs = (
792 ["module_param", 3],
793 ["module_param_(?:array|named|string)", 4],
794 ["module_param_array_named", 5],
795 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
796 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700797 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
798 ["IIO_DEV_ATTR_[A-Z_]+", 1],
799 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
800 ["SENSOR_TEMPLATE(?:_2|)", 3],
801 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700802);
803
Joe Perches1a3dcf22020-08-11 18:35:16 -0700804my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
805
Joe Perches515a2352014-04-03 14:49:24 -0700806#Create a search pattern for all these functions to speed up a loop below
807our $mode_perms_search = "";
808foreach my $entry (@mode_permission_funcs) {
809 $mode_perms_search .= '|' if ($mode_perms_search ne "");
810 $mode_perms_search .= $entry->[0];
811}
Joe Perches00180462018-02-06 15:38:55 -0800812$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700813
Joe Perches9189c7e2018-09-07 15:26:18 -0700814our %deprecated_apis = (
815 "synchronize_rcu_bh" => "synchronize_rcu",
816 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
817 "call_rcu_bh" => "call_rcu",
818 "rcu_barrier_bh" => "rcu_barrier",
819 "synchronize_sched" => "synchronize_rcu",
820 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
821 "call_rcu_sched" => "call_rcu",
822 "rcu_barrier_sched" => "rcu_barrier",
823 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
824 "cond_synchronize_sched" => "cond_synchronize_rcu",
Ira Weinydefdaff2022-08-13 15:00:34 -0700825 "kmap" => "kmap_local_page",
826 "kmap_atomic" => "kmap_local_page",
Joe Perches9189c7e2018-09-07 15:26:18 -0700827);
828
829#Create a search pattern for all these strings to speed up a loop below
830our $deprecated_apis_search = "";
831foreach my $entry (keys %deprecated_apis) {
832 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
833 $deprecated_apis_search .= $entry;
834}
835$deprecated_apis_search = "(?:${deprecated_apis_search})";
836
Joe Perchesb392c642015-04-16 12:44:16 -0700837our $mode_perms_world_writable = qr{
838 S_IWUGO |
839 S_IWOTH |
840 S_IRWXUGO |
841 S_IALLUGO |
842 0[0-7][0-7][2367]
843}x;
844
Joe Perchesf90774e2016-10-11 13:51:47 -0700845our %mode_permission_string_types = (
846 "S_IRWXU" => 0700,
847 "S_IRUSR" => 0400,
848 "S_IWUSR" => 0200,
849 "S_IXUSR" => 0100,
850 "S_IRWXG" => 0070,
851 "S_IRGRP" => 0040,
852 "S_IWGRP" => 0020,
853 "S_IXGRP" => 0010,
854 "S_IRWXO" => 0007,
855 "S_IROTH" => 0004,
856 "S_IWOTH" => 0002,
857 "S_IXOTH" => 0001,
858 "S_IRWXUGO" => 0777,
859 "S_IRUGO" => 0444,
860 "S_IWUGO" => 0222,
861 "S_IXUGO" => 0111,
862);
863
864#Create a search pattern for all these strings to speed up a loop below
865our $mode_perms_string_search = "";
866foreach my $entry (keys %mode_permission_string_types) {
867 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
868 $mode_perms_string_search .= $entry;
869}
Joe Perches00180462018-02-06 15:38:55 -0800870our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
871our $multi_mode_perms_string_search = qr{
872 ${single_mode_perms_string_search}
873 (?:\s*\|\s*${single_mode_perms_string_search})*
874}x;
875
876sub perms_to_octal {
877 my ($string) = @_;
878
879 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
880
881 my $val = "";
882 my $oval = "";
883 my $to = 0;
884 my $curpos = 0;
885 my $lastpos = 0;
886 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
887 $curpos = pos($string);
888 my $match = $2;
889 my $omatch = $1;
890 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
891 $lastpos = $curpos;
892 $to |= $mode_permission_string_types{$match};
893 $val .= '\s*\|\s*' if ($val ne "");
894 $val .= $match;
895 $oval .= $omatch;
896 }
897 $oval =~ s/^\s*\|\s*//;
898 $oval =~ s/\s*\|\s*$//;
899 return sprintf("%04o", $to);
900}
Joe Perchesf90774e2016-10-11 13:51:47 -0700901
Wolfram Sang7840a942010-08-09 17:20:57 -0700902our $allowed_asm_includes = qr{(?x:
903 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700904 memory|
905 time|
906 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700907)};
908# memory.h: ARM has a custom one
909
Kees Cook66b47b42014-10-13 15:51:57 -0700910# Load common spelling mistakes and build regular expression list.
911my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700912my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700913
Joe Perches36061e32014-12-10 15:51:43 -0800914if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800915 while (<$spelling>) {
916 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700917
Joe Perches36061e32014-12-10 15:51:43 -0800918 $line =~ s/\s*\n?$//g;
919 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700920
Joe Perches36061e32014-12-10 15:51:43 -0800921 next if ($line =~ m/^\s*#/);
922 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700923
Joe Perches36061e32014-12-10 15:51:43 -0800924 my ($suspect, $fix) = split(/\|\|/, $line);
925
Joe Perches36061e32014-12-10 15:51:43 -0800926 $spelling_fix{$suspect} = $fix;
927 }
928 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800929} else {
930 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700931}
Kees Cook66b47b42014-10-13 15:51:57 -0700932
Joe Perchesebfd7d62015-04-16 12:44:14 -0700933if ($codespell) {
934 if (open(my $spelling, '<', $codespellfile)) {
935 while (<$spelling>) {
936 my $line = $_;
937
938 $line =~ s/\s*\n?$//g;
939 $line =~ s/^\s*//g;
940
941 next if ($line =~ m/^\s*#/);
942 next if ($line =~ m/^\s*$/);
943 next if ($line =~ m/, disabled/i);
944
945 $line =~ s/,.*$//;
946
947 my ($suspect, $fix) = split(/->/, $line);
948
949 $spelling_fix{$suspect} = $fix;
950 }
951 close($spelling);
952 } else {
953 warn "No codespell typos will be found - file '$codespellfile': $!\n";
954 }
955}
956
957$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
958
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700959sub read_words {
960 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700961
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700962 if (open(my $words, '<', $file)) {
963 while (<$words>) {
964 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700965
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700966 $line =~ s/\s*\n?$//g;
967 $line =~ s/^\s*//g;
968
969 next if ($line =~ m/^\s*#/);
970 next if ($line =~ m/^\s*$/);
971 if ($line =~ /\s/) {
972 print("$file: '$line' invalid - ignored\n");
973 next;
974 }
975
Quentin Monnetced69da12020-08-11 18:35:13 -0700976 $$wordsRef .= '|' if (defined $$wordsRef);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700977 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700978 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700979 close($file);
980 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700981 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700982
983 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700984}
985
Quentin Monnetced69da12020-08-11 18:35:13 -0700986my $const_structs;
987if (show_type("CONST_STRUCT")) {
988 read_words(\$const_structs, $conststructsfile)
989 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
990}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700991
Quentin Monnetced69da12020-08-11 18:35:13 -0700992if (defined($typedefsfile)) {
993 my $typeOtherTypedefs;
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700994 read_words(\$typeOtherTypedefs, $typedefsfile)
995 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
Quentin Monnetced69da12020-08-11 18:35:13 -0700996 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700997}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700998
Andy Whitcroft8905a672007-11-28 16:21:06 -0800999sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -07001000 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
1001 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -07001002 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -07001003 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001004 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -07001005 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -07001006 (?:$typeTypedefs\b)|
1007 (?:${all}\b)
1008 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001009 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -07001010 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -08001011 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -08001012 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001013 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001014 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -08001015 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001016 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -08001017 }x;
Joe Perches18130872014-08-06 16:11:22 -07001018 $NonptrTypeMisordered = qr{
1019 (?:$Modifier\s+|const\s+)*
1020 (?:
1021 (?:${Misordered}\b)
1022 )
1023 (?:\s+$Modifier|\s+const)*
1024 }x;
Joe Perches8716de32013-09-11 14:24:05 -07001025 $NonptrTypeWithAttr = qr{
1026 (?:$Modifier\s+|const\s+)*
1027 (?:
1028 (?:typeof|__typeof__)\s*\([^\)]*\)|
1029 (?:$typeTypedefs\b)|
1030 (?:${allWithAttr}\b)
1031 )
1032 (?:\s+$Modifier|\s+const)*
1033 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001034 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001035 $NonptrType
Antonio Borneo7b184962020-04-06 20:11:04 -07001036 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001037 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -08001038 }x;
Joe Perches18130872014-08-06 16:11:22 -07001039 $TypeMisordered = qr{
1040 $NonptrTypeMisordered
Antonio Borneo7b184962020-04-06 20:11:04 -07001041 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Perches18130872014-08-06 16:11:22 -07001042 (?:\s+$Inline|\s+$Modifier)*
1043 }x;
Joe Perches91cb5192014-04-03 14:49:32 -07001044 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -07001045 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -08001046}
1047build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001048
Joe Perches7d2367a2011-07-25 17:13:22 -07001049our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001050
1051# Using $balanced_parens, $LvalOrFunc, or $FuncArg
1052# requires at least perl version v5.10.0
1053# Any use must be runtime checked with $^V
1054
1055our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -07001056our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -08001057our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -07001058
Joe Perchesf8422302014-08-06 16:11:31 -07001059our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -07001060 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -07001061 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Joe Perchesdcea7962022-05-25 12:03:17 -07001062 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(|
1063 (?:$Storage\s+)?(?:XA_STATE|XA_STATE_ORDER)\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -07001064)};
1065
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08001066our %allow_repeated_words = (
1067 add => '',
1068 added => '',
1069 bad => '',
1070 be => '',
1071);
1072
Joe Perches7d2367a2011-07-25 17:13:22 -07001073sub deparenthesize {
1074 my ($string) = @_;
1075 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -07001076
1077 while ($string =~ /^\s*\(.*\)\s*$/) {
1078 $string =~ s@^\s*\(\s*@@;
1079 $string =~ s@\s*\)\s*$@@;
1080 }
1081
Joe Perches7d2367a2011-07-25 17:13:22 -07001082 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -07001083
Joe Perches7d2367a2011-07-25 17:13:22 -07001084 return $string;
1085}
1086
Joe Perches34456862013-07-03 15:05:34 -07001087sub seed_camelcase_file {
1088 my ($file) = @_;
1089
1090 return if (!(-f $file));
1091
1092 local $/;
1093
1094 open(my $include_file, '<', "$file")
1095 or warn "$P: Can't read '$file' $!\n";
1096 my $text = <$include_file>;
1097 close($include_file);
1098
1099 my @lines = split('\n', $text);
1100
1101 foreach my $line (@lines) {
1102 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
1103 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
1104 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -08001105 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
1106 $camelcase{$1} = 1;
1107 } 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 -07001108 $camelcase{$1} = 1;
1109 }
1110 }
1111}
1112
Joe Perchescd28b112019-12-04 16:52:09 -08001113our %maintained_status = ();
1114
Joe Perches85b0ee12016-10-11 13:51:44 -07001115sub is_maintained_obsolete {
1116 my ($filename) = @_;
1117
Jerome Forissierf2c19c22016-12-12 16:46:23 -08001118 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -07001119
Joe Perchescd28b112019-12-04 16:52:09 -08001120 if (!exists($maintained_status{$filename})) {
1121 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1122 }
Joe Perches85b0ee12016-10-11 13:51:44 -07001123
Joe Perchescd28b112019-12-04 16:52:09 -08001124 return $maintained_status{$filename} =~ /obsolete/i;
Joe Perches85b0ee12016-10-11 13:51:44 -07001125}
1126
Joe Perches3b6e8ac2018-08-21 21:57:47 -07001127sub is_SPDX_License_valid {
1128 my ($license) = @_;
1129
Guenter Roeckf9363b32021-06-30 18:56:19 -07001130 return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -07001131
Joe Perches56294112018-08-21 21:58:04 -07001132 my $root_path = abs_path($root);
Guenter Roeckf9363b32021-06-30 18:56:19 -07001133 my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -07001134 return 0 if ($status ne "");
1135 return 1;
1136}
1137
Joe Perches34456862013-07-03 15:05:34 -07001138my $camelcase_seeded = 0;
1139sub seed_camelcase_includes {
1140 return if ($camelcase_seeded);
1141
1142 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -07001143 my $camelcase_cache = "";
1144 my @include_files = ();
1145
1146 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -07001147
Joe Perches0f7f6352020-10-24 16:59:04 -07001148 if (-e "$gitroot") {
Joe Perchesdbbf8692019-09-25 16:46:52 -07001149 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -07001150 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -07001151 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -07001152 } else {
Joe Perchesc707a812013-07-08 16:00:43 -07001153 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -07001154 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -07001155 @include_files = split('\n', $files);
1156 foreach my $file (@include_files) {
1157 my $date = POSIX::strftime("%Y%m%d%H%M",
1158 localtime((stat $file)[9]));
1159 $last_mod_date = $date if ($last_mod_date < $date);
1160 }
1161 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -07001162 }
Joe Perchesc707a812013-07-08 16:00:43 -07001163
1164 if ($camelcase_cache ne "" && -f $camelcase_cache) {
1165 open(my $camelcase_file, '<', "$camelcase_cache")
1166 or warn "$P: Can't read '$camelcase_cache' $!\n";
1167 while (<$camelcase_file>) {
1168 chomp;
1169 $camelcase{$_} = 1;
1170 }
1171 close($camelcase_file);
1172
1173 return;
1174 }
1175
Joe Perches0f7f6352020-10-24 16:59:04 -07001176 if (-e "$gitroot") {
Joe Perchesdbbf8692019-09-25 16:46:52 -07001177 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -07001178 @include_files = split('\n', $files);
1179 }
1180
Joe Perches34456862013-07-03 15:05:34 -07001181 foreach my $file (@include_files) {
1182 seed_camelcase_file($file);
1183 }
Joe Perches351b2a12013-07-03 15:05:36 -07001184
Joe Perchesc707a812013-07-08 16:00:43 -07001185 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -07001186 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -07001187 open(my $camelcase_file, '>', "$camelcase_cache")
1188 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -07001189 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
1190 print $camelcase_file ("$_\n");
1191 }
1192 close($camelcase_file);
1193 }
Joe Perches34456862013-07-03 15:05:34 -07001194}
1195
Joe Perchesf5f61322020-10-15 20:12:12 -07001196sub git_is_single_file {
1197 my ($filename) = @_;
1198
1199 return 0 if ((which("git") eq "") || !(-e "$gitroot"));
1200
1201 my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
1202 my $count = $output =~ tr/\n//;
1203 return $count eq 1 && $output =~ m{^${filename}$};
1204}
1205
Joe Perchesd311cd42014-08-06 16:10:57 -07001206sub git_commit_info {
1207 my ($commit, $id, $desc) = @_;
1208
Joe Perches0f7f6352020-10-24 16:59:04 -07001209 return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
Joe Perchesd311cd42014-08-06 16:10:57 -07001210
Joe Perchesdbbf8692019-09-25 16:46:52 -07001211 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -07001212 $output =~ s/^\s*//gm;
1213 my @lines = split("\n", $output);
1214
Joe Perches0d7835f2015-02-13 14:38:35 -08001215 return ($id, $desc) if ($#lines < 0);
1216
Sean Christopherson5a7f4452019-09-25 16:46:49 -07001217 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -07001218# Maybe one day convert this block of bash into something that returns
1219# all matching commit ids, but it's very slow...
1220#
1221# echo "checking commits $1..."
1222# git rev-list --remotes | grep -i "^$1" |
1223# while read line ; do
1224# git log --format='%H %s' -1 $line |
1225# echo "commit $(cut -c 1-12,41-)"
1226# done
Joe Perches4ce9f972021-09-07 19:59:57 -07001227 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
1228 $lines[0] =~ /^fatal: bad object $commit/) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07001229 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -07001230 } else {
1231 $id = substr($lines[0], 0, 12);
1232 $desc = substr($lines[0], 41);
1233 }
1234
1235 return ($id, $desc);
1236}
1237
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001238$chk_signoff = 0 if ($file);
1239
Andy Whitcroft00df3442007-06-08 13:47:06 -07001240my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001241my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001242my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001243my @fixed_inserted = ();
1244my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001245my $fixlinenr = -1;
1246
Du, Changbin4a593c32016-05-20 17:04:16 -07001247# If input is git commits, extract all commits from the commit expressions.
1248# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
Joe Perches0f7f6352020-10-24 16:59:04 -07001249die "$P: No git repository found\n" if ($git && !-e "$gitroot");
Du, Changbin4a593c32016-05-20 17:04:16 -07001250
1251if ($git) {
1252 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001253 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001254 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001255 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1256 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001257 } elsif ($commit_expr =~ m/\.\./) {
1258 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001259 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001260 $git_range = "-1 $commit_expr";
1261 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001262 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001263 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001264 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1265 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001266 my $sha1 = $1;
1267 my $subject = $2;
1268 unshift(@commits, $sha1);
1269 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001270 }
1271 }
1272 die "$P: no git commits after extraction!\n" if (@commits == 0);
1273 @ARGV = @commits;
1274}
1275
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001276my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001277$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001278for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001279 my $FILE;
Joe Perchesf5f61322020-10-15 20:12:12 -07001280 my $is_git_file = git_is_single_file($filename);
1281 my $oldfile = $file;
1282 $file = 1 if ($is_git_file);
Du, Changbin4a593c32016-05-20 17:04:16 -07001283 if ($git) {
1284 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1285 die "$P: $filename: git format-patch failed - $!\n";
1286 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001287 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001288 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001289 } elsif ($filename eq '-') {
1290 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001291 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001292 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001293 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001294 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001295 if ($filename eq '-') {
1296 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001297 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001298 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001299 } else {
1300 $vname = $filename;
1301 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001302 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001303 chomp;
1304 push(@rawlines, $_);
Geert Uytterhoevenc7f574d2020-06-04 16:50:43 -07001305 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001306 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001307 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001308
1309 if ($#ARGV > 0 && $quiet == 0) {
1310 print '-' x length($vname) . "\n";
1311 print "$vname\n";
1312 print '-' x length($vname) . "\n";
1313 }
1314
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001315 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001316 $exit = 1;
1317 }
1318 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001319 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001320 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001321 @fixed_inserted = ();
1322 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001323 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001324 @modifierListFile = ();
1325 @typeListFile = ();
1326 build_types();
Joe Perchesf5f61322020-10-15 20:12:12 -07001327 $file = $oldfile if ($is_git_file);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001328}
1329
Joe Perchesd8469f12015-06-25 15:03:00 -07001330if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001331 hash_show_words(\%use_type, "Used");
1332 hash_show_words(\%ignore_type, "Ignored");
1333
Joe Perches5b579802018-08-21 21:57:33 -07001334 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001335 print << "EOM"
1336
1337NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001338 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001339EOM
1340 }
1341 if ($exit) {
1342 print << "EOM"
1343
1344NOTE: If any of the errors are false positives, please report
1345 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1346EOM
1347 }
1348}
1349
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001350exit($exit);
1351
1352sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001353 my ($root) = @_;
1354
1355 my @tree_check = (
1356 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1357 "README", "Documentation", "arch", "include", "drivers",
1358 "fs", "init", "ipc", "kernel", "lib", "scripts",
1359 );
1360
1361 foreach my $check (@tree_check) {
1362 if (! -e $root . '/' . $check) {
1363 return 0;
1364 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001365 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001366 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001367}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001368
Joe Perches20112472011-07-25 17:13:23 -07001369sub parse_email {
1370 my ($formatted_email) = @_;
1371
1372 my $name = "";
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001373 my $quoted = "";
Joe Perchesdfa05c22020-04-06 20:10:48 -07001374 my $name_comment = "";
Joe Perches20112472011-07-25 17:13:23 -07001375 my $address = "";
1376 my $comment = "";
1377
1378 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1379 $name = $1;
1380 $address = $2;
1381 $comment = $3 if defined $3;
1382 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1383 $address = $1;
1384 $comment = $2 if defined $2;
1385 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1386 $address = $1;
1387 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001388 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001389 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001390 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001391 $name =~ s/^\"|\"$//g;
1392 # If there's a name left after stripping spaces and
1393 # leading quotes, and the address doesn't have both
1394 # leading and trailing angle brackets, the address
1395 # is invalid. ie:
1396 # "joe smith joe@smith.com" bad
1397 # "joe smith <joe@smith.com" bad
1398 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1399 $name = "";
1400 $address = "";
1401 $comment = "";
1402 }
1403 }
1404
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001405 # Extract comments from names excluding quoted parts
1406 # "John D. (Doe)" - Do not extract
1407 if ($name =~ s/\"(.+)\"//) {
1408 $quoted = $1;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001409 }
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001410 while ($name =~ s/\s*($balanced_parens)\s*/ /) {
1411 $name_comment .= trim($1);
1412 }
1413 $name =~ s/^[ \"]+|[ \"]+$//g;
1414 $name = trim("$quoted $name");
1415
Joe Perches3705ce52013-07-03 15:05:31 -07001416 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001417 $address =~ s/^\<|\>$//g;
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001418 $comment = trim($comment);
Joe Perches20112472011-07-25 17:13:23 -07001419
1420 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1421 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1422 $name = "\"$name\"";
1423 }
1424
Joe Perchesdfa05c22020-04-06 20:10:48 -07001425 return ($name, $name_comment, $address, $comment);
Joe Perches20112472011-07-25 17:13:23 -07001426}
1427
1428sub format_email {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001429 my ($name, $name_comment, $address, $comment) = @_;
Joe Perches20112472011-07-25 17:13:23 -07001430
1431 my $formatted_email;
1432
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001433 $name =~ s/^[ \"]+|[ \"]+$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001434 $address = trim($address);
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001435 $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes
Joe Perches20112472011-07-25 17:13:23 -07001436
1437 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1438 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1439 $name = "\"$name\"";
1440 }
1441
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001442 $name_comment = trim($name_comment);
1443 $name_comment = " $name_comment" if ($name_comment ne "");
1444 $comment = trim($comment);
1445 $comment = " $comment" if ($comment ne "");
1446
Joe Perches20112472011-07-25 17:13:23 -07001447 if ("$name" eq "") {
1448 $formatted_email = "$address";
1449 } else {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001450 $formatted_email = "$name$name_comment <$address>";
Joe Perches20112472011-07-25 17:13:23 -07001451 }
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001452 $formatted_email .= "$comment";
Joe Perches20112472011-07-25 17:13:23 -07001453 return $formatted_email;
1454}
1455
Joe Perchesdfa05c22020-04-06 20:10:48 -07001456sub reformat_email {
1457 my ($email) = @_;
1458
1459 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001460 return format_email($email_name, $name_comment, $email_address, $comment);
Joe Perchesdfa05c22020-04-06 20:10:48 -07001461}
1462
1463sub same_email_addresses {
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001464 my ($email1, $email2) = @_;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001465
1466 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1467 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1468
1469 return $email1_name eq $email2_name &&
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001470 $email1_address eq $email2_address &&
1471 $name1_comment eq $name2_comment &&
1472 $comment1 eq $comment2;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001473}
1474
Joe Perchesd311cd42014-08-06 16:10:57 -07001475sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001476 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001477
Joe Perchesbd474ca2014-08-06 16:11:10 -07001478 foreach my $path (split(/:/, $ENV{PATH})) {
1479 if (-e "$path/$bin") {
1480 return "$path/$bin";
1481 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001482 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001483
Joe Perchesbd474ca2014-08-06 16:11:10 -07001484 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001485}
1486
Joe Perches000d1cc12011-07-25 17:13:25 -07001487sub which_conf {
1488 my ($conf) = @_;
1489
1490 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1491 if (-e "$path/$conf") {
1492 return "$path/$conf";
1493 }
1494 }
1495
1496 return "";
1497}
1498
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001499sub expand_tabs {
1500 my ($str) = @_;
1501
1502 my $res = '';
1503 my $n = 0;
1504 for my $c (split(//, $str)) {
1505 if ($c eq "\t") {
1506 $res .= ' ';
1507 $n++;
Antonio Borneo713a09d2020-04-06 20:11:07 -07001508 for (; ($n % $tabsize) != 0; $n++) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001509 $res .= ' ';
1510 }
1511 next;
1512 }
1513 $res .= $c;
1514 $n++;
1515 }
1516
1517 return $res;
1518}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001519sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001520 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001521 return $res;
1522}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001523
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001524sub line_stats {
1525 my ($line) = @_;
1526
1527 # Drop the diff line leader and expand tabs
1528 $line =~ s/^.//;
1529 $line = expand_tabs($line);
1530
1531 # Pick the indent from the front of the line.
1532 my ($white) = ($line =~ /^(\s*)/);
1533
1534 return (length($line), length($white));
1535}
1536
Andy Whitcroft773647a2008-03-28 14:15:58 -07001537my $sanitise_quote = '';
1538
1539sub sanitise_line_reset {
1540 my ($in_comment) = @_;
1541
1542 if ($in_comment) {
1543 $sanitise_quote = '*/';
1544 } else {
1545 $sanitise_quote = '';
1546 }
1547}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001548sub sanitise_line {
1549 my ($line) = @_;
1550
1551 my $res = '';
1552 my $l = '';
1553
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001554 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001555 my $off = 0;
1556 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001557
Andy Whitcroft773647a2008-03-28 14:15:58 -07001558 # Always copy over the diff marker.
1559 $res = substr($line, 0, 1);
1560
1561 for ($off = 1; $off < length($line); $off++) {
1562 $c = substr($line, $off, 1);
1563
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001564 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001565 # and end, all to $;.
1566 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1567 $sanitise_quote = '*/';
1568
1569 substr($res, $off, 2, "$;$;");
1570 $off++;
1571 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001572 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001573 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001574 $sanitise_quote = '';
1575 substr($res, $off, 2, "$;$;");
1576 $off++;
1577 next;
1578 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001579 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1580 $sanitise_quote = '//';
1581
1582 substr($res, $off, 2, $sanitise_quote);
1583 $off++;
1584 next;
1585 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001586
1587 # A \ in a string means ignore the next character.
1588 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1589 $c eq "\\") {
1590 substr($res, $off, 2, 'XX');
1591 $off++;
1592 next;
1593 }
1594 # Regular quotes.
1595 if ($c eq "'" || $c eq '"') {
1596 if ($sanitise_quote eq '') {
1597 $sanitise_quote = $c;
1598
1599 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001600 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001601 } elsif ($sanitise_quote eq $c) {
1602 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001603 }
1604 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001605
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001606 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001607 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1608 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001609 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1610 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001611 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1612 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001613 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001614 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001615 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001616 }
1617
Daniel Walker113f04a2009-09-21 17:04:35 -07001618 if ($sanitise_quote eq '//') {
1619 $sanitise_quote = '';
1620 }
1621
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001622 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001623 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001624 my $clean = 'X' x length($1);
1625 $res =~ s@\<.*\>@<$clean>@;
1626
1627 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001628 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001629 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001630 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001631 }
1632
Joe Perchesdadf6802016-08-02 14:04:33 -07001633 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1634 my $match = $1;
1635 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1636 }
1637
Andy Whitcroft00df3442007-06-08 13:47:06 -07001638 return $res;
1639}
1640
Joe Perchesa6962d72013-04-29 16:18:13 -07001641sub get_quoted_string {
1642 my ($line, $rawline) = @_;
1643
Joe Perches478b1792018-04-10 16:33:34 -07001644 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001645 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001646 return substr($rawline, $-[0], $+[0] - $-[0]);
1647}
1648
Andy Whitcroft8905a672007-11-28 16:21:06 -08001649sub ctx_statement_block {
1650 my ($linenr, $remain, $off) = @_;
1651 my $line = $linenr - 1;
1652 my $blk = '';
1653 my $soff = $off;
1654 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001655 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001656
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001657 my $loff = 0;
1658
Andy Whitcroft8905a672007-11-28 16:21:06 -08001659 my $type = '';
1660 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001661 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001662 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001663 my $c;
1664 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001665
1666 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001667 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001668 @stack = (['', 0]) if ($#stack == -1);
1669
Andy Whitcroft773647a2008-03-28 14:15:58 -07001670 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001671 # If we are about to drop off the end, pull in more
1672 # context.
1673 if ($off >= $len) {
1674 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001675 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001676 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001677 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001678 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001679 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001680 $len = length($blk);
1681 $line++;
1682 last;
1683 }
1684 # Bail if there is no further context.
1685 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001686 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001687 last;
1688 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001689 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1690 $level++;
1691 $type = '#';
1692 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001693 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001694 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001695 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001696 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001697
Andy Whitcroft773647a2008-03-28 14:15:58 -07001698 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001699
1700 # Handle nested #if/#else.
1701 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1702 push(@stack, [ $type, $level ]);
1703 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1704 ($type, $level) = @{$stack[$#stack - 1]};
1705 } elsif ($remainder =~ /^#\s*endif\b/) {
1706 ($type, $level) = @{pop(@stack)};
1707 }
1708
Andy Whitcroft8905a672007-11-28 16:21:06 -08001709 # Statement ends at the ';' or a close '}' at the
1710 # outermost level.
1711 if ($level == 0 && $c eq ';') {
1712 last;
1713 }
1714
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001715 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001716 if ($level == 0 && $coff_set == 0 &&
1717 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1718 $remainder =~ /^(else)(?:\s|{)/ &&
1719 $remainder !~ /^else\s+if\b/) {
1720 $coff = $off + length($1) - 1;
1721 $coff_set = 1;
1722 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1723 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001724 }
1725
Andy Whitcroft8905a672007-11-28 16:21:06 -08001726 if (($type eq '' || $type eq '(') && $c eq '(') {
1727 $level++;
1728 $type = '(';
1729 }
1730 if ($type eq '(' && $c eq ')') {
1731 $level--;
1732 $type = ($level != 0)? '(' : '';
1733
1734 if ($level == 0 && $coff < $soff) {
1735 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001736 $coff_set = 1;
1737 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001738 }
1739 }
1740 if (($type eq '' || $type eq '{') && $c eq '{') {
1741 $level++;
1742 $type = '{';
1743 }
1744 if ($type eq '{' && $c eq '}') {
1745 $level--;
1746 $type = ($level != 0)? '{' : '';
1747
1748 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001749 if (substr($blk, $off + 1, 1) eq ';') {
1750 $off++;
1751 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001752 last;
1753 }
1754 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001755 # Preprocessor commands end at the newline unless escaped.
1756 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1757 $level--;
1758 $type = '';
1759 $off++;
1760 last;
1761 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001762 $off++;
1763 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001764 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001765 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001766 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001767 $line++;
1768 $remain--;
1769 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001770
1771 my $statement = substr($blk, $soff, $off - $soff + 1);
1772 my $condition = substr($blk, $soff, $coff - $soff + 1);
1773
1774 #warn "STATEMENT<$statement>\n";
1775 #warn "CONDITION<$condition>\n";
1776
Andy Whitcroft773647a2008-03-28 14:15:58 -07001777 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001778
1779 return ($statement, $condition,
1780 $line, $remain + 1, $off - $loff + 1, $level);
1781}
1782
Andy Whitcroftcf655042008-03-04 14:28:20 -08001783sub statement_lines {
1784 my ($stmt) = @_;
1785
1786 # Strip the diff line prefixes and rip blank lines at start and end.
1787 $stmt =~ s/(^|\n)./$1/g;
1788 $stmt =~ s/^\s*//;
1789 $stmt =~ s/\s*$//;
1790
1791 my @stmt_lines = ($stmt =~ /\n/g);
1792
1793 return $#stmt_lines + 2;
1794}
1795
1796sub statement_rawlines {
1797 my ($stmt) = @_;
1798
1799 my @stmt_lines = ($stmt =~ /\n/g);
1800
1801 return $#stmt_lines + 2;
1802}
1803
1804sub statement_block_size {
1805 my ($stmt) = @_;
1806
1807 $stmt =~ s/(^|\n)./$1/g;
1808 $stmt =~ s/^\s*{//;
1809 $stmt =~ s/}\s*$//;
1810 $stmt =~ s/^\s*//;
1811 $stmt =~ s/\s*$//;
1812
1813 my @stmt_lines = ($stmt =~ /\n/g);
1814 my @stmt_statements = ($stmt =~ /;/g);
1815
1816 my $stmt_lines = $#stmt_lines + 2;
1817 my $stmt_statements = $#stmt_statements + 1;
1818
1819 if ($stmt_lines > $stmt_statements) {
1820 return $stmt_lines;
1821 } else {
1822 return $stmt_statements;
1823 }
1824}
1825
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001826sub ctx_statement_full {
1827 my ($linenr, $remain, $off) = @_;
1828 my ($statement, $condition, $level);
1829
1830 my (@chunks);
1831
Andy Whitcroftcf655042008-03-04 14:28:20 -08001832 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001833 ($statement, $condition, $linenr, $remain, $off, $level) =
1834 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001835 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001836 push(@chunks, [ $condition, $statement ]);
1837 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1838 return ($level, $linenr, @chunks);
1839 }
1840
1841 # Pull in the following conditional/block pairs and see if they
1842 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001843 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001844 ($statement, $condition, $linenr, $remain, $off, $level) =
1845 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001846 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001847 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001848 #print "C: push\n";
1849 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001850 }
1851
1852 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001853}
1854
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001855sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001856 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001857 my $line;
1858 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001859 my $blk = '';
1860 my @o;
1861 my @c;
1862 my @res = ();
1863
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001864 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001865 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001866 for ($line = $start; $remain > 0; $line++) {
1867 next if ($rawlines[$line] =~ /^-/);
1868 $remain--;
1869
1870 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001871
1872 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001873 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001874 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001875 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001876 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001877 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001878 $level = pop(@stack);
1879 }
1880
Andy Whitcroft01464f32010-10-26 14:23:19 -07001881 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001882 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1883 if ($off > 0) {
1884 $off--;
1885 next;
1886 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001887
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001888 if ($c eq $close && $level > 0) {
1889 $level--;
1890 last if ($level == 0);
1891 } elsif ($c eq $open) {
1892 $level++;
1893 }
1894 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001895
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001896 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001897 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001898 }
1899
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001900 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001901 }
1902
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001903 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001904}
1905sub ctx_block_outer {
1906 my ($linenr, $remain) = @_;
1907
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001908 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1909 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001910}
1911sub ctx_block {
1912 my ($linenr, $remain) = @_;
1913
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001914 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1915 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001916}
1917sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001918 my ($linenr, $remain, $off) = @_;
1919
1920 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1921 return @r;
1922}
1923sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001924 my ($linenr, $remain) = @_;
1925
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001926 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001927}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001928sub ctx_statement_level {
1929 my ($linenr, $remain, $off) = @_;
1930
1931 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1932}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001933
1934sub ctx_locate_comment {
1935 my ($first_line, $end_line) = @_;
1936
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001937 # If c99 comment on the current line, or the line before or after
1938 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1939 return $current_comment if (defined $current_comment);
1940 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1941 return $current_comment if (defined $current_comment);
1942 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1943 return $current_comment if (defined $current_comment);
1944
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001945 # Catch a comment on the end of the line itself.
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001946 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001947 return $current_comment if (defined $current_comment);
1948
1949 # Look through the context and try and figure out if there is a
1950 # comment.
1951 my $in_comment = 0;
1952 $current_comment = '';
1953 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001954 my $line = $rawlines[$linenr - 1];
1955 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001956 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1957 $in_comment = 1;
1958 }
1959 if ($line =~ m@/\*@) {
1960 $in_comment = 1;
1961 }
1962 if (!$in_comment && $current_comment ne '') {
1963 $current_comment = '';
1964 }
1965 $current_comment .= $line . "\n" if ($in_comment);
1966 if ($line =~ m@\*/@) {
1967 $in_comment = 0;
1968 }
1969 }
1970
1971 chomp($current_comment);
1972 return($current_comment);
1973}
1974sub ctx_has_comment {
1975 my ($first_line, $end_line) = @_;
1976 my $cmt = ctx_locate_comment($first_line, $end_line);
1977
Andy Whitcroft00df3442007-06-08 13:47:06 -07001978 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001979 ##print "CMMT: $cmt\n";
1980
1981 return ($cmt ne '');
1982}
1983
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001984sub raw_line {
1985 my ($linenr, $cnt) = @_;
1986
1987 my $offset = $linenr - 1;
1988 $cnt++;
1989
1990 my $line;
1991 while ($cnt) {
1992 $line = $rawlines[$offset++];
1993 next if (defined($line) && $line =~ /^-/);
1994 $cnt--;
1995 }
1996
1997 return $line;
1998}
1999
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07002000sub get_stat_real {
2001 my ($linenr, $lc) = @_;
2002
2003 my $stat_real = raw_line($linenr, 0);
2004 for (my $count = $linenr + 1; $count <= $lc; $count++) {
2005 $stat_real = $stat_real . "\n" . raw_line($count, 0);
2006 }
2007
2008 return $stat_real;
2009}
2010
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07002011sub get_stat_here {
2012 my ($linenr, $cnt, $here) = @_;
2013
2014 my $herectx = $here . "\n";
2015 for (my $n = 0; $n < $cnt; $n++) {
2016 $herectx .= raw_line($linenr, $n) . "\n";
2017 }
2018
2019 return $herectx;
2020}
2021
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002022sub cat_vet {
2023 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002024 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002025
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002026 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002027 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
2028 $res .= $1;
2029 if ($2 ne '') {
2030 $coded = sprintf("^%c", unpack('C', $2) + 64);
2031 $res .= $coded;
2032 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002033 }
2034 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002035
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002036 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002037}
2038
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002039my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002040my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002041my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002042my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002043
2044sub annotate_reset {
2045 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002046 $av_pending = '_';
2047 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002048 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002049}
2050
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002051sub annotate_values {
2052 my ($stream, $type) = @_;
2053
2054 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002055 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002056 my $cur = $stream;
2057
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002058 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002059
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002060 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002061 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002062 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002063 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002064 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002065 print "WS($1)\n" if ($dbg_values > 1);
2066 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002067 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002068 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002069 }
2070
Florian Micklerc023e4732011-01-12 16:59:58 -08002071 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07002072 print "CAST($1)\n" if ($dbg_values > 1);
2073 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08002074 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07002075
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07002076 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002077 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002078 $type = 'T';
2079
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07002080 } elsif ($cur =~ /^($Modifier)\s*/) {
2081 print "MODIFIER($1)\n" if ($dbg_values > 1);
2082 $type = 'T';
2083
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002084 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002085 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002086 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002087 push(@av_paren_type, $type);
2088 if ($2 ne '') {
2089 $av_pending = 'N';
2090 }
2091 $type = 'E';
2092
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002093 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002094 print "UNDEF($1)\n" if ($dbg_values > 1);
2095 $av_preprocessor = 1;
2096 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002097
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002098 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002099 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002100 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002101
2102 push(@av_paren_type, $type);
2103 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002104 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08002105
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002106 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002107 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
2108 $av_preprocessor = 1;
2109
2110 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
2111
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002112 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08002113
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002114 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002115 print "PRE_END($1)\n" if ($dbg_values > 1);
2116
2117 $av_preprocessor = 1;
2118
2119 # Assume all arms of the conditional end as this
2120 # one does, and continue as if the #endif was not here.
2121 pop(@av_paren_type);
2122 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002123 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002124
2125 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002126 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002127
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002128 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
2129 print "ATTR($1)\n" if ($dbg_values > 1);
2130 $av_pending = $type;
2131 $type = 'N';
2132
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002133 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002134 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002135 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002136 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002137 }
2138 $type = 'N';
2139
Andy Whitcroft14b111c2008-10-15 22:02:16 -07002140 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002141 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07002142 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002143 $type = 'N';
2144
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002145 } elsif ($cur =~/^(case)/o) {
2146 print "CASE($1)\n" if ($dbg_values > 1);
2147 $av_pend_colon = 'C';
2148 $type = 'N';
2149
Andy Whitcroft14b111c2008-10-15 22:02:16 -07002150 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002151 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002152 $type = 'N';
2153
2154 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002155 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002156 push(@av_paren_type, $av_pending);
2157 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002158 $type = 'N';
2159
2160 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002161 my $new_type = pop(@av_paren_type);
2162 if ($new_type ne '_') {
2163 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002164 print "PAREN('$1') -> $type\n"
2165 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002166 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002167 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002168 }
2169
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07002170 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002171 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07002172 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08002173 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002174
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002175 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
2176 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002177 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002178 } elsif ($type eq 'E') {
2179 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002180 }
2181 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
2182 $type = 'V';
2183
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002184 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002185 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002186 $type = 'V';
2187
2188 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002189 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002190 $type = 'N';
2191
Andy Whitcroftcf655042008-03-04 14:28:20 -08002192 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002193 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002194 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002195 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002196
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002197 } elsif ($cur =~/^(,)/) {
2198 print "COMMA($1)\n" if ($dbg_values > 1);
2199 $type = 'C';
2200
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002201 } elsif ($cur =~ /^(\?)/o) {
2202 print "QUESTION($1)\n" if ($dbg_values > 1);
2203 $type = 'N';
2204
2205 } elsif ($cur =~ /^(:)/o) {
2206 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
2207
2208 substr($var, length($res), 1, $av_pend_colon);
2209 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
2210 $type = 'E';
2211 } else {
2212 $type = 'N';
2213 }
2214 $av_pend_colon = 'O';
2215
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002216 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002217 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002218 $type = 'N';
2219
Andy Whitcroft0d413862008-10-15 22:02:16 -07002220 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002221 my $variant;
2222
2223 print "OPV($1)\n" if ($dbg_values > 1);
2224 if ($type eq 'V') {
2225 $variant = 'B';
2226 } else {
2227 $variant = 'U';
2228 }
2229
2230 substr($var, length($res), 1, $variant);
2231 $type = 'N';
2232
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002233 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002234 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002235 if ($1 ne '++' && $1 ne '--') {
2236 $type = 'N';
2237 }
2238
2239 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002240 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002241 }
2242 if (defined $1) {
2243 $cur = substr($cur, length($1));
2244 $res .= $type x length($1);
2245 }
2246 }
2247
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002248 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002249}
2250
Andy Whitcroft8905a672007-11-28 16:21:06 -08002251sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002252 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002253 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002254 ^(?:
2255 $Modifier|
2256 $Storage|
2257 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002258 DEFINE_\S+
2259 )$|
2260 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002261 goto|
2262 return|
2263 case|
2264 else|
2265 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08002266 do|
2267 \#|
2268 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002269 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07002270 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002271 )}x;
2272 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2273 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002274 # Check for modifiers.
2275 $possible =~ s/\s*$Storage\s*//g;
2276 $possible =~ s/\s*$Sparse\s*//g;
2277 if ($possible =~ /^\s*$/) {
2278
2279 } elsif ($possible =~ /\s/) {
2280 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07002281 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002282 if ($modifier !~ $notPermitted) {
2283 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002284 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002285 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07002286 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002287
2288 } else {
2289 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002290 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002291 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002292 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07002293 } else {
2294 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002295 }
2296}
2297
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002298my $prefix = '';
2299
Joe Perches000d1cc12011-07-25 17:13:25 -07002300sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002301 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002302
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002303 $type =~ tr/[a-z]/[A-Z]/;
2304
Joe Perchescbec18a2014-04-03 14:49:19 -07002305 return defined $use_type{$type} if (scalar keys %use_type > 0);
2306
2307 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002308}
2309
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002310sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002311 my ($level, $type, $msg) = @_;
2312
2313 if (!show_type($type) ||
2314 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002315 return 0;
2316 }
Joe Perches57230292015-06-25 15:03:03 -07002317 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002318 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002319 if ($level eq 'ERROR') {
2320 $output .= RED;
2321 } elsif ($level eq 'WARNING') {
2322 $output .= YELLOW;
2323 } else {
2324 $output .= GREEN;
2325 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002326 }
Joe Perches57230292015-06-25 15:03:03 -07002327 $output .= $prefix . $level . ':';
2328 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002329 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002330 $output .= "$type:";
2331 }
John Brooks737c0762017-07-10 15:52:24 -07002332 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002333 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002334
2335 if ($showfile) {
2336 my @lines = split("\n", $output, -1);
2337 splice(@lines, 1, 1);
2338 $output = join("\n", @lines);
2339 }
Dwaipayan Ray52178ce2021-02-26 15:08:26 +05302340
2341 if ($terse) {
2342 $output = (split('\n', $output))[0] . "\n";
2343 }
2344
2345 if ($verbose && exists($verbose_messages{$type}) &&
2346 !exists($verbose_emitted{$type})) {
2347 $output .= $verbose_messages{$type} . "\n\n";
2348 $verbose_emitted{$type} = 1;
2349 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002350
Joe Perches57230292015-06-25 15:03:03 -07002351 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002352
2353 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002354}
Joe Perchescbec18a2014-04-03 14:49:19 -07002355
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002356sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002357 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002358}
Joe Perches000d1cc12011-07-25 17:13:25 -07002359
Joe Perchesd752fcc2014-08-06 16:11:05 -07002360sub fixup_current_range {
2361 my ($lineRef, $offset, $length) = @_;
2362
2363 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2364 my $o = $1;
2365 my $l = $2;
2366 my $no = $o + $offset;
2367 my $nl = $l + $length;
2368 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2369 }
2370}
2371
2372sub fix_inserted_deleted_lines {
2373 my ($linesRef, $insertedRef, $deletedRef) = @_;
2374
2375 my $range_last_linenr = 0;
2376 my $delta_offset = 0;
2377
2378 my $old_linenr = 0;
2379 my $new_linenr = 0;
2380
2381 my $next_insert = 0;
2382 my $next_delete = 0;
2383
2384 my @lines = ();
2385
2386 my $inserted = @{$insertedRef}[$next_insert++];
2387 my $deleted = @{$deletedRef}[$next_delete++];
2388
2389 foreach my $old_line (@{$linesRef}) {
2390 my $save_line = 1;
2391 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002392 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002393 $delta_offset = 0;
2394 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2395 $range_last_linenr = $new_linenr;
2396 fixup_current_range(\$line, $delta_offset, 0);
2397 }
2398
2399 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2400 $deleted = @{$deletedRef}[$next_delete++];
2401 $save_line = 0;
2402 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2403 }
2404
2405 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2406 push(@lines, ${$inserted}{'LINE'});
2407 $inserted = @{$insertedRef}[$next_insert++];
2408 $new_linenr++;
2409 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2410 }
2411
2412 if ($save_line) {
2413 push(@lines, $line);
2414 $new_linenr++;
2415 }
2416
2417 $old_linenr++;
2418 }
2419
2420 return @lines;
2421}
2422
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002423sub fix_insert_line {
2424 my ($linenr, $line) = @_;
2425
2426 my $inserted = {
2427 LINENR => $linenr,
2428 LINE => $line,
2429 };
2430 push(@fixed_inserted, $inserted);
2431}
2432
2433sub fix_delete_line {
2434 my ($linenr, $line) = @_;
2435
2436 my $deleted = {
2437 LINENR => $linenr,
2438 LINE => $line,
2439 };
2440
2441 push(@fixed_deleted, $deleted);
2442}
2443
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002444sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002445 my ($type, $msg) = @_;
2446
2447 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002448 our $clean = 0;
2449 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002450 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002451 }
Joe Perches3705ce52013-07-03 15:05:31 -07002452 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002453}
2454sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002455 my ($type, $msg) = @_;
2456
2457 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002458 our $clean = 0;
2459 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002460 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002461 }
Joe Perches3705ce52013-07-03 15:05:31 -07002462 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002463}
2464sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002465 my ($type, $msg) = @_;
2466
2467 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002468 our $clean = 0;
2469 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002470 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002471 }
Joe Perches3705ce52013-07-03 15:05:31 -07002472 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002473}
2474
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002475sub check_absolute_file {
2476 my ($absolute, $herecurr) = @_;
2477 my $file = $absolute;
2478
2479 ##print "absolute<$absolute>\n";
2480
2481 # See if any suffix of this path is a path within the tree.
2482 while ($file =~ s@^[^/]*/@@) {
2483 if (-f "$root/$file") {
2484 ##print "file<$file>\n";
2485 last;
2486 }
2487 }
2488 if (! -f _) {
2489 return 0;
2490 }
2491
2492 # It is, so see if the prefix is acceptable.
2493 my $prefix = $absolute;
2494 substr($prefix, -length($file)) = '';
2495
2496 ##print "prefix<$prefix>\n";
2497 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002498 WARN("USE_RELATIVE_PATH",
2499 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002500 }
2501}
2502
Joe Perches3705ce52013-07-03 15:05:31 -07002503sub trim {
2504 my ($string) = @_;
2505
Joe Perchesb34c6482013-09-11 14:24:01 -07002506 $string =~ s/^\s+|\s+$//g;
2507
2508 return $string;
2509}
2510
2511sub ltrim {
2512 my ($string) = @_;
2513
2514 $string =~ s/^\s+//;
2515
2516 return $string;
2517}
2518
2519sub rtrim {
2520 my ($string) = @_;
2521
2522 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002523
2524 return $string;
2525}
2526
Joe Perches52ea8502013-11-12 15:10:09 -08002527sub string_find_replace {
2528 my ($string, $find, $replace) = @_;
2529
2530 $string =~ s/$find/$replace/g;
2531
2532 return $string;
2533}
2534
Joe Perches3705ce52013-07-03 15:05:31 -07002535sub tabify {
2536 my ($leading) = @_;
2537
Antonio Borneo713a09d2020-04-06 20:11:07 -07002538 my $source_indent = $tabsize;
Joe Perches3705ce52013-07-03 15:05:31 -07002539 my $max_spaces_before_tab = $source_indent - 1;
2540 my $spaces_to_tab = " " x $source_indent;
2541
2542 #convert leading spaces to tabs
2543 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2544 #Remove spaces before a tab
2545 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2546
2547 return "$leading";
2548}
2549
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002550sub pos_last_openparen {
2551 my ($line) = @_;
2552
2553 my $pos = 0;
2554
2555 my $opens = $line =~ tr/\(/\(/;
2556 my $closes = $line =~ tr/\)/\)/;
2557
2558 my $last_openparen = 0;
2559
2560 if (($opens == 0) || ($closes >= $opens)) {
2561 return -1;
2562 }
2563
2564 my $len = length($line);
2565
2566 for ($pos = 0; $pos < $len; $pos++) {
2567 my $string = substr($line, $pos);
2568 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2569 $pos += length($1) - 1;
2570 } elsif (substr($line, $pos, 1) eq '(') {
2571 $last_openparen = $pos;
2572 } elsif (index($string, '(') == -1) {
2573 last;
2574 }
2575 }
2576
Joe Perches91cb5192014-04-03 14:49:32 -07002577 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002578}
2579
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002580sub get_raw_comment {
2581 my ($line, $rawline) = @_;
2582 my $comment = '';
2583
2584 for my $i (0 .. (length($line) - 1)) {
2585 if (substr($line, $i, 1) eq "$;") {
2586 $comment .= substr($rawline, $i, 1);
2587 }
2588 }
2589
2590 return $comment;
2591}
2592
Song Liu5b8f82e2021-02-25 17:22:08 -08002593sub exclude_global_initialisers {
2594 my ($realfile) = @_;
2595
2596 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
2597 return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ ||
2598 $realfile =~ m@^samples/bpf/.*_kern\.c$@ ||
2599 $realfile =~ m@/bpf/.*\.bpf\.c$@;
2600}
2601
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002602sub process {
2603 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002604
2605 my $linenr=0;
2606 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002607 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002608 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002609 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002610
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002611 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002612 my $indent;
2613 my $previndent=0;
2614 my $stashindent=0;
2615
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002616 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002617 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002618 my $author = '';
2619 my $authorsignoff = 0;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002620 my $author_sob = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002621 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002622 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002623 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002624 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches44d303e2020-04-06 20:11:10 -07002625 my $has_patch_separator = 0; #Found a --- line
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002626 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002627 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002628 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002629 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002630 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002631 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002632 my $non_utf8_charset = 0;
2633
Joe Perches4ce9f972021-09-07 19:59:57 -07002634 my $last_git_commit_id_linenr = -1;
2635
Joe Perches365dd4e2014-08-06 16:10:42 -07002636 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002637 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002638
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002639 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002640 our $cnt_lines = 0;
2641 our $cnt_error = 0;
2642 our $cnt_warn = 0;
2643 our $cnt_chk = 0;
2644
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002645 # Trace the real file/line as we go.
2646 my $realfile = '';
2647 my $realline = 0;
2648 my $realcnt = 0;
2649 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002650 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002651 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002652 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002653 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002654 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002655
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002656 my $prev_values = 'E';
2657
2658 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002659 my %suppress_ifbraces;
Andy Whitcroft170d3a222008-10-15 22:02:30 -07002660 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002661 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002662 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002663
Joe Perches7e51f192013-09-11 14:23:57 -07002664 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002665
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002666 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002667 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002668 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002669 my @setup_docs = ();
2670 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002671
Joe Perchesd8b07712013-11-12 15:10:06 -08002672 my $camelcase_file_seeded = 0;
2673
Rob Herring9f3a8992018-04-10 16:33:13 -07002674 my $checklicenseline = 1;
2675
Andy Whitcroft773647a2008-03-28 14:15:58 -07002676 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002677 my $line;
2678 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002679 $linenr++;
2680 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002681
Joe Perches3705ce52013-07-03 15:05:31 -07002682 push(@fixed, $rawline) if ($fix);
2683
Andy Whitcroft773647a2008-03-28 14:15:58 -07002684 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002685 $setup_docs = 0;
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07002686 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002687 $setup_docs = 1;
2688 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002689 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002690 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002691 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002692 $realline=$1-1;
2693 if (defined $2) {
2694 $realcnt=$3+1;
2695 } else {
2696 $realcnt=1+1;
2697 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002698 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002699
2700 # Guestimate if this is a continuing comment. Run
2701 # the context looking for a comment "edge". If this
2702 # edge is a close comment then we must be in a comment
2703 # at context start.
2704 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002705 my $cnt = $realcnt;
2706 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2707 next if (defined $rawlines[$ln - 1] &&
2708 $rawlines[$ln - 1] =~ /^-/);
2709 $cnt--;
2710 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002711 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002712 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2713 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2714 ($edge) = $1;
2715 last;
2716 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002717 }
2718 if (defined $edge && $edge eq '*/') {
2719 $in_comment = 1;
2720 }
2721
2722 # Guestimate if this is a continuing comment. If this
2723 # is the start of a diff block and this line starts
2724 # ' *' then it is very likely a comment.
2725 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002726 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002727 {
2728 $in_comment = 1;
2729 }
2730
2731 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2732 sanitise_line_reset($in_comment);
2733
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002734 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002735 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002736 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002737 $line = sanitise_line($rawline);
2738 }
2739 push(@lines, $line);
2740
2741 if ($realcnt > 1) {
2742 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2743 } else {
2744 $realcnt = 0;
2745 }
2746
2747 #print "==>$rawline\n";
2748 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002749
2750 if ($setup_docs && $line =~ /^\+/) {
2751 push(@setup_docs, $line);
2752 }
2753 }
2754
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002755 $prefix = '';
2756
Andy Whitcroft773647a2008-03-28 14:15:58 -07002757 $realcnt = 0;
2758 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002759 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002760 foreach my $line (@lines) {
2761 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002762 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002763 my $sline = $line; #copy of $line
2764 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002765
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002766 my $rawline = $rawlines[$linenr - 1];
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002767 my $raw_comment = get_raw_comment($line, $rawline);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002768
Joe Perches12c253ab2018-06-07 17:10:58 -07002769# check if it's a mode change, rename or start of a patch
2770 if (!$in_commit_log &&
2771 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2772 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2773 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2774 $is_patch = 1;
2775 }
2776
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002777#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002778 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002779 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2780 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002781 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002782 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002783 $realline=$1-1;
2784 if (defined $2) {
2785 $realcnt=$3+1;
2786 } else {
2787 $realcnt=1+1;
2788 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002789 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002790 $prev_values = 'E';
2791
Andy Whitcroft773647a2008-03-28 14:15:58 -07002792 %suppress_ifbraces = ();
Andy Whitcroft170d3a222008-10-15 22:02:30 -07002793 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002794 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002795 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002796 if ($context =~ /\b(\w+)\s*\(/) {
2797 $context_function = $1;
2798 } else {
2799 undef $context_function;
2800 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002801 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002802
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002803# track the line number as we move through the hunk, note that
2804# new versions of GNU diff omit the leading space on completely
2805# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002806 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002807 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002808 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002809
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002810 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002811 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002812
2813 # Track the previous line.
2814 ($prevline, $stashline) = ($stashline, $line);
2815 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002816 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2817
Andy Whitcroft773647a2008-03-28 14:15:58 -07002818 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002819
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002820 } elsif ($realcnt == 1) {
2821 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002822 }
2823
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002824 my $hunk_line = ($realcnt != 0);
2825
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002826 $here = "#$linenr: " if (!$file);
2827 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002828
Joe Perches2ac73b42014-06-04 16:12:05 -07002829 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002830 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002831 if ($line =~ /^diff --git.*?(\S+)$/) {
2832 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002833 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002834 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002835 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002836 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002837 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002838 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002839 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002840
2841 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002842 if (!$file && $tree && $p1_prefix ne '' &&
2843 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002844 WARN("PATCH_PREFIX",
2845 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002846 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002847
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002848 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002849 ERROR("MODIFIED_INCLUDE_ASM",
2850 "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 -07002851 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002852 $found_file = 1;
2853 }
2854
Joe Perches34d88152015-06-25 15:03:05 -07002855#make up the handle for any error we report on this line
2856 if ($showfile) {
2857 $prefix = "$realfile:$realline: "
2858 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002859 if ($file) {
2860 $prefix = "$filename:$realline: ";
2861 } else {
2862 $prefix = "$filename:$linenr: ";
2863 }
Joe Perches34d88152015-06-25 15:03:05 -07002864 }
2865
Joe Perches2ac73b42014-06-04 16:12:05 -07002866 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002867 if (is_maintained_obsolete($realfile)) {
2868 WARN("OBSOLETE",
2869 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2870 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002871 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002872 $check = 1;
2873 } else {
2874 $check = $check_orig;
2875 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002876 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002877
2878 if ($realfile !~ /^MAINTAINERS/) {
2879 my $last_binding_patch = $is_binding_patch;
2880
2881 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2882
2883 if (($last_binding_patch != -1) &&
2884 ($last_binding_patch ^ $is_binding_patch)) {
2885 WARN("DT_SPLIT_BINDING_PATCH",
Mauro Carvalho Chehab858e6842020-04-15 16:45:25 +02002886 "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 -07002887 }
2888 }
2889
Andy Whitcroft773647a2008-03-28 14:15:58 -07002890 next;
2891 }
2892
Randy Dunlap389834b2007-06-08 13:47:03 -07002893 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002894
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002895 my $hereline = "$here\n$rawline\n";
2896 my $herecurr = "$here\n$rawline\n";
2897 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002898
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002899 $cnt_lines++ if ($realcnt != 0);
2900
Joe Perches490b2922018-08-21 21:58:01 -07002901# Verify the existence of a commit log if appropriate
2902# 2 is used because a $signature is counted in $commit_log_lines
2903 if ($in_commit_log) {
2904 if ($line !~ /^\s*$/) {
2905 $commit_log_lines++; #could be a $signature
2906 }
2907 } elsif ($has_commit_log && $commit_log_lines < 2) {
2908 WARN("COMMIT_MESSAGE",
2909 "Missing commit description - Add an appropriate one\n");
2910 $commit_log_lines = 2; #warn only once
2911 }
2912
Joe Perchese518e9a2015-06-25 15:03:27 -07002913# Check if the commit log has what seems like a diff which can confuse patch
2914 if ($in_commit_log && !$commit_log_has_diff &&
Mrinal Pandey13e45412020-09-04 16:35:52 -07002915 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
2916 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
Joe Perchese518e9a2015-06-25 15:03:27 -07002917 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2918 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2919 ERROR("DIFF_IN_COMMIT_MSG",
2920 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2921 $commit_log_has_diff = 1;
2922 }
2923
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002924# Check for incorrect file permissions
2925 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2926 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002927 if ($realfile !~ m@scripts/@ &&
2928 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002929 ERROR("EXECUTE_PERMISSIONS",
2930 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002931 }
2932 }
2933
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002934# Check the patch for a From:
2935 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2936 $author = $1;
Dwaipayan Raye7f929f2020-10-15 20:12:15 -07002937 my $curline = $linenr;
2938 while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) {
2939 $author .= $1;
2940 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002941 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2942 $author =~ s/"//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07002943 $author = reformat_email($author);
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002944 }
2945
Joe Perches20112472011-07-25 17:13:23 -07002946# Check the patch for a signoff:
Joe Perchesdfa05c22020-04-06 20:10:48 -07002947 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002948 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002949 $in_commit_log = 0;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002950 if ($author ne '' && $authorsignoff != 1) {
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08002951 if (same_email_addresses($1, $author)) {
Joe Perchesdfa05c22020-04-06 20:10:48 -07002952 $authorsignoff = 1;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002953 } else {
2954 my $ctx = $1;
2955 my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
2956 my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);
2957
Mimi Zohar046fc742021-09-07 19:59:54 -07002958 if (lc $email_address eq lc $author_address && $email_name eq $author_name) {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002959 $author_sob = $ctx;
2960 $authorsignoff = 2;
Mimi Zohar046fc742021-09-07 19:59:54 -07002961 } elsif (lc $email_address eq lc $author_address) {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002962 $author_sob = $ctx;
2963 $authorsignoff = 3;
2964 } elsif ($email_name eq $author_name) {
2965 $author_sob = $ctx;
2966 $authorsignoff = 4;
2967
2968 my $address1 = $email_address;
2969 my $address2 = $author_address;
2970
2971 if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
2972 $address1 = "$1$2";
2973 }
2974 if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
2975 $address2 = "$1$2";
2976 }
2977 if ($address1 eq $address2) {
2978 $authorsignoff = 5;
2979 }
2980 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002981 }
2982 }
Joe Perches20112472011-07-25 17:13:23 -07002983 }
2984
Joe Perches44d303e2020-04-06 20:11:10 -07002985# Check for patch separator
2986 if ($line =~ /^---$/) {
2987 $has_patch_separator = 1;
2988 $in_commit_log = 0;
2989 }
2990
Joe Perchese0d975b2014-12-10 15:51:49 -08002991# Check if MAINTAINERS is being updated. If so, there's probably no need to
2992# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2993 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2994 $reported_maintainer_file = 1;
2995 }
2996
Joe Perches20112472011-07-25 17:13:23 -07002997# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002998 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002999 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07003000 my $space_before = $1;
3001 my $sign_off = $2;
3002 my $space_after = $3;
3003 my $email = $4;
3004 my $ucfirst_sign_off = ucfirst(lc($sign_off));
3005
Joe Perchesce0338df3c2012-07-30 14:41:18 -07003006 if ($sign_off !~ /$signature_tags/) {
Aditya Srivastava831242a2020-12-15 20:45:12 -08003007 my $suggested_signature = find_standard_signature($sign_off);
3008 if ($suggested_signature eq "") {
3009 WARN("BAD_SIGN_OFF",
3010 "Non-standard signature: $sign_off\n" . $herecurr);
3011 } else {
3012 if (WARN("BAD_SIGN_OFF",
3013 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) &&
3014 $fix) {
3015 $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/;
3016 }
3017 }
Joe Perchesce0338df3c2012-07-30 14:41:18 -07003018 }
Joe Perches20112472011-07-25 17:13:23 -07003019 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07003020 if (WARN("BAD_SIGN_OFF",
3021 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
3022 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003023 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07003024 "$ucfirst_sign_off $email";
3025 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003026 }
Joe Perches20112472011-07-25 17:13:23 -07003027 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07003028 if (WARN("BAD_SIGN_OFF",
3029 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
3030 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003031 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07003032 "$ucfirst_sign_off $email";
3033 }
3034
Joe Perches20112472011-07-25 17:13:23 -07003035 }
3036 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07003037 if (WARN("BAD_SIGN_OFF",
3038 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
3039 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003040 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07003041 "$ucfirst_sign_off $email";
3042 }
Joe Perches20112472011-07-25 17:13:23 -07003043 }
3044
Joe Perchesdfa05c22020-04-06 20:10:48 -07003045 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07003046 my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment));
Joe Perches20112472011-07-25 17:13:23 -07003047 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07003048 ERROR("BAD_SIGN_OFF",
3049 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07003050 } else {
3051 my $dequoted = $suggested_email;
3052 $dequoted =~ s/^"//;
3053 $dequoted =~ s/" </ </;
3054 # Don't force email to have quotes
3055 # Allow just an angle bracketed address
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08003056 if (!same_email_addresses($email, $suggested_email)) {
3057 if (WARN("BAD_SIGN_OFF",
3058 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) &&
3059 $fix) {
3060 $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/;
3061 }
3062 }
3063
3064 # Address part shouldn't have comments
3065 my $stripped_address = $email_address;
3066 $stripped_address =~ s/\([^\(\)]*\)//g;
3067 if ($email_address ne $stripped_address) {
3068 if (WARN("BAD_SIGN_OFF",
3069 "address part of email should not have comments: '$email_address'\n" . $herecurr) &&
3070 $fix) {
3071 $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/;
3072 }
3073 }
3074
3075 # Only one name comment should be allowed
3076 my $comment_count = () = $name_comment =~ /\([^\)]+\)/g;
3077 if ($comment_count > 1) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003078 WARN("BAD_SIGN_OFF",
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08003079 "Use a single name comment in email: '$email'\n" . $herecurr);
3080 }
3081
3082
3083 # stable@vger.kernel.org or stable@kernel.org shouldn't
Dwaipayan Raye73d2712020-12-15 20:44:56 -08003084 # have an email name. In addition comments should strictly
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08003085 # begin with a #
3086 if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) {
3087 if (($comment ne "" && $comment !~ /^#.+/) ||
3088 ($email_name ne "")) {
3089 my $cur_name = $email_name;
3090 my $new_comment = $comment;
3091 $cur_name =~ s/[a-zA-Z\s\-\"]+//g;
3092
3093 # Remove brackets enclosing comment text
3094 # and # from start of comments to get comment text
3095 $new_comment =~ s/^\((.*)\)$/$1/;
3096 $new_comment =~ s/^\[(.*)\]$/$1/;
3097 $new_comment =~ s/^[\s\#]+|\s+$//g;
3098
3099 $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment);
3100 $new_comment = " # $new_comment" if ($new_comment ne "");
3101 my $new_email = "$email_address$new_comment";
3102
3103 if (WARN("BAD_STABLE_ADDRESS_STYLE",
3104 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) &&
3105 $fix) {
3106 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3107 }
3108 }
3109 } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) {
3110 my $new_comment = $comment;
3111
3112 # Extract comment text from within brackets or
3113 # c89 style /*...*/ comments
3114 $new_comment =~ s/^\[(.*)\]$/$1/;
3115 $new_comment =~ s/^\/\*(.*)\*\/$/$1/;
3116
3117 $new_comment = trim($new_comment);
3118 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
3119 $new_comment = "($new_comment)" if ($new_comment ne "");
3120 my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment);
3121
3122 if (WARN("BAD_SIGN_OFF",
3123 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) &&
3124 $fix) {
3125 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3126 }
Joe Perches20112472011-07-25 17:13:23 -07003127 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003128 }
Joe Perches7e51f192013-09-11 14:23:57 -07003129
3130# Check for duplicate signatures
3131 my $sig_nospace = $line;
3132 $sig_nospace =~ s/\s//g;
3133 $sig_nospace = lc($sig_nospace);
3134 if (defined $signatures{$sig_nospace}) {
3135 WARN("BAD_SIGN_OFF",
3136 "Duplicate signature\n" . $herecurr);
3137 } else {
3138 $signatures{$sig_nospace} = 1;
3139 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07003140
3141# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
3142 if ($sign_off =~ /^co-developed-by:$/i) {
3143 if ($email eq $author) {
3144 WARN("BAD_SIGN_OFF",
3145 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
3146 }
3147 if (!defined $lines[$linenr]) {
3148 WARN("BAD_SIGN_OFF",
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08003149 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07003150 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
3151 WARN("BAD_SIGN_OFF",
3152 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3153 } elsif ($1 ne $email) {
3154 WARN("BAD_SIGN_OFF",
3155 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3156 }
3157 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003158 }
3159
Niklas Söderlundbd17e032022-09-14 12:02:55 +02003160# Check Fixes: styles is correct
3161 if (!$in_header_lines &&
3162 $line =~ /^\s*fixes:?\s*(?:commit\s*)?[0-9a-f]{5,}\b/i) {
3163 my $orig_commit = "";
3164 my $id = "0123456789ab";
3165 my $title = "commit title";
3166 my $tag_case = 1;
3167 my $tag_space = 1;
3168 my $id_length = 1;
3169 my $id_case = 1;
3170 my $title_has_quotes = 0;
3171
3172 if ($line =~ /(\s*fixes:?)\s+([0-9a-f]{5,})\s+($balanced_parens)/i) {
3173 my $tag = $1;
3174 $orig_commit = $2;
3175 $title = $3;
3176
3177 $tag_case = 0 if $tag eq "Fixes:";
3178 $tag_space = 0 if ($line =~ /^fixes:? [0-9a-f]{5,} ($balanced_parens)/i);
3179
3180 $id_length = 0 if ($orig_commit =~ /^[0-9a-f]{12}$/i);
3181 $id_case = 0 if ($orig_commit !~ /[A-F]/);
3182
3183 # Always strip leading/trailing parens then double quotes if existing
3184 $title = substr($title, 1, -1);
3185 if ($title =~ /^".*"$/) {
3186 $title = substr($title, 1, -1);
3187 $title_has_quotes = 1;
3188 }
3189 }
3190
3191 my ($cid, $ctitle) = git_commit_info($orig_commit, $id,
3192 $title);
3193
3194 if ($ctitle ne $title || $tag_case || $tag_space ||
3195 $id_length || $id_case || !$title_has_quotes) {
3196 if (WARN("BAD_FIXES_TAG",
3197 "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) &&
3198 $fix) {
3199 $fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")";
3200 }
3201 }
3202 }
3203
Joe Perchesa2fe16b2015-02-13 14:39:02 -08003204# Check email subject for common tools that don't need to be mentioned
3205 if ($in_header_lines &&
3206 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
3207 WARN("EMAIL_SUBJECT",
3208 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
3209 }
3210
Joe Perches44d303e2020-04-06 20:11:10 -07003211# Check for Gerrit Change-Ids not in any patch context
3212 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Aditya Srivastava7580c5b2020-12-15 20:44:47 -08003213 if (ERROR("GERRIT_CHANGE_ID",
3214 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
3215 $fix) {
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08003216 fix_delete_line($fixlinenr, $rawline);
3217 }
Christopher Covington7ebd05e2014-04-03 14:49:31 -07003218 }
3219
Joe Perches369c8dd2015-11-06 16:31:34 -08003220# Check if the commit log is in a possible stack dump
3221 if ($in_commit_log && !$commit_log_possible_stack_dump &&
3222 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
3223 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
3224 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07003225 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
3226 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
3227 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
3228 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08003229 $commit_log_possible_stack_dump = 1;
3230 }
3231
Joe Perches2a076f42015-04-16 12:44:28 -07003232# Check for line lengths > 75 in commit log, warn once
3233 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08003234 length($line) > 75 &&
3235 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
3236 # file delta changes
Jerome Forissier36f8b342022-01-19 18:09:31 -08003237 $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ ||
Joe Perches369c8dd2015-11-06 16:31:34 -08003238 # filename then :
Aditya Srivastava27b379a2020-12-15 20:44:59 -08003239 $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
3240 # A Fixes: or Link: line or signature tag line
Joe Perches369c8dd2015-11-06 16:31:34 -08003241 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07003242 WARN("COMMIT_LOG_LONG_LINE",
3243 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
3244 $commit_log_long_line = 1;
3245 }
3246
Joe Perchesbf4daf12015-09-09 15:37:50 -07003247# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08003248 if ($in_commit_log && $commit_log_possible_stack_dump &&
3249 $line =~ /^\s*$/) {
3250 $commit_log_possible_stack_dump = 0;
3251 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07003252
Dwaipayan Ray084a6172020-12-15 20:45:18 -08003253# Check for lines starting with a #
3254 if ($in_commit_log && $line =~ /^#/) {
3255 if (WARN("COMMIT_COMMENT_SYMBOL",
3256 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
3257 $fix) {
3258 $fixed[$fixlinenr] =~ s/^/ /;
3259 }
3260 }
3261
Joe Perches0d7835f2015-02-13 14:38:35 -08003262# Check for git id commit length and improperly formed commit descriptions
Joe Perches4ce9f972021-09-07 19:59:57 -07003263# A correctly formed commit description is:
3264# commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
3265# with the commit subject '("' prefix and '")' suffix
3266# This is a fairly compilicated block as it tests for what appears to be
3267# bare SHA-1 hash with minimum length of 5. It also avoids several types of
3268# possible SHA-1 matches.
3269# A commit match can span multiple lines so this block attempts to find a
3270# complete typical commit on a maximum of 3 lines
3271 if ($perl_version_ok &&
3272 $in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07003273 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07003274 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perches4ce9f972021-09-07 19:59:57 -07003275 (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
3276 ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) ||
Joe Perchesaab38f52016-08-02 14:04:36 -07003277 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08003278 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
3279 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07003280 my $init_char = "c";
3281 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08003282 my $short = 1;
3283 my $long = 0;
3284 my $case = 1;
3285 my $space = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08003286 my $id = '0123456789ab';
3287 my $orig_desc = "commit description";
3288 my $description = "";
Joe Perches4ce9f972021-09-07 19:59:57 -07003289 my $herectx = $herecurr;
3290 my $has_parens = 0;
3291 my $has_quotes = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08003292
Joe Perches4ce9f972021-09-07 19:59:57 -07003293 my $input = $line;
3294 if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) {
3295 for (my $n = 0; $n < 2; $n++) {
3296 if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) {
3297 $orig_desc = $1;
3298 $has_parens = 1;
3299 # Always strip leading/trailing parens then double quotes if existing
3300 $orig_desc = substr($orig_desc, 1, -1);
3301 if ($orig_desc =~ /^".*"$/) {
3302 $orig_desc = substr($orig_desc, 1, -1);
3303 $has_quotes = 1;
3304 }
3305 last;
3306 }
3307 last if ($#lines < $linenr + $n);
3308 $input .= " " . trim($rawlines[$linenr + $n]);
3309 $herectx .= "$rawlines[$linenr + $n]\n";
3310 }
3311 $herectx = $herecurr if (!$has_parens);
Joe Perchesfe043ea2015-09-09 15:37:25 -07003312 }
3313
Joe Perches4ce9f972021-09-07 19:59:57 -07003314 if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
3315 $init_char = $1;
3316 $orig_commit = lc($2);
3317 $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i);
3318 $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i);
3319 $space = 0 if ($input =~ /\bcommit [0-9a-f]/i);
3320 $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
3321 } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) {
3322 $orig_commit = lc($1);
Joe Perches0d7835f2015-02-13 14:38:35 -08003323 }
3324
3325 ($id, $description) = git_commit_info($orig_commit,
3326 $id, $orig_desc);
3327
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07003328 if (defined($id) &&
Joe Perches4ce9f972021-09-07 19:59:57 -07003329 ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) &&
3330 $last_git_commit_id_linenr != $linenr - 1) {
Joe Perches0d7835f2015-02-13 14:38:35 -08003331 ERROR("GIT_COMMIT_ID",
Joe Perches4ce9f972021-09-07 19:59:57 -07003332 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx);
Joe Perches0d7835f2015-02-13 14:38:35 -08003333 }
Joe Perches4ce9f972021-09-07 19:59:57 -07003334 #don't report the next line if this line ends in commit and the sha1 hash is the next line
3335 $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i);
Joe Perchesd311cd42014-08-06 16:10:57 -07003336 }
3337
Bjorn Helgaas9b71f792022-10-19 15:28:43 -05003338# Check for mailing list archives other than lore.kernel.org
3339 if ($rawline =~ m{http.*\b$obsolete_archives}) {
3340 WARN("PREFER_LORE_ARCHIVE",
3341 "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr);
3342 }
3343
Joe Perches13f19372014-08-06 16:10:59 -07003344# Check for added, moved or deleted files
3345 if (!$reported_maintainer_file && !$in_commit_log &&
3346 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
3347 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
3348 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
3349 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08003350 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07003351 $reported_maintainer_file = 1;
3352 WARN("FILE_PATH_CHANGES",
3353 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
3354 }
3355
Rob Herringe400edb2019-09-12 15:18:20 +01003356# Check for adding new DT bindings not in schema format
3357 if (!$in_commit_log &&
3358 ($line =~ /^new file mode\s*\d+\s*$/) &&
3359 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
3360 WARN("DT_SCHEMA_BINDING_PATCH",
Mauro Carvalho Chehab56ddc4c2021-04-01 14:17:49 +02003361 "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
Rob Herringe400edb2019-09-12 15:18:20 +01003362 }
3363
Andy Whitcroft00df3442007-06-08 13:47:06 -07003364# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08003365 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003366 ERROR("CORRUPTED_PATCH",
3367 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003368 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003369 }
3370
3371# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3372 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003373 $rawline !~ m/^$UTF8*$/) {
3374 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3375
3376 my $blank = copy_spacing($rawline);
3377 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3378 my $hereptr = "$hereline$ptr\n";
3379
Joe Perches34d99212011-07-25 17:13:26 -07003380 CHK("INVALID_UTF8",
3381 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003382 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003383
Joe Perches15662b32011-10-31 17:13:12 -07003384# Check if it's the start of a commit log
3385# (not a header line and we haven't seen the patch filename)
3386 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07003387 !($rawline =~ /^\s+(?:\S|$)/ ||
3388 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07003389 $in_header_lines = 0;
3390 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07003391 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07003392 }
3393
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003394# Check if there is UTF-8 in a commit log when a mail header has explicitly
3395# declined it, i.e defined some charset where it is missing.
3396 if ($in_header_lines &&
3397 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3398 $1 !~ /utf-8/i) {
3399 $non_utf8_charset = 1;
3400 }
3401
3402 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07003403 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003404 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07003405 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3406 }
3407
Joe Perchesd6430f72016-12-12 16:46:28 -08003408# Check for absolute kernel paths in commit message
3409 if ($tree && $in_commit_log) {
3410 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3411 my $file = $1;
3412
3413 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3414 check_absolute_file($1, $herecurr)) {
3415 #
3416 } else {
3417 check_absolute_file($file, $herecurr);
3418 }
3419 }
3420 }
3421
Kees Cook66b47b42014-10-13 15:51:57 -07003422# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07003423 if (defined($misspellings) &&
3424 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Dwaipayan Ray7da07c32020-12-15 20:45:21 -08003425 while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07003426 my $typo = $1;
Dwaipayan Ray7da07c32020-12-15 20:45:21 -08003427 my $blank = copy_spacing($rawline);
3428 my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
3429 my $hereptr = "$hereline$ptr\n";
Kees Cook66b47b42014-10-13 15:51:57 -07003430 my $typo_fix = $spelling_fix{lc($typo)};
3431 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3432 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07003433 my $msg_level = \&WARN;
3434 $msg_level = \&CHK if ($file);
3435 if (&{$msg_level}("TYPO_SPELLING",
Dwaipayan Ray7da07c32020-12-15 20:45:21 -08003436 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07003437 $fix) {
3438 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3439 }
3440 }
3441 }
3442
Matteo Crocea8dd86b2019-09-25 16:46:38 -07003443# check for invalid commit id
3444 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3445 my $id;
3446 my $description;
3447 ($id, $description) = git_commit_info($2, undef, undef);
3448 if (!defined($id)) {
3449 WARN("UNKNOWN_COMMIT_ID",
3450 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3451 }
3452 }
3453
Joe Perches310cd062020-10-15 20:11:52 -07003454# check for repeated words separated by a single space
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003455# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3456 if (($rawline =~ /^\+/ || $in_commit_log) &&
3457 $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003458 pos($rawline) = 1 if (!$in_commit_log);
Joe Perches310cd062020-10-15 20:11:52 -07003459 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3460
3461 my $first = $1;
3462 my $second = $2;
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003463 my $start_pos = $-[1];
3464 my $end_pos = $+[2];
Joe Perches310cd062020-10-15 20:11:52 -07003465 if ($first =~ /(?:struct|union|enum)/) {
3466 pos($rawline) += length($first) + length($second) + 1;
3467 next;
3468 }
3469
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003470 next if (lc($first) ne lc($second));
Joe Perches310cd062020-10-15 20:11:52 -07003471 next if ($first eq 'long');
3472
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003473 # check for character before and after the word matches
3474 my $start_char = '';
3475 my $end_char = '';
3476 $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
3477 $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
3478
3479 next if ($start_char =~ /^\S$/);
3480 next if (index(" \t.,;?!", $end_char) == -1);
3481
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08003482 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3483 if ($first =~ /\b[0-9a-f]{2,}\b/i) {
3484 next if (!exists($allow_repeated_words{lc($first)}));
3485 }
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003486
Joe Perches310cd062020-10-15 20:11:52 -07003487 if (WARN("REPEATED_WORD",
3488 "Possible repeated word: '$first'\n" . $herecurr) &&
3489 $fix) {
3490 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3491 }
3492 }
3493
3494 # if it's a repeated word on consecutive lines in a comment block
3495 if ($prevline =~ /$;+\s*$/ &&
3496 $prevrawline =~ /($word_pattern)\s*$/) {
3497 my $last_word = $1;
3498 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3499 if (WARN("REPEATED_WORD",
3500 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3501 $fix) {
3502 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3503 }
3504 }
3505 }
3506 }
3507
Andy Whitcroft306708542008-10-15 22:02:28 -07003508# ignore non-hunk lines and lines being removed
3509 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003510
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003511#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003512 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003513 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07003514 if (ERROR("DOS_LINE_ENDINGS",
3515 "DOS line endings\n" . $herevet) &&
3516 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003517 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003518 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003519 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3520 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003521 if (ERROR("TRAILING_WHITESPACE",
3522 "trailing whitespace\n" . $herevet) &&
3523 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003524 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07003525 }
3526
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003527 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003528 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07003529
Josh Triplett4783f892013-11-12 15:10:12 -08003530# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08003531 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08003532 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08003533 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3534 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003535 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003536 my $msg_level = \&ERROR;
3537 $msg_level = \&CHK if ($file);
3538 &{$msg_level}("FSF_MAILING_ADDRESS",
3539 "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 -08003540 }
3541
Andi Kleen33549572010-05-24 14:33:29 -07003542# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003543# Only applies when adding the entry originally, after that we do not have
3544# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003545 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003546 # 'choice' is usually the last thing on the line (though
3547 # Kconfig supports named choices), so use a word boundary
3548 # (\b) rather than a whitespace character (\s)
3549 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Joe Perchesb8709bc2022-01-19 18:09:34 -08003550 my $ln = $linenr;
3551 my $needs_help = 0;
3552 my $has_help = 0;
3553 my $help_length = 0;
3554 while (defined $lines[$ln]) {
3555 my $f = $lines[$ln++];
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003556
3557 next if ($f =~ /^-/);
Joe Perchesb8709bc2022-01-19 18:09:34 -08003558 last if ($f !~ /^[\+ ]/); # !patch context
Andy Whitcrofta1385802012-01-10 15:10:03 -08003559
Joe Perchesb8709bc2022-01-19 18:09:34 -08003560 if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3561 $needs_help = 1;
3562 next;
3563 }
3564 if ($f =~ /^\+\s*help\s*$/) {
3565 $has_help = 1;
3566 next;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003567 }
3568
Joe Perchesb8709bc2022-01-19 18:09:34 -08003569 $f =~ s/^.//; # strip patch context [+ ]
3570 $f =~ s/#.*//; # strip # directives
3571 $f =~ s/^\s+//; # strip leading blanks
3572 next if ($f =~ /^$/); # skip blank lines
Ulf Magnusson678ae162018-02-16 21:22:54 +01003573
Joe Perchesb8709bc2022-01-19 18:09:34 -08003574 # At the end of this Kconfig block:
Ulf Magnusson678ae162018-02-16 21:22:54 +01003575 # This only checks context lines in the patch
3576 # and so hopefully shouldn't trigger false
3577 # positives, even though some of these are
3578 # common words in help texts
Joe Perchesb8709bc2022-01-19 18:09:34 -08003579 if ($f =~ /^(?:config|menuconfig|choice|endchoice|
3580 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003581 last;
3582 }
Joe Perchesb8709bc2022-01-19 18:09:34 -08003583 $help_length++ if ($has_help);
Andi Kleen33549572010-05-24 14:33:29 -07003584 }
Joe Perchesb8709bc2022-01-19 18:09:34 -08003585 if ($needs_help &&
3586 $help_length < $min_conf_desc_length) {
3587 my $stat_real = get_stat_real($linenr, $ln - 1);
Vadim Bendebury56193272014-10-13 15:51:48 -07003588 WARN("CONFIG_DESCRIPTION",
Joe Perchesb8709bc2022-01-19 18:09:34 -08003589 "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n");
Vadim Bendebury56193272014-10-13 15:51:48 -07003590 }
Andi Kleen33549572010-05-24 14:33:29 -07003591 }
3592
Joe Perches7ccf41a2020-06-04 16:50:33 -07003593# check MAINTAINERS entries
3594 if ($realfile =~ /^MAINTAINERS$/) {
3595# check MAINTAINERS entries for the right form
3596 if ($rawline =~ /^\+[A-Z]:/ &&
3597 $rawline !~ /^\+[A-Z]:\t\S/) {
3598 if (WARN("MAINTAINERS_STYLE",
3599 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3600 $fix) {
3601 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3602 }
3603 }
3604# check MAINTAINERS entries for the right ordering too
3605 my $preferred_order = 'MRLSWQBCPTFXNK';
3606 if ($rawline =~ /^\+[A-Z]:/ &&
3607 $prevrawline =~ /^[\+ ][A-Z]:/) {
3608 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3609 my $cur = $1;
3610 my $curval = $2;
3611 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3612 my $prev = $1;
3613 my $prevval = $2;
3614 my $curindex = index($preferred_order, $cur);
3615 my $previndex = index($preferred_order, $prev);
3616 if ($curindex < 0) {
3617 WARN("MAINTAINERS_STYLE",
3618 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3619 } else {
3620 if ($previndex >= 0 && $curindex < $previndex) {
3621 WARN("MAINTAINERS_STYLE",
3622 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3623 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3624 ($prev eq 'X' && $cur eq 'X')) &&
3625 ($prevval cmp $curval) > 0) {
3626 WARN("MAINTAINERS_STYLE",
3627 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3628 }
3629 }
Joe Perches628f91a2017-07-10 15:52:07 -07003630 }
3631 }
3632
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003633 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3634 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3635 my $flag = $1;
3636 my $replacement = {
3637 'EXTRA_AFLAGS' => 'asflags-y',
3638 'EXTRA_CFLAGS' => 'ccflags-y',
3639 'EXTRA_CPPFLAGS' => 'cppflags-y',
3640 'EXTRA_LDFLAGS' => 'ldflags-y',
3641 };
3642
3643 WARN("DEPRECATED_VARIABLE",
3644 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3645 }
3646
Rob Herringbff5da42014-01-23 15:54:51 -08003647# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003648 if (defined $root &&
3649 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3650 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3651
Rob Herringbff5da42014-01-23 15:54:51 -08003652 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3653
Florian Vaussardcc933192014-04-03 14:49:27 -07003654 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003655 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003656
Rob Herringbff5da42014-01-23 15:54:51 -08003657 foreach my $compat (@compats) {
3658 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003659 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3660 my $compat3 = $compat;
3661 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3662 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003663 if ( $? >> 8 ) {
3664 WARN("UNDOCUMENTED_DT_STRING",
3665 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3666 }
3667
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003668 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3669 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003670 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003671 if ( $? >> 8 ) {
3672 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003673 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003674 }
3675 }
3676 }
3677
Rob Herring9f3a8992018-04-10 16:33:13 -07003678# check for using SPDX license tag at beginning of files
3679 if ($realline == $checklicenseline) {
3680 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3681 $checklicenseline = 2;
3682 } elsif ($rawline =~ /^\+/) {
3683 my $comment = "";
3684 if ($realfile =~ /\.(h|s|S)$/) {
3685 $comment = '/*';
Miguel Ojedad1d84b52022-05-22 17:22:58 +02003686 } elsif ($realfile =~ /\.(c|rs|dts|dtsi)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003687 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003688 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003689 $comment = '#';
3690 } elsif ($realfile =~ /\.rst$/) {
3691 $comment = '..';
3692 }
3693
Joe Perchesfdf13692019-03-07 16:28:32 -08003694# check SPDX comment style for .[chsS] files
3695 if ($realfile =~ /\.[chsS]$/ &&
3696 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003697 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003698 WARN("SPDX_LICENSE_TAG",
3699 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3700 }
3701
Rob Herring9f3a8992018-04-10 16:33:13 -07003702 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003703 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3704 WARN("SPDX_LICENSE_TAG",
3705 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003706 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003707 my $spdx_license = $1;
3708 if (!is_SPDX_License_valid($spdx_license)) {
3709 WARN("SPDX_LICENSE_TAG",
3710 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3711 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003712 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3713 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3714 my $msg_level = \&WARN;
3715 $msg_level = \&CHK if ($file);
3716 if (&{$msg_level}("SPDX_LICENSE_TAG",
3717
3718 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3719 $fix) {
3720 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3721 }
3722 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003723 }
3724 }
3725 }
3726
Joe Perchesa0154cd2020-10-15 20:12:19 -07003727# check for embedded filenames
3728 if ($rawline =~ /^\+.*\Q$realfile\E/) {
3729 WARN("EMBEDDED_FILENAME",
3730 "It's generally not useful to have the filename in the file\n" . $herecurr);
3731 }
3732
Andy Whitcroft5368df202008-10-15 22:02:27 -07003733# check we are in a valid source file if not then ignore this hunk
Miguel Ojedad1d84b52022-05-22 17:22:58 +02003734 next if ($realfile !~ /\.(h|c|rs|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003735
Joe Perchesa8da38a2019-03-07 16:28:42 -08003736# check for using SPDX-License-Identifier on the wrong line number
3737 if ($realline != $checklicenseline &&
3738 $rawline =~ /\bSPDX-License-Identifier:/ &&
3739 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3740 WARN("SPDX_LICENSE_TAG",
3741 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3742 }
3743
Joe Perches47e0c882015-06-25 15:02:57 -07003744# line length limit (with some exclusions)
3745#
3746# There are a few types of lines that may extend beyond $max_line_length:
3747# logging functions like pr_info that end in a string
3748# lines with a single string
3749# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003750# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003751#
3752# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003753# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003754# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3755# LONG_LINE all other lines longer than $max_line_length
3756#
3757# if LONG_LINE is ignored, the other 2 types are also ignored
3758#
3759
Joe Perchesb4749e92015-07-17 16:24:01 -07003760 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003761 my $msg_type = "LONG_LINE";
3762
3763 # Check the allowed long line types first
3764
3765 # logging functions that end in a string that starts
3766 # before $max_line_length
3767 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3768 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3769 $msg_type = "";
3770
3771 # lines with only strings (w/ possible termination)
3772 # #defines with only strings
3773 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3774 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3775 $msg_type = "";
3776
Joe Perchescc147502017-11-17 15:28:44 -08003777 # More special cases
3778 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3779 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003780 $msg_type = "";
3781
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003782 # URL ($rawline is used in case the URL is in a comment)
3783 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3784 $msg_type = "";
3785
Joe Perches47e0c882015-06-25 15:02:57 -07003786 # Otherwise set the alternate message types
3787
3788 # a comment starts before $max_line_length
3789 } elsif ($line =~ /($;[\s$;]*)$/ &&
3790 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3791 $msg_type = "LONG_LINE_COMMENT"
3792
3793 # a quoted string starts before $max_line_length
3794 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3795 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3796 $msg_type = "LONG_LINE_STRING"
3797 }
3798
3799 if ($msg_type ne "" &&
3800 (show_type("LONG_LINE") || show_type($msg_type))) {
Joe Perchesbdc48fa2020-05-29 16:12:21 -07003801 my $msg_level = \&WARN;
3802 $msg_level = \&CHK if ($file);
3803 &{$msg_level}($msg_type,
3804 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Joe Perches47e0c882015-06-25 15:02:57 -07003805 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003806 }
3807
Andy Whitcroft8905a672007-11-28 16:21:06 -08003808# check for adding lines without a newline.
3809 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Tom Rix47ca69b2020-12-15 20:44:40 -08003810 if (WARN("MISSING_EOF_NEWLINE",
3811 "adding a line without newline at end of file\n" . $herecurr) &&
3812 $fix) {
3813 fix_delete_line($fixlinenr+1, "No newline at end of file");
3814 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003815 }
3816
Aditya Srivastavade932452021-02-25 17:21:57 -08003817# check for .L prefix local symbols in .S files
3818 if ($realfile =~ /\.S$/ &&
3819 $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {
3820 WARN("AVOID_L_PREFIX",
Jonathan Corbetf4bf1cd2022-09-27 10:05:57 -06003821 "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/core-api/asm-annotations.rst\n" . $herecurr);
Aditya Srivastavade932452021-02-25 17:21:57 -08003822 }
3823
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003824# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003825 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003826
3827# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003828# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003829 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3830 $rawline =~ /^\+\s* \s*/) {
3831 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003832 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003833 if (ERROR("CODE_INDENT",
3834 "code indent should use tabs where possible\n" . $herevet) &&
3835 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003836 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003837 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003838 }
3839
Alberto Panizzo08e44362010-03-05 13:43:54 -08003840# check for space before tabs.
3841 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3842 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003843 if (WARN("SPACE_BEFORE_TAB",
3844 "please, no space before tabs\n" . $herevet) &&
3845 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003846 while ($fixed[$fixlinenr] =~
Antonio Borneo713a09d2020-04-06 20:11:07 -07003847 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003848 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003849 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003850 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003851 }
3852
Joe Perches6a487212018-04-10 16:34:04 -07003853# check for assignments on the start of a line
3854 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
Aditya Srivastavada7355a2020-12-15 20:45:06 -08003855 my $operator = $1;
3856 if (CHK("ASSIGNMENT_CONTINUATIONS",
3857 "Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
3858 $fix && $prevrawline =~ /^\+/) {
3859 # add assignment operator to the previous line, remove from current line
3860 $fixed[$fixlinenr - 1] .= " $operator";
3861 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3862 }
Joe Perches6a487212018-04-10 16:34:04 -07003863 }
3864
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003865# check for && or || at the start of a line
3866 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
Aditya Srivastava8e08f072020-12-15 20:45:09 -08003867 my $operator = $1;
3868 if (CHK("LOGICAL_CONTINUATIONS",
3869 "Logical continuations should be on the previous line\n" . $hereprev) &&
3870 $fix && $prevrawline =~ /^\+/) {
3871 # insert logical operator at last non-comment, non-whitepsace char on previous line
3872 $prevline =~ /[\s$;]*$/;
3873 my $line_end = substr($prevrawline, $-[0]);
3874 $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
3875 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3876 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003877 }
3878
Joe Perchesa91e8992016-05-20 17:04:05 -07003879# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003880 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003881 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003882 my $indent = length($1);
Antonio Borneo713a09d2020-04-06 20:11:07 -07003883 if ($indent % $tabsize) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003884 if (WARN("TABSTOP",
3885 "Statements should start on a tabstop\n" . $herecurr) &&
3886 $fix) {
Antonio Borneo713a09d2020-04-06 20:11:07 -07003887 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Joe Perchesa91e8992016-05-20 17:04:05 -07003888 }
3889 }
3890 }
3891
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003892# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003893 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003894 $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 -07003895 $prevline =~ /^\+(\t*)(.*)$/;
3896 my $oldindent = $1;
3897 my $rest = $2;
3898
3899 my $pos = pos_last_openparen($rest);
3900 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003901 $line =~ /^(\+| )([ \t]*)/;
3902 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003903
3904 my $goodtabindent = $oldindent .
Antonio Borneo713a09d2020-04-06 20:11:07 -07003905 "\t" x ($pos / $tabsize) .
3906 " " x ($pos % $tabsize);
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003907 my $goodspaceindent = $oldindent . " " x $pos;
3908
3909 if ($newindent ne $goodtabindent &&
3910 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003911
3912 if (CHK("PARENTHESIS_ALIGNMENT",
3913 "Alignment should match open parenthesis\n" . $hereprev) &&
3914 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003915 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003916 s/^\+[ \t]*/\+$goodtabindent/;
3917 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003918 }
3919 }
3920 }
3921
Joe Perches6ab3a972015-04-16 12:44:05 -07003922# check for space after cast like "(int) foo" or "(struct foo) bar"
3923# avoid checking a few false positives:
3924# "sizeof(<type>)" or "__alignof__(<type>)"
3925# function pointer declarations like "(*foo)(int) = bar;"
3926# structure definitions like "(struct foo) { 0 };"
3927# multiline macros that define functions
3928# known attributes or the __attribute__ keyword
3929 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3930 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003931 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003932 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003933 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003934 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003935 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003936 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003937 }
3938
Joe Perches86406b12015-09-09 15:37:41 -07003939# Block comment styles
3940# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003941 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003942 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003943 $rawline =~ /^\+[ \t]*\*/ &&
Łukasz Stelmachc70735c2020-10-15 20:12:25 -07003944 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
Joe Perches05880602012-10-04 17:13:35 -07003945 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3946 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3947 }
3948
Joe Perches86406b12015-09-09 15:37:41 -07003949# Block comments use * on subsequent lines
3950 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3951 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003952 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003953 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003954 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003955 WARN("BLOCK_COMMENT_STYLE",
3956 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003957 }
3958
Joe Perches86406b12015-09-09 15:37:41 -07003959# Block comments use */ on trailing lines
3960 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003961 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3962 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3963 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003964 WARN("BLOCK_COMMENT_STYLE",
3965 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003966 }
3967
Joe Perches08eb9b82016-10-11 13:51:50 -07003968# Block comment * alignment
3969 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf2075242016-10-11 13:52:05 -07003970 $line =~ /^\+[ \t]*$;/ && #leading comment
3971 $rawline =~ /^\+[ \t]*\*/ && #leading *
3972 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003973 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf2075242016-10-11 13:52:05 -07003974 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3975 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003976 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf2075242016-10-11 13:52:05 -07003977 if (defined($1)) {
3978 $oldindent = expand_tabs($1);
3979 } else {
3980 $prevrawline =~ m@^\+(.*/?)\*@;
3981 $oldindent = expand_tabs($1);
3982 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003983 $rawline =~ m@^\+([ \t]*)\*@;
3984 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003985 $newindent = expand_tabs($newindent);
Joe Perchesaf2075242016-10-11 13:52:05 -07003986 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003987 WARN("BLOCK_COMMENT_STYLE",
3988 "Block comments should align the * on each line\n" . $hereprev);
3989 }
3990 }
3991
Joe Perches7f619192014-08-06 16:10:39 -07003992# check for missing blank lines after struct/union declarations
3993# with exceptions for various attributes and macros
3994 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3995 $line =~ /^\+/ &&
3996 !($line =~ /^\+\s*$/ ||
Joe Perches05dc40e2022-03-23 16:06:02 -07003997 $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param)/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003998 $line =~ /^\+\s*MODULE_/i ||
3999 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
4000 $line =~ /^\+[a-z_]*init/ ||
4001 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
4002 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08004003 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07004004 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07004005 if (CHK("LINE_SPACING",
4006 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
4007 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004008 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07004009 }
Joe Perches7f619192014-08-06 16:10:39 -07004010 }
4011
Joe Perches365dd4e2014-08-06 16:10:42 -07004012# check for multiple consecutive blank lines
4013 if ($prevline =~ /^[\+ ]\s*$/ &&
4014 $line =~ /^\+\s*$/ &&
4015 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07004016 if (CHK("LINE_SPACING",
4017 "Please don't use multiple blank lines\n" . $hereprev) &&
4018 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004019 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004020 }
4021
Joe Perches365dd4e2014-08-06 16:10:42 -07004022 $last_blank_line = $linenr;
4023 }
4024
Joe Perches3b617e32014-04-03 14:49:28 -07004025# check for missing blank lines after declarations
Joe Perchesb5e87362021-02-25 17:21:40 -08004026# (declarations must have the same indentation and not be at the start of line)
4027 if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) {
4028 # use temporaries
4029 my $sl = $sline;
4030 my $pl = $prevline;
4031 # remove $Attribute/$Sparse uses to simplify comparisons
4032 $sl =~ s/\b(?:$Attribute|$Sparse)\b//g;
4033 $pl =~ s/\b(?:$Attribute|$Sparse)\b//g;
4034 if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07004035 # function pointer declarations
Joe Perchesb5e87362021-02-25 17:21:40 -08004036 $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004037 # foo bar; where foo is some local typedef or #define
Joe Perchesb5e87362021-02-25 17:21:40 -08004038 $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004039 # known declaration macros
Joe Perchesb5e87362021-02-25 17:21:40 -08004040 $pl =~ /^\+\s+$declaration_macros/) &&
Joe Perches3f7bac02014-06-04 16:12:04 -07004041 # for "else if" which can look like "$Ident $Ident"
Joe Perchesb5e87362021-02-25 17:21:40 -08004042 !($pl =~ /^\+\s+$c90_Keywords\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004043 # other possible extensions of declaration lines
Joe Perchesb5e87362021-02-25 17:21:40 -08004044 $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004045 # not starting a section or a macro "\" extended line
Joe Perchesb5e87362021-02-25 17:21:40 -08004046 $pl =~ /(?:\{\s*|\\)$/) &&
Joe Perches3f7bac02014-06-04 16:12:04 -07004047 # looks like a declaration
Joe Perchesb5e87362021-02-25 17:21:40 -08004048 !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07004049 # function pointer declarations
Joe Perchesb5e87362021-02-25 17:21:40 -08004050 $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004051 # foo bar; where foo is some local typedef or #define
Joe Perchesb5e87362021-02-25 17:21:40 -08004052 $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004053 # known declaration macros
Joe Perchesb5e87362021-02-25 17:21:40 -08004054 $sl =~ /^\+\s+$declaration_macros/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004055 # start of struct or union or enum
Joe Perchesb5e87362021-02-25 17:21:40 -08004056 $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004057 # start or end of block or continuation of declaration
Joe Perchesb5e87362021-02-25 17:21:40 -08004058 $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004059 # bitfield continuation
Joe Perchesb5e87362021-02-25 17:21:40 -08004060 $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07004061 # other possible extensions of declaration lines
Joe Perchesb5e87362021-02-25 17:21:40 -08004062 $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
4063 if (WARN("LINE_SPACING",
4064 "Missing a blank line after declarations\n" . $hereprev) &&
4065 $fix) {
4066 fix_insert_line($fixlinenr, "\+");
4067 }
Joe Perchesd752fcc2014-08-06 16:11:05 -07004068 }
Joe Perches3b617e32014-04-03 14:49:28 -07004069 }
4070
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07004071# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07004072# Exceptions:
4073# 1) within comments
4074# 2) indented preprocessor commands
4075# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07004076 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07004077 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004078 if (WARN("LEADING_SPACE",
4079 "please, no spaces at the start of a line\n" . $herevet) &&
4080 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004081 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07004082 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07004083 }
4084
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07004085# check we are in a valid C source file if not then ignore this hunk
4086 next if ($realfile !~ /\.(h|c)$/);
4087
Joe Perches5751a242017-11-17 15:28:52 -08004088# check for unusual line ending [ or (
4089 if ($line =~ /^\+.*([\[\(])\s*$/) {
4090 CHK("OPEN_ENDED_LINE",
4091 "Lines should not end with a '$1'\n" . $herecurr);
4092 }
4093
Joe Perches4dbed762017-05-08 15:55:39 -07004094# check if this appears to be the start function declaration, save the name
4095 if ($sline =~ /^\+\{\s*$/ &&
4096 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
4097 $context_function = $1;
4098 }
4099
4100# check if this appears to be the end of function declaration
4101 if ($sline =~ /^\+\}\s*$/) {
4102 undef $context_function;
4103 }
4104
Joe Perches032a4c02014-08-06 16:10:29 -07004105# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07004106# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07004107# if the previous line is a break or return and is indented 1 tab more...
4108 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
4109 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07004110 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
4111 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
4112 defined $lines[$linenr] &&
4113 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07004114 WARN("UNNECESSARY_ELSE",
4115 "else is not generally useful after a break or return\n" . $hereprev);
4116 }
4117 }
4118
Joe Perchesc00df192014-08-06 16:11:01 -07004119# check indentation of a line with a break;
Joe Perchesdc58bc52020-12-15 20:44:33 -08004120# if the previous line is a goto, return or break
4121# and is indented the same # of tabs
Joe Perchesc00df192014-08-06 16:11:01 -07004122 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
4123 my $tabs = $1;
Joe Perchesdc58bc52020-12-15 20:44:33 -08004124 if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
4125 if (WARN("UNNECESSARY_BREAK",
4126 "break is not useful after a $1\n" . $hereprev) &&
4127 $fix) {
4128 fix_delete_line($fixlinenr, $rawline);
4129 }
Joe Perchesc00df192014-08-06 16:11:01 -07004130 }
4131 }
4132
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004133# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08004134 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004135 WARN("CVS_KEYWORD",
4136 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004137 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004138
Joe Perches56e77d72013-02-21 16:44:14 -08004139# check for old HOTPLUG __dev<foo> section markings
4140 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
4141 WARN("HOTPLUG_SECTION",
4142 "Using $1 is unnecessary\n" . $herecurr);
4143 }
4144
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004145# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004146 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
4147 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004148#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07004149 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07004150 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a222008-10-15 22:02:30 -07004151 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004152 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004153 $stat =~ s/\n./\n /g;
4154 $cond =~ s/\n./\n /g;
4155
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004156#print "linenr<$linenr> <$stat>\n";
4157 # If this statement has no statement boundaries within
4158 # it there is no point in retrying a statement scan
4159 # until we hit end of it.
4160 my $frag = $stat; $frag =~ s/;+\s*$//;
4161 if ($frag !~ /(?:{|;)/) {
4162#print "skip<$line_nr_next>\n";
4163 $suppress_statement = $line_nr_next;
4164 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004165
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004166 # Find the real next line.
4167 $realline_next = $line_nr_next;
4168 if (defined $realline_next &&
4169 (!defined $lines[$realline_next - 1] ||
4170 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
4171 $realline_next++;
4172 }
4173
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004174 my $s = $stat;
4175 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004176
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004177 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004178 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004179
4180 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004181 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004182
Andy Whitcroft463f2862009-09-21 17:04:34 -07004183 } elsif ($s =~ /^.\s*else\b/s) {
4184
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004185 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07004186 } 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 -07004187 my $type = $1;
4188 $type =~ s/\s+/ /g;
4189 possible($type, "A:" . $s);
4190
Andy Whitcroft8905a672007-11-28 16:21:06 -08004191 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07004192 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004193 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004194 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004195
4196 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08004197 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004198 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004199 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004200
4201 # Check for any sort of function declaration.
4202 # int foo(something bar, other baz);
4203 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004204 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 -08004205 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004206
Andy Whitcroftcf655042008-03-04 14:28:20 -08004207 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004208 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004209 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004210
Andy Whitcroft8905a672007-11-28 16:21:06 -08004211 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004212 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08004213
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004214 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004215 }
4216 }
4217 }
4218
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004219 }
4220
Andy Whitcroft653d4872007-06-23 17:16:34 -07004221#
4222# Checks which may be anchored in the context.
4223#
4224
4225# Check for switch () and associated case and default
4226# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07004227 if ($line=~/\bswitch\s*\(.*\)/) {
4228 my $err = '';
4229 my $sep = '';
4230 my @ctx = ctx_block_outer($linenr, $realcnt);
4231 shift(@ctx);
4232 for my $ctx (@ctx) {
4233 my ($clen, $cindent) = line_stats($ctx);
4234 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
4235 $indent != $cindent) {
4236 $err .= "$sep$ctx\n";
4237 $sep = '';
4238 } else {
4239 $sep = "[...]\n";
4240 }
4241 }
4242 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004243 ERROR("SWITCH_CASE_INDENT_LEVEL",
4244 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004245 }
4246 }
4247
4248# if/while/etc brace do not go on next line, unless defining a do while loop,
4249# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07004250 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 -07004251 my $pre_ctx = "$1$2";
4252
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004253 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08004254
4255 if ($line =~ /^\+\t{6,}/) {
4256 WARN("DEEP_INDENTATION",
4257 "Too many leading tabs - consider code refactoring\n" . $herecurr);
4258 }
4259
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004260 my $ctx_cnt = $realcnt - $#ctx - 1;
4261 my $ctx = join("\n", @ctx);
4262
Andy Whitcroft548596d2008-07-23 21:29:01 -07004263 my $ctx_ln = $linenr;
4264 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004265
Andy Whitcroft548596d2008-07-23 21:29:01 -07004266 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
4267 defined $lines[$ctx_ln - 1] &&
4268 $lines[$ctx_ln - 1] =~ /^-/)) {
4269 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4270 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004271 $ctx_ln++;
4272 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07004273
Andy Whitcroft53210162008-07-23 21:29:03 -07004274 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4275 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07004276
Joe Perchesd752fcc2014-08-06 16:11:05 -07004277 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004278 ERROR("OPEN_BRACE",
4279 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004280 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07004281 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004282 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
4283 $ctx =~ /\)\s*\;\s*$/ &&
4284 defined $lines[$ctx_ln - 1])
4285 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004286 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
4287 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004288 WARN("TRAILING_SEMICOLON",
4289 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004290 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004291 }
4292 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004293 }
4294
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004295# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07004296 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 -08004297 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4298 ctx_statement_block($linenr, $realcnt, 0)
4299 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004300 my ($s, $c) = ($stat, $cond);
4301
4302 substr($s, 0, length($c), '');
4303
Joe Perches9f5af482015-09-09 15:37:30 -07004304 # remove inline comments
4305 $s =~ s/$;/ /g;
4306 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004307
4308 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07004309 my @newlines = ($c =~ /\n/gs);
4310 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004311
Joe Perches9f5af482015-09-09 15:37:30 -07004312 # Make sure we remove the line prefixes as we have
4313 # none on the first line, and are going to readd them
4314 # where necessary.
4315 $s =~ s/\n./\n/gs;
4316 while ($s =~ /\n\s+\\\n/) {
4317 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
4318 }
4319
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004320 # We want to check the first line inside the block
4321 # starting at the end of the conditional, so remove:
4322 # 1) any blank line termination
4323 # 2) any opening brace { on end of the line
4324 # 3) any do (...) {
4325 my $continuation = 0;
4326 my $check = 0;
4327 $s =~ s/^.*\bdo\b//;
4328 $s =~ s/^\s*{//;
4329 if ($s =~ s/^\s*\\//) {
4330 $continuation = 1;
4331 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004332 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004333 $check = 1;
4334 $cond_lines++;
4335 }
4336
4337 # Also ignore a loop construct at the end of a
4338 # preprocessor statement.
4339 if (($prevline =~ /^.\s*#\s*define\s/ ||
4340 $prevline =~ /\\\s*$/) && $continuation == 0) {
4341 $check = 0;
4342 }
4343
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004344 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07004345 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004346 while ($cond_ptr != $cond_lines) {
4347 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004348
Andy Whitcroftf16fa282008-10-15 22:02:32 -07004349 # If we see an #else/#elif then the code
4350 # is not linear.
4351 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
4352 $check = 0;
4353 }
4354
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004355 # Ignore:
4356 # 1) blank lines, they should be at 0,
4357 # 2) preprocessor lines, and
4358 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07004359 if ($continuation ||
4360 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004361 $s =~ /^\s*#\s*?/ ||
4362 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07004363 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07004364 if ($s =~ s/^.*?\n//) {
4365 $cond_lines++;
4366 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004367 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004368 }
4369
4370 my (undef, $sindent) = line_stats("+" . $s);
4371 my $stat_real = raw_line($linenr, $cond_lines);
4372
4373 # Check if either of these lines are modified, else
4374 # this is not this patch's fault.
4375 if (!defined($stat_real) ||
4376 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
4377 $check = 0;
4378 }
4379 if (defined($stat_real) && $cond_lines > 1) {
4380 $stat_real = "[...]\n$stat_real";
4381 }
4382
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004383 #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 -07004384
Joe Perches9f5af482015-09-09 15:37:30 -07004385 if ($check && $s ne '' &&
Antonio Borneo713a09d2020-04-06 20:11:07 -07004386 (($sindent % $tabsize) != 0 ||
Joe Perches9f5af482015-09-09 15:37:30 -07004387 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07004388 ($sindent == $indent &&
4389 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Antonio Borneo713a09d2020-04-06 20:11:07 -07004390 ($sindent > $indent + $tabsize))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004391 WARN("SUSPECT_CODE_INDENT",
4392 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004393 }
4394 }
4395
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004396 # Track the 'values' across context and added lines.
4397 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004398 my ($curr_values, $curr_vars) =
4399 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004400 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004401 if ($dbg_values) {
4402 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004403 print "$linenr > .$outline\n";
4404 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004405 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004406 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004407 $prev_values = substr($curr_values, -1);
4408
Andy Whitcroft00df3442007-06-08 13:47:06 -07004409#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07004410 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07004411
Joe Perches99ca38c2020-10-15 20:12:09 -07004412# check for self assignments used to avoid compiler warnings
4413# e.g.: int foo = foo, *bar = NULL;
4414# struct foo bar = *(&(bar));
4415 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
4416 my $var = $1;
4417 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4418 WARN("SELF_ASSIGNMENT",
4419 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
4420 }
4421 }
4422
Joe Perches11ca40a2016-12-12 16:46:31 -08004423# check for dereferences that span multiple lines
4424 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
4425 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
4426 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
4427 my $ref = $1;
4428 $line =~ /^.\s*($Lval)/;
4429 $ref .= $1;
4430 $ref =~ s/\s//g;
4431 WARN("MULTILINE_DEREFERENCE",
4432 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
4433 }
4434
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004435# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07004436 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 -07004437 my $type = $1;
4438 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07004439 $var = "" if (!defined $var);
4440 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004441 my $sign = $1;
4442 my $pointer = $2;
4443
4444 $pointer = "" if (!defined $pointer);
4445
4446 if (WARN("UNSPECIFIED_INT",
4447 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4448 $fix) {
4449 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07004450 my $comp_pointer = $pointer;
4451 $comp_pointer =~ s/\s//g;
4452 $decl .= $comp_pointer;
4453 $decl = rtrim($decl) if ($var eq "");
4454 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004455 }
4456 }
4457 }
4458
Andy Whitcroft653d4872007-06-23 17:16:34 -07004459# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07004460 if ($dbg_type) {
4461 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004462 ERROR("TEST_TYPE",
4463 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004464 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004465 ERROR("TEST_NOT_TYPE",
4466 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004467 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004468 next;
4469 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004470# TEST: allow direct testing of the attribute matcher.
4471 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004472 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004473 ERROR("TEST_ATTR",
4474 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004475 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004476 ERROR("TEST_NOT_ATTR",
4477 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004478 }
4479 next;
4480 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004481
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004482# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07004483 if ($line =~ /^.\s*{/ &&
4484 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07004485 if (ERROR("OPEN_BRACE",
4486 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004487 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4488 fix_delete_line($fixlinenr - 1, $prevrawline);
4489 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004490 my $fixedline = $prevrawline;
4491 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004492 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004493 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004494 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004495 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004496 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004497 }
4498
Andy Whitcroft653d4872007-06-23 17:16:34 -07004499#
4500# Checks which are anchored on the added line.
4501#
4502
4503# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004504 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07004505 my $path = $1;
4506 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004507 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08004508 "malformed #include filename\n" . $herecurr);
4509 }
4510 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4511 ERROR("UAPI_INCLUDE",
4512 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004513 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004514 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004515
4516# no C99 // comments
4517 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07004518 if (ERROR("C99_COMMENTS",
4519 "do not use C99 // comments\n" . $herecurr) &&
4520 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004521 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07004522 if ($line =~ /\/\/(.*)$/) {
4523 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07004524 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07004525 }
4526 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004527 }
4528 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004529 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004530 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004531
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004532# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4533# the whole statement.
4534#print "APW <$lines[$realline_next - 1]>\n";
4535 if (defined $realline_next &&
4536 exists $lines[$realline_next - 1] &&
4537 !defined $suppress_export{$realline_next} &&
Christoph Hellwig36794822021-02-02 13:13:34 +01004538 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004539 # Handle definitions which produce identifiers with
4540 # a prefix:
4541 # XXX(foo);
4542 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004543 my $name = $1;
Joe Perches70a11652021-11-08 18:33:31 -08004544 $name =~ s/^\s*($Ident).*/$1/;
Andy Whitcroft87a53872012-01-10 15:10:04 -08004545 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004546 $name =~ /^${Ident}_$2/) {
4547#print "FOO C name<$name>\n";
4548 $suppress_export{$realline_next} = 1;
4549
4550 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004551 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07004552 ^.DEFINE_$Ident\(\Q$name\E\)|
4553 ^.DECLARE_$Ident\(\Q$name\E\)|
4554 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004555 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4556 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07004557 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004558#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4559 $suppress_export{$realline_next} = 2;
4560 } else {
4561 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004562 }
4563 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004564 if (!defined $suppress_export{$linenr} &&
4565 $prevline =~ /^.\s*$/ &&
Christoph Hellwig36794822021-02-02 13:13:34 +01004566 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004567#print "FOO B <$lines[$linenr - 1]>\n";
4568 $suppress_export{$linenr} = 2;
4569 }
4570 if (defined $suppress_export{$linenr} &&
4571 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004572 WARN("EXPORT_SYMBOL",
4573 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004574 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004575
Joe Eloff5150bda2010-08-09 17:21:00 -07004576# check for global initialisers.
Song Liu5b8f82e2021-02-25 17:22:08 -08004577 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ &&
4578 !exclude_global_initialisers($realfile)) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004579 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004580 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07004581 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004582 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004583 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004584 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004585# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004586 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004587 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004588 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07004589 $herecurr) &&
4590 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004591 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004592 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004593 }
4594
Joe Perches18130872014-08-06 16:11:22 -07004595# check for misordered declarations of char/short/int/long with signed/unsigned
4596 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4597 my $tmp = trim($1);
4598 WARN("MISORDERED_TYPE",
4599 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4600 }
4601
Joe Perches809e0822018-08-21 21:58:12 -07004602# check for unnecessary <signed> int declarations of short/long/long long
4603 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4604 my $type = trim($1);
4605 next if ($type !~ /\bint\b/);
4606 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4607 my $new_type = $type;
4608 $new_type =~ s/\b\s*int\s*\b/ /;
4609 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4610 $new_type =~ s/^const\s+//;
4611 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4612 $new_type = "const $new_type" if ($type =~ /^const\b/);
4613 $new_type =~ s/\s+/ /g;
4614 $new_type = trim($new_type);
4615 if (WARN("UNNECESSARY_INT",
4616 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4617 $fix) {
4618 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4619 }
4620 }
4621
Joe Perchescb710ec2010-10-26 14:23:20 -07004622# check for static const char * arrays.
4623 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004624 WARN("STATIC_CONST_CHAR_ARRAY",
4625 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004626 $herecurr);
Joe Perches77b8c0a82019-01-03 15:26:59 -08004627 }
4628
4629# check for initialized const char arrays that should be static const
4630 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4631 if (WARN("STATIC_CONST_CHAR_ARRAY",
4632 "const array should probably be static const\n" . $herecurr) &&
4633 $fix) {
4634 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4635 }
4636 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004637
4638# check for static char foo[] = "bar" declarations.
4639 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004640 WARN("STATIC_CONST_CHAR_ARRAY",
4641 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004642 $herecurr);
Joe Perches77b8c0a82019-01-03 15:26:59 -08004643 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004644
Joe Perchesab7e23f2015-04-16 12:44:22 -07004645# check for const <foo> const where <foo> is not a pointer or array type
4646 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4647 my $found = $1;
4648 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4649 WARN("CONST_CONST",
4650 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4651 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4652 WARN("CONST_CONST",
4653 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4654 }
4655 }
4656
Joe Perches73169762020-12-15 20:44:30 -08004657# check for const static or static <non ptr type> const declarations
4658# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4659 if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
4660 $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
4661 if (WARN("STATIC_CONST",
4662 "Move const after static - use 'static const $1'\n" . $herecurr) &&
4663 $fix) {
4664 $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
4665 $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
4666 }
4667 }
4668
Joe Perches9b0fa602014-04-03 14:49:18 -07004669# check for non-global char *foo[] = {"bar", ...} declarations.
4670 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4671 WARN("STATIC_CONST_CHAR_ARRAY",
4672 "char * array declaration might be better as static const\n" .
4673 $herecurr);
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08004674 }
Joe Perches9b0fa602014-04-03 14:49:18 -07004675
Joe Perchesb598b672015-04-16 12:44:36 -07004676# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4677 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4678 my $array = $1;
4679 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4680 my $array_div = $1;
4681 if (WARN("ARRAY_SIZE",
4682 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4683 $fix) {
4684 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4685 }
4686 }
4687 }
4688
Joe Perchesb36190c2014-01-27 17:07:18 -08004689# check for function declarations without arguments like "int foo()"
Joe Perches16b7f3c2020-04-06 20:11:17 -07004690 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Joe Perchesb36190c2014-01-27 17:07:18 -08004691 if (ERROR("FUNCTION_WITHOUT_ARGS",
4692 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4693 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004694 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004695 }
4696 }
4697
Andy Whitcroft653d4872007-06-23 17:16:34 -07004698# check for new typedefs, only function parameters and sparse annotations
4699# make sense.
4700 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004701 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004702 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004703 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004704 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004705 WARN("NEW_TYPEDEFS",
4706 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004707 }
4708
4709# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004710 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004711 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4712 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004713 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004714
Andy Whitcroft65863862009-01-06 14:41:21 -08004715 # Should start with a space.
4716 $to =~ s/^(\S)/ $1/;
4717 # Should not end with a space.
4718 $to =~ s/\s+$//;
4719 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d12009-01-15 13:51:05 -08004720 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004721 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004722
Joe Perches3705ce52013-07-03 15:05:31 -07004723## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004724 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004725 if (ERROR("POINTER_LOCATION",
4726 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4727 $fix) {
4728 my $sub_from = $ident;
4729 my $sub_to = $ident;
4730 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004731 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004732 s@\Q$sub_from\E@$sub_to@;
4733 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004734 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004735 }
4736 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4737 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004738 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004739
Andy Whitcroft65863862009-01-06 14:41:21 -08004740 # Should start with a space.
4741 $to =~ s/^(\S)/ $1/;
4742 # Should not end with a space.
4743 $to =~ s/\s+$//;
4744 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d12009-01-15 13:51:05 -08004745 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004746 }
4747 # Modifiers should have spaces.
4748 $to =~ s/(\b$Modifier$)/$1 /;
4749
Joe Perches3705ce52013-07-03 15:05:31 -07004750## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004751 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004752 if (ERROR("POINTER_LOCATION",
4753 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4754 $fix) {
4755
4756 my $sub_from = $match;
4757 my $sub_to = $match;
4758 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004759 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004760 s@\Q$sub_from\E@$sub_to@;
4761 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004762 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004763 }
4764
David Hildenbrand69d517e2022-09-23 13:34:25 +02004765# do not use BUG() or variants
4766 if ($line =~ /\b(?!AA_|BUILD_|DCCP_|IDA_|KVM_|RWLOCK_|snd_|SPIN_)(?:[a-zA-Z_]*_)?BUG(?:_ON)?(?:_[A-Z_]+)?\s*\(/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004767 my $msg_level = \&WARN;
4768 $msg_level = \&CHK if ($file);
4769 &{$msg_level}("AVOID_BUG",
David Hildenbrand69d517e2022-09-23 13:34:25 +02004770 "Do not crash the kernel unless it is absolutely unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants\n" . $herecurr);
Joe Perches9d3e3c72015-09-09 15:37:27 -07004771 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004772
Joe Perches9d3e3c72015-09-09 15:37:27 -07004773# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004774 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004775 WARN("LINUX_VERSION_CODE",
4776 "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 -08004777 }
4778
Joe Perches17441222011-06-15 15:08:17 -07004779# check for uses of printk_ratelimit
4780 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004781 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004782 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004783 }
4784
Joe Percheseeef5732017-11-17 15:28:41 -08004785# printk should use KERN_* levels
4786 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4787 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4788 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004789 }
4790
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004791# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4792 if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) {
4793 my $printk = $1;
4794 my $modifier = $2;
4795 my $orig = $3;
4796 $modifier = "" if (!defined($modifier));
Joe Perches243f3802012-05-31 16:26:09 -07004797 my $level = lc($orig);
4798 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004799 my $level2 = $level;
4800 $level2 = "dbg" if ($level eq "debug");
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004801 $level .= $modifier;
4802 $level2 .= $modifier;
Joe Perches243f3802012-05-31 16:26:09 -07004803 WARN("PREFER_PR_LEVEL",
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004804 "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 -07004805 }
4806
Joe Perchesf5eea3b2020-12-15 20:45:24 -08004807# prefer dev_<level> to dev_printk(KERN_<LEVEL>
Joe Perchesdc139312013-02-21 16:44:13 -08004808 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4809 my $orig = $1;
4810 my $level = lc($orig);
4811 $level = "warn" if ($level eq "warning");
4812 $level = "dbg" if ($level eq "debug");
4813 WARN("PREFER_DEV_LEVEL",
4814 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4815 }
4816
Nicolas Boichat8020b252020-10-15 20:12:02 -07004817# trace_printk should not be used in production code.
4818 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4819 WARN("TRACE_PRINTK",
4820 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4821 }
4822
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004823# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4824# number of false positives, but assembly files are not checked, so at
4825# least the arch entry code will not trigger this warning.
4826 if ($line =~ /\bENOSYS\b/) {
4827 WARN("ENOSYS",
4828 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4829 }
4830
Jakub Kicinski6b9ea5f2020-05-11 10:08:07 -07004831# ENOTSUPP is not a standard error code and should be avoided in new patches.
4832# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4833# Similarly to ENOSYS warning a small number of false positives is expected.
4834 if (!$file && $line =~ /\bENOTSUPP\b/) {
4835 if (WARN("ENOTSUPP",
4836 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4837 $fix) {
4838 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4839 }
4840 }
4841
Andy Whitcroft653d4872007-06-23 17:16:34 -07004842# function brace can't be on same line, except for #defines of do while,
4843# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004844 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004845 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4846 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4847 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004848 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004849 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004850 $fix) {
4851 fix_delete_line($fixlinenr, $rawline);
4852 my $fixed_line = $rawline;
Dwaipayan Ray03f49352020-12-15 20:45:02 -08004853 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
Joe Perches8d182472014-08-06 16:11:12 -07004854 my $line1 = $1;
4855 my $line2 = $2;
4856 fix_insert_line($fixlinenr, ltrim($line1));
4857 fix_insert_line($fixlinenr, "\+{");
4858 if ($line2 !~ /^\s*$/) {
4859 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4860 }
4861 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004862 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004863
Andy Whitcroft8905a672007-11-28 16:21:06 -08004864# open braces for enum, union and struct go on the same line.
4865 if ($line =~ /^.\s*{/ &&
4866 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004867 if (ERROR("OPEN_BRACE",
4868 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4869 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4870 fix_delete_line($fixlinenr - 1, $prevrawline);
4871 fix_delete_line($fixlinenr, $rawline);
4872 my $fixedline = rtrim($prevrawline) . " {";
4873 fix_insert_line($fixlinenr, $fixedline);
4874 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004875 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004876 if ($fixedline !~ /^\+\s*$/) {
4877 fix_insert_line($fixlinenr, $fixedline);
4878 }
4879 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004880 }
4881
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004882# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004883 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4884 if (WARN("SPACING",
4885 "missing space after $1 definition\n" . $herecurr) &&
4886 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004887 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004888 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4889 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004890 }
4891
Joe Perches31070b52014-01-23 15:54:49 -08004892# Function pointer declarations
4893# check spacing between type, funcptr, and args
4894# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004895 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004896 my $declare = $1;
4897 my $pre_pointer_space = $2;
4898 my $post_pointer_space = $3;
4899 my $funcname = $4;
4900 my $post_funcname_space = $5;
4901 my $pre_args_space = $6;
4902
Joe Perches91f72e92014-04-03 14:49:12 -07004903# the $Declare variable will capture all spaces after the type
4904# so check it for a missing trailing missing space but pointer return types
4905# don't need a space so don't warn for those.
4906 my $post_declare_space = "";
4907 if ($declare =~ /(\s+)$/) {
4908 $post_declare_space = $1;
4909 $declare = rtrim($declare);
4910 }
4911 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004912 WARN("SPACING",
4913 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004914 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004915 }
4916
4917# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004918# This test is not currently implemented because these declarations are
4919# equivalent to
4920# int foo(int bar, ...)
4921# and this is form shouldn't/doesn't generate a checkpatch warning.
4922#
4923# elsif ($declare =~ /\s{2,}$/) {
4924# WARN("SPACING",
4925# "Multiple spaces after return type\n" . $herecurr);
4926# }
Joe Perches31070b52014-01-23 15:54:49 -08004927
4928# unnecessary space "type ( *funcptr)(args...)"
4929 if (defined $pre_pointer_space &&
4930 $pre_pointer_space =~ /^\s/) {
4931 WARN("SPACING",
4932 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4933 }
4934
4935# unnecessary space "type (* funcptr)(args...)"
4936 if (defined $post_pointer_space &&
4937 $post_pointer_space =~ /^\s/) {
4938 WARN("SPACING",
4939 "Unnecessary space before function pointer name\n" . $herecurr);
4940 }
4941
4942# unnecessary space "type (*funcptr )(args...)"
4943 if (defined $post_funcname_space &&
4944 $post_funcname_space =~ /^\s/) {
4945 WARN("SPACING",
4946 "Unnecessary space after function pointer name\n" . $herecurr);
4947 }
4948
4949# unnecessary space "type (*funcptr) (args...)"
4950 if (defined $pre_args_space &&
4951 $pre_args_space =~ /^\s/) {
4952 WARN("SPACING",
4953 "Unnecessary space before function pointer arguments\n" . $herecurr);
4954 }
4955
4956 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004957 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004958 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004959 }
4960 }
4961
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004962# check for spacing round square brackets; allowed:
4963# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004964# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4965# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004966 while ($line =~ /(.*?\s)\[/g) {
4967 my ($where, $prefix) = ($-[1], $1);
4968 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004969 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004970 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004971 if (ERROR("BRACKET_SPACE",
4972 "space prohibited before open square bracket '['\n" . $herecurr) &&
4973 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004974 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004975 s/^(\+.*?)\s+\[/$1\[/;
4976 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004977 }
4978 }
4979
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004980# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004981 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004982 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004983 my $ctx_before = substr($line, 0, $-[1]);
4984 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004985
4986 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004987 if ($name =~ /^(?:
4988 if|for|while|switch|return|case|
4989 volatile|__volatile__|
4990 __attribute__|format|__extension__|
4991 asm|__asm__)$/x)
4992 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004993 # cpp #define statements have non-optional spaces, ie
4994 # if there is a space between the name and the open
4995 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004996 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004997
4998 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004999 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005000
5001 # If this whole things ends with a type its most
5002 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005003 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005004
5005 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07005006 if (WARN("SPACING",
5007 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
5008 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005009 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005010 s/\b$name\s+\(/$name\(/;
5011 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005012 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005013 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07005014
Andy Whitcroft653d4872007-06-23 17:16:34 -07005015# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005016 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005017 my $fixed_line = "";
5018 my $line_fixed = 0;
5019
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005020 my $ops = qr{
5021 <<=|>>=|<=|>=|==|!=|
5022 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
5023 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005024 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08005025 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005026 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08005027 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07005028
5029## print("element count: <" . $#elements . ">\n");
5030## foreach my $el (@elements) {
5031## print("el: <$el>\n");
5032## }
5033
5034 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07005035 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005036
Joe Perches3705ce52013-07-03 15:05:31 -07005037 foreach my $el (@elements) {
5038 push(@fix_elements, substr($rawline, $off, length($el)));
5039 $off += length($el);
5040 }
5041
5042 $off = 0;
5043
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005044 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07005045 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005046
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005047 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07005048
5049 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
5050
5051## print("n: <$n> good: <$good>\n");
5052
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005053 $off += length($elements[$n]);
5054
Lucas De Marchi25985ed2011-03-30 22:57:33 -03005055 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005056 my $ca = substr($opline, 0, $off);
5057 my $cc = '';
5058 if (length($opline) >= ($off + length($elements[$n + 1]))) {
5059 $cc = substr($opline, $off + length($elements[$n + 1]));
5060 }
5061 my $cb = "$ca$;$cc";
5062
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005063 my $a = '';
5064 $a = 'V' if ($elements[$n] ne '');
5065 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005066 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005067 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
5068 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07005069 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005070
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005071 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005072
5073 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005074 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005075 $c = 'V' if ($elements[$n + 2] ne '');
5076 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005077 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005078 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
5079 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08005080 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005081 } else {
5082 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005083 }
5084
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005085 my $ctx = "${a}x${c}";
5086
5087 my $at = "(ctx:$ctx)";
5088
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005089 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005090 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005091
Andy Whitcroft74048ed2008-07-23 21:29:10 -07005092 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005093 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005094
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005095 # Get the full operator variant.
5096 my $opv = $op . substr($curr_vars, $off, 1);
5097
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005098 # Ignore operators passed as parameters.
5099 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07005100 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005101
Andy Whitcroftcf655042008-03-04 14:28:20 -08005102# # Ignore comments
5103# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005104
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005105 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005106 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005107 if ($ctx !~ /.x[WEBC]/ &&
5108 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005109 if (ERROR("SPACING",
5110 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005111 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07005112 $line_fixed = 1;
5113 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005114 }
5115
5116 # // is a comment
5117 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005118
Joe Perchesb00e4812014-04-03 14:49:33 -07005119 # : when part of a bitfield
5120 } elsif ($opv eq ':B') {
5121 # skip the bitfield test for now
5122
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005123 # No spaces for:
5124 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07005125 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005126 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005127 if (ERROR("SPACING",
5128 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005129 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005130 if (defined $fix_elements[$n + 2]) {
5131 $fix_elements[$n + 2] =~ s/^\s+//;
5132 }
Joe Perchesb34c6482013-09-11 14:24:01 -07005133 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07005134 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005135 }
5136
Joe Perches23810972014-12-10 15:51:32 -08005137 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005138 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08005139 my $rtrim_before = 0;
5140 my $space_after = 0;
5141 if ($ctx =~ /Wx./) {
5142 if (ERROR("SPACING",
5143 "space prohibited before that '$op' $at\n" . $hereptr)) {
5144 $line_fixed = 1;
5145 $rtrim_before = 1;
5146 }
5147 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005148 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005149 if (ERROR("SPACING",
5150 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005151 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07005152 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08005153 $space_after = 1;
5154 }
5155 }
5156 if ($rtrim_before || $space_after) {
5157 if ($rtrim_before) {
5158 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5159 } else {
5160 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
5161 }
5162 if ($space_after) {
5163 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07005164 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005165 }
5166
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005167 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07005168 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005169 #warn "'*' is part of type\n";
5170
5171 # unary operators should have a space before and
5172 # none after. May be left adjacent to another
5173 # unary operator, or a cast
5174 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07005175 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07005176 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005177 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005178 if (ERROR("SPACING",
5179 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005180 if ($n != $last_after + 2) {
5181 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
5182 $line_fixed = 1;
5183 }
Joe Perches3705ce52013-07-03 15:05:31 -07005184 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005185 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08005186 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005187 # A unary '*' may be const
5188
5189 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005190 if (ERROR("SPACING",
5191 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005192 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005193 if (defined $fix_elements[$n + 2]) {
5194 $fix_elements[$n + 2] =~ s/^\s+//;
5195 }
Joe Perchesb34c6482013-09-11 14:24:01 -07005196 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07005197 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005198 }
5199
5200 # unary ++ and unary -- are allowed no space on one side.
5201 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005202 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005203 if (ERROR("SPACING",
5204 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005205 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07005206 $line_fixed = 1;
5207 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005208 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005209 if ($ctx =~ /Wx[BE]/ ||
5210 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005211 if (ERROR("SPACING",
5212 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005213 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005214 $line_fixed = 1;
5215 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005216 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005217 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005218 if (ERROR("SPACING",
5219 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005220 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005221 if (defined $fix_elements[$n + 2]) {
5222 $fix_elements[$n + 2] =~ s/^\s+//;
5223 }
Joe Perchesb34c6482013-09-11 14:24:01 -07005224 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07005225 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005226 }
5227
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005228 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005229 } elsif ($op eq '<<' or $op eq '>>' or
5230 $op eq '&' or $op eq '^' or $op eq '|' or
5231 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005232 $op eq '*' or $op eq '/' or
5233 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005234 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08005235 if ($check) {
5236 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
5237 if (CHK("SPACING",
5238 "spaces preferred around that '$op' $at\n" . $hereptr)) {
5239 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5240 $fix_elements[$n + 2] =~ s/^\s+//;
5241 $line_fixed = 1;
5242 }
5243 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
5244 if (CHK("SPACING",
5245 "space preferred before that '$op' $at\n" . $hereptr)) {
5246 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
5247 $line_fixed = 1;
5248 }
5249 }
5250 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005251 if (ERROR("SPACING",
5252 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005253 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5254 if (defined $fix_elements[$n + 2]) {
5255 $fix_elements[$n + 2] =~ s/^\s+//;
5256 }
Joe Perches3705ce52013-07-03 15:05:31 -07005257 $line_fixed = 1;
5258 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005259 }
5260
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005261 # A colon needs no spaces before when it is
5262 # terminating a case value or a label.
5263 } elsif ($opv eq ':C' || $opv eq ':L') {
Chris Down263afd32021-02-25 17:22:04 -08005264 if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) {
Joe Perches3705ce52013-07-03 15:05:31 -07005265 if (ERROR("SPACING",
5266 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005267 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005268 $line_fixed = 1;
5269 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005270 }
5271
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005272 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08005273 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005274 my $ok = 0;
5275
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005276 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005277 if (($op eq '<' &&
5278 $cc =~ /^\S+\@\S+>/) ||
5279 ($op eq '>' &&
5280 $ca =~ /<\S+\@\S+$/))
5281 {
Antonio Borneo342d3d22020-04-06 20:11:01 -07005282 $ok = 1;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005283 }
5284
Joe Perchese0df7e12015-04-16 12:44:53 -07005285 # for asm volatile statements
5286 # ignore a colon with another
5287 # colon immediately before or after
5288 if (($op eq ':') &&
5289 ($ca =~ /:$/ || $cc =~ /^:/)) {
5290 $ok = 1;
5291 }
5292
Joe Perches84731622013-11-12 15:10:05 -08005293 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005294 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07005295 my $msg_level = \&ERROR;
5296 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08005297
Jean Delvare0675a8f2017-09-08 16:16:07 -07005298 if (&{$msg_level}("SPACING",
5299 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005300 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5301 if (defined $fix_elements[$n + 2]) {
5302 $fix_elements[$n + 2] =~ s/^\s+//;
5303 }
Joe Perches3705ce52013-07-03 15:05:31 -07005304 $line_fixed = 1;
5305 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005306 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005307 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005308 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005309
5310## print("n: <$n> GOOD: <$good>\n");
5311
5312 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005313 }
Joe Perches3705ce52013-07-03 15:05:31 -07005314
5315 if (($#elements % 2) == 0) {
5316 $fixed_line = $fixed_line . $fix_elements[$#elements];
5317 }
5318
Joe Perches194f66f2014-08-06 16:11:03 -07005319 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
5320 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07005321 }
5322
5323
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005324 }
5325
Joe Perches786b6322013-07-03 15:05:32 -07005326# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08005327 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07005328 if (WARN("SPACING",
5329 "space prohibited before semicolon\n" . $herecurr) &&
5330 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005331 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07005332 s/^(\+.*\S)\s+;/$1;/;
5333 }
5334 }
5335
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005336# check for multiple assignments
5337 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005338 CHK("MULTIPLE_ASSIGNMENTS",
5339 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005340 }
5341
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005342## # check for multiple declarations, allowing for a function declaration
5343## # continuation.
5344## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5345## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5346##
5347## # Remove any bracketed sections to ensure we do not
Dwaipayan Raye73d2712020-12-15 20:44:56 -08005348## # falsely report the parameters of functions.
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005349## my $ln = $line;
5350## while ($ln =~ s/\([^\(\)]*\)//g) {
5351## }
5352## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005353## WARN("MULTIPLE_DECLARATION",
5354## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005355## }
5356## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005357
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005358#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07005359 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005360 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005361 if (ERROR("SPACING",
5362 "space required before the open brace '{'\n" . $herecurr) &&
5363 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005364 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07005365 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005366 }
5367
Joe Perchesc4a62ef2013-07-03 15:05:28 -07005368## # check for blank lines before declarations
5369## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5370## $prevrawline =~ /^.\s*$/) {
5371## WARN("SPACING",
5372## "No blank lines before declarations\n" . $hereprev);
5373## }
5374##
5375
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005376# closing brace should have a space following it when it has anything
5377# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07005378 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005379 if (ERROR("SPACING",
5380 "space required after that close brace '}'\n" . $herecurr) &&
5381 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005382 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07005383 s/}((?!(?:,|;|\)))\S)/} $1/;
5384 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005385 }
5386
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005387# check spacing on square brackets
5388 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005389 if (ERROR("SPACING",
5390 "space prohibited after that open square bracket '['\n" . $herecurr) &&
5391 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005392 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005393 s/\[\s+/\[/;
5394 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005395 }
5396 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005397 if (ERROR("SPACING",
5398 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
5399 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005400 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005401 s/\s+\]/\]/;
5402 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005403 }
5404
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005405# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005406 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
5407 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005408 if (ERROR("SPACING",
5409 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
5410 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005411 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005412 s/\(\s+/\(/;
5413 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005414 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005415 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005416 $line !~ /for\s*\(.*;\s+\)/ &&
5417 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005418 if (ERROR("SPACING",
5419 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
5420 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005421 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005422 s/\s+\)/\)/;
5423 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005424 }
5425
Joe Perchese2826fd2014-08-06 16:10:48 -07005426# check unnecessary parentheses around addressof/dereference single $Lvals
5427# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5428
5429 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08005430 my $var = $1;
5431 if (CHK("UNNECESSARY_PARENTHESES",
5432 "Unnecessary parentheses around $var\n" . $herecurr) &&
5433 $fix) {
5434 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
5435 }
5436 }
5437
5438# check for unnecessary parentheses around function pointer uses
5439# ie: (foo->bar)(); should be foo->bar();
5440# but not "if (foo->bar) (" to avoid some false positives
5441 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
5442 my $var = $2;
5443 if (CHK("UNNECESSARY_PARENTHESES",
5444 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
5445 $fix) {
5446 my $var2 = deparenthesize($var);
5447 $var2 =~ s/\s//g;
5448 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
5449 }
5450 }
Joe Perchese2826fd2014-08-06 16:10:48 -07005451
Joe Perches63b7c732017-09-08 16:16:01 -07005452# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08005453# when !drivers/staging or command-line uses --strict
5454 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07005455 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07005456 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
5457 my $if_stat = $1;
5458 my $test = substr($2, 1, -1);
5459 my $herectx;
5460 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5461 my $match = $1;
5462 # avoid parentheses around potential macro args
5463 next if ($match =~ /^\s*\w+\s*$/);
5464 if (!defined($herectx)) {
5465 $herectx = $here . "\n";
5466 my $cnt = statement_rawlines($if_stat);
5467 for (my $n = 0; $n < $cnt; $n++) {
5468 my $rl = raw_line($linenr, $n);
5469 $herectx .= $rl . "\n";
5470 last if $rl =~ /^[ \+].*\{/;
5471 }
5472 }
5473 CHK("UNNECESSARY_PARENTHESES",
5474 "Unnecessary parentheses around '$match'\n" . $herectx);
5475 }
5476 }
5477
Joe Perches69078652021-06-30 18:56:22 -07005478# check that goto labels aren't indented (allow a single space indentation)
5479# and ignore bitfield definitions like foo:1
5480# Strictly, labels can have whitespace after the identifier and before the :
5481# but this is not allowed here as many ?: uses would appear to be labels
5482 if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ &&
5483 $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ &&
5484 $sline !~ /^.\s+default:/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005485 if (WARN("INDENTED_LABEL",
5486 "labels should not be indented\n" . $herecurr) &&
5487 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005488 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005489 s/^(.)\s+/$1/;
5490 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005491 }
5492
Joe Perches40873ab2020-10-15 20:11:56 -07005493# check if a statement with a comma should be two statements like:
5494# foo = bar(), /* comma should be semicolon */
5495# bar = baz();
5496 if (defined($stat) &&
5497 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5498 my $cnt = statement_rawlines($stat);
5499 my $herectx = get_stat_here($linenr, $cnt, $here);
5500 WARN("SUSPECT_COMMA_SEMICOLON",
5501 "Possible comma where semicolon could be used\n" . $herectx);
5502 }
5503
Joe Perches5b9553a2014-04-03 14:49:21 -07005504# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08005505 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005506 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07005507 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07005508 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
5509 my $value = $1;
5510 $value = deparenthesize($value);
5511 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
5512 ERROR("RETURN_PARENTHESES",
5513 "return is not a function, parentheses are not required\n" . $herecurr);
5514 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005515 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005516 ERROR("SPACING",
5517 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005518 }
5519 }
Joe Perches507e5142013-11-12 15:10:13 -08005520
Joe Perchesb43ae212014-06-23 13:22:07 -07005521# unnecessary return in a void function
5522# at end-of-function, with the previous line a single leading tab, then return;
5523# and the line before that not a goto label target like "out:"
5524 if ($sline =~ /^[ \+]}\s*$/ &&
5525 $prevline =~ /^\+\treturn\s*;\s*$/ &&
5526 $linenr >= 3 &&
5527 $lines[$linenr - 3] =~ /^[ +]/ &&
5528 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07005529 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07005530 "void function return statements are not generally useful\n" . $hereprev);
Dwaipayan Rayea7dbab2021-02-25 17:21:47 -08005531 }
Joe Perches9819cf22014-06-04 16:12:09 -07005532
Joe Perches189248d2014-01-23 15:54:47 -08005533# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07005534 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08005535 $line =~ /\bif\s*((?:\(\s*){2,})/) {
5536 my $openparens = $1;
5537 my $count = $openparens =~ tr@\(@\(@;
5538 my $msg = "";
5539 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5540 my $comp = $4; #Not $1 because of $LvalOrFunc
5541 $msg = " - maybe == should be = ?" if ($comp eq "==");
5542 WARN("UNNECESSARY_PARENTHESES",
5543 "Unnecessary parentheses$msg\n" . $herecurr);
5544 }
5545 }
5546
Joe Perchesc5595fa2015-09-09 15:37:58 -07005547# comparisons with a constant or upper case identifier on the left
5548# avoid cases like "foo + BAR < baz"
5549# only fix matches surrounded by parentheses to avoid incorrect
5550# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07005551 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005552 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5553 my $lead = $1;
5554 my $const = $2;
5555 my $comp = $3;
5556 my $to = $4;
5557 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07005558 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005559 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5560 WARN("CONSTANT_COMPARISON",
5561 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5562 $fix) {
5563 if ($comp eq "<") {
5564 $newcomp = ">";
5565 } elsif ($comp eq "<=") {
5566 $newcomp = ">=";
5567 } elsif ($comp eq ">") {
5568 $newcomp = "<";
5569 } elsif ($comp eq ">=") {
5570 $newcomp = "<=";
5571 }
5572 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5573 }
5574 }
5575
Joe Perchesf34e4a42015-04-16 12:44:19 -07005576# Return of what appears to be an errno should normally be negative
5577 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005578 my $name = $1;
Guenter Roeck46b85bf2021-06-30 18:56:25 -07005579 if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005580 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07005581 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005582 }
5583 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005584
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005585# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07005586 if ($line =~ /\b(if|while|for|switch)\(/) {
5587 if (ERROR("SPACING",
5588 "space required before the open parenthesis '('\n" . $herecurr) &&
5589 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005590 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005591 s/\b(if|while|for|switch)\(/$1 \(/;
5592 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005593 }
5594
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07005595# Check for illegal assignment in if conditional -- and check for trailing
5596# statements after the conditional.
Andy Whitcroft170d3a222008-10-15 22:02:30 -07005597 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08005598 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5599 ctx_statement_block($linenr, $realcnt, 0)
5600 if (!defined $stat);
Andy Whitcroft170d3a222008-10-15 22:02:30 -07005601 my ($stat_next) = ctx_statement_block($line_nr_next,
5602 $remain_next, $off_next);
5603 $stat_next =~ s/\n./\n /g;
5604 ##print "stat<$stat> stat_next<$stat_next>\n";
5605
5606 if ($stat_next =~ /^\s*while\b/) {
5607 # If the statement carries leading newlines,
5608 # then count those as offsets.
5609 my ($whitespace) =
5610 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5611 my $offset =
5612 statement_rawlines($whitespace) - 1;
5613
5614 $suppress_whiletrailers{$line_nr_next +
5615 $offset} = 1;
5616 }
5617 }
5618 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08005619 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a222008-10-15 22:02:30 -07005620 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005621 my ($s, $c) = ($stat, $cond);
Joe Perches481efd72022-03-23 16:05:59 -07005622 my $fixed_assign_in_if = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08005623
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08005624 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches65b64b32020-08-11 18:35:10 -07005625 if (ERROR("ASSIGN_IN_IF",
5626 "do not use assignment in if condition\n" . $herecurr) &&
5627 $fix && $perl_version_ok) {
5628 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5629 my $space = $1;
5630 my $not = $2;
5631 my $statement = $3;
5632 my $assigned = $4;
5633 my $test = $8;
5634 my $against = $9;
5635 my $brace = $15;
5636 fix_delete_line($fixlinenr, $rawline);
5637 fix_insert_line($fixlinenr, "$space$statement;");
5638 my $newline = "${space}if (";
5639 $newline .= '!' if defined($not);
5640 $newline .= '(' if (defined $not && defined($test) && defined($against));
5641 $newline .= "$assigned";
5642 $newline .= " $test $against" if (defined($test) && defined($against));
5643 $newline .= ')' if (defined $not && defined($test) && defined($against));
5644 $newline .= ')';
5645 $newline .= " {" if (defined($brace));
5646 fix_insert_line($fixlinenr + 1, $newline);
Joe Perches481efd72022-03-23 16:05:59 -07005647 $fixed_assign_in_if = 1;
Joe Perches65b64b32020-08-11 18:35:10 -07005648 }
5649 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005650 }
5651
5652 # Find out what is on the end of the line after the
5653 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005654 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08005655 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005656 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07005657 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5658 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005659 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005660 # Find out how long the conditional actually is.
5661 my @newlines = ($c =~ /\n/gs);
5662 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005663 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005664
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005665 $stat_real = raw_line($linenr, $cond_lines)
5666 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005667 if (defined($stat_real) && $cond_lines > 1) {
5668 $stat_real = "[...]\n$stat_real";
5669 }
5670
Joe Perches481efd72022-03-23 16:05:59 -07005671 if (ERROR("TRAILING_STATEMENTS",
5672 "trailing statements should be on next line\n" . $herecurr . $stat_real) &&
5673 !$fixed_assign_in_if &&
5674 $cond_lines == 0 &&
5675 $fix && $perl_version_ok &&
5676 $fixed[$fixlinenr] =~ /^\+(\s*)((?:if|while|for)\s*$balanced_parens)\s*(.*)$/) {
5677 my $indent = $1;
5678 my $test = $2;
5679 my $rest = rtrim($4);
5680 if ($rest =~ /;$/) {
5681 $fixed[$fixlinenr] = "\+$indent$test";
5682 fix_insert_line($fixlinenr + 1, "$indent\t$rest");
5683 }
5684 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005685 }
5686 }
5687
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005688# Check for bitwise tests written as boolean
5689 if ($line =~ /
5690 (?:
5691 (?:\[|\(|\&\&|\|\|)
5692 \s*0[xX][0-9]+\s*
5693 (?:\&\&|\|\|)
5694 |
5695 (?:\&\&|\|\|)
5696 \s*0[xX][0-9]+\s*
5697 (?:\&\&|\|\||\)|\])
5698 )/x)
5699 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005700 WARN("HEXADECIMAL_BOOLEAN_TEST",
5701 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005702 }
5703
Andy Whitcroft8905a672007-11-28 16:21:06 -08005704# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005705 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5706 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005707 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005708 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005709 ERROR("TRAILING_STATEMENTS",
5710 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005711 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005712 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005713# if should not continue a brace
5714 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005715 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005716 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005717 $herecurr);
5718 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005719# case and default should not have general statements after them
5720 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5721 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005722 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005723 \s*return\s+
5724 )/xg)
5725 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005726 ERROR("TRAILING_STATEMENTS",
5727 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005728 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005729
5730 # Check for }<nl>else {, these must be at the same
5731 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005732 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5733 $previndent == $indent) {
5734 if (ERROR("ELSE_AFTER_BRACE",
5735 "else should follow close brace '}'\n" . $hereprev) &&
5736 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5737 fix_delete_line($fixlinenr - 1, $prevrawline);
5738 fix_delete_line($fixlinenr, $rawline);
5739 my $fixedline = $prevrawline;
5740 $fixedline =~ s/}\s*$//;
5741 if ($fixedline !~ /^\+\s*$/) {
5742 fix_insert_line($fixlinenr, $fixedline);
5743 }
5744 $fixedline = $rawline;
5745 $fixedline =~ s/^(.\s*)else/$1} else/;
5746 fix_insert_line($fixlinenr, $fixedline);
5747 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005748 }
5749
Joe Perches8b8856f2014-08-06 16:11:14 -07005750 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5751 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005752 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5753
5754 # Find out what is on the end of the line after the
5755 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005756 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005757 $s =~ s/\n.*//g;
5758
5759 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005760 if (ERROR("WHILE_AFTER_BRACE",
5761 "while should follow close brace '}'\n" . $hereprev) &&
5762 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5763 fix_delete_line($fixlinenr - 1, $prevrawline);
5764 fix_delete_line($fixlinenr, $rawline);
5765 my $fixedline = $prevrawline;
5766 my $trailing = $rawline;
5767 $trailing =~ s/^\+//;
5768 $trailing = trim($trailing);
5769 $fixedline =~ s/}\s*$/} $trailing/;
5770 fix_insert_line($fixlinenr, $fixedline);
5771 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005772 }
5773 }
5774
Joe Perches95e2c602013-07-03 15:05:20 -07005775#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005776 while ($line =~ m{($Constant|$Lval)}g) {
5777 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005778
Joe Perches95e2c602013-07-03 15:05:20 -07005779#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005780 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005781 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Łukasz Stelmach4104a202020-12-15 20:44:27 -08005782#Ignore some autogenerated defines and enum values
5783 $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005784#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005785 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005786#Ignore SI style variants like nS, mV and dB
5787#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5788 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005789#Ignore some three character SI units explicitly, like MiB and KHz
5790 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Antonio Borneof858e232022-06-13 12:00:55 +02005791 while ($var =~ m{\b($Ident)}g) {
Joe Perches7e781f62013-09-11 14:23:55 -07005792 my $word = $1;
5793 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005794 if ($check) {
5795 seed_camelcase_includes();
5796 if (!$file && !$camelcase_file_seeded) {
5797 seed_camelcase_file($realfile);
5798 $camelcase_file_seeded = 1;
5799 }
5800 }
Joe Perches7e781f62013-09-11 14:23:55 -07005801 if (!defined $camelcase{$word}) {
5802 $camelcase{$word} = 1;
5803 CHK("CAMELCASE",
5804 "Avoid CamelCase: <$word>\n" . $herecurr);
5805 }
Joe Perches34456862013-07-03 15:05:34 -07005806 }
Joe Perches323c1262012-12-17 16:02:07 -08005807 }
5808 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005809
5810#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005811 if ($line =~ /\#\s*define.*\\\s+$/) {
5812 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5813 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5814 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005815 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005816 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005817 }
5818
Fabian Frederick0e212e02015-04-16 12:44:25 -07005819# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5820# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005821 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005822 my $file = "$1.h";
5823 my $checkfile = "include/linux/$file";
5824 if (-f "$root/$checkfile" &&
5825 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005826 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005827 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005828 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5829 if ($asminclude > 0) {
5830 if ($realfile =~ m{^arch/}) {
5831 CHK("ARCH_INCLUDE_LINUX",
5832 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5833 } else {
5834 WARN("INCLUDE_LINUX",
5835 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5836 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005837 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005838 }
5839 }
5840
Andy Whitcroft653d4872007-06-23 17:16:34 -07005841# multi-statement macros should be enclosed in a do while loop, grab the
5842# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005843# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07005844 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5845 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005846 my $ln = $linenr;
5847 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005848 my ($off, $dstat, $dcond, $rest);
5849 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005850 my $has_flow_statement = 0;
5851 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005852 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005853 ctx_statement_block($linenr, $realcnt, 0);
5854 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005855 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005856 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005857
Joe Perches08a28432014-10-13 15:51:55 -07005858 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005859 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005860
Joe Perchesf59b64b2016-10-11 13:52:08 -07005861 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5862 my $define_args = $1;
5863 my $define_stmt = $dstat;
5864 my @def_args = ();
5865
5866 if (defined $define_args && $define_args ne "") {
5867 $define_args = substr($define_args, 1, length($define_args) - 2);
5868 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005869 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005870 @def_args = split(",", $define_args);
5871 }
5872
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005873 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005874 $dstat =~ s/\\\n.//g;
5875 $dstat =~ s/^\s*//s;
5876 $dstat =~ s/\s*$//s;
5877
5878 # Flatten any parentheses and braces
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005879 while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
5880 $dstat =~ s/\{[^\{\}]*\}/1u/ ||
5881 $dstat =~ s/.\[[^\[\]]*\]/1u/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005882 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005883 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005884
Antonio Borneo342d3d22020-04-06 20:11:01 -07005885 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005886 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5887 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005888 {
5889 }
5890
Joe Perches42e15292016-03-15 14:58:01 -07005891 # Make asm volatile uses seem like a generic function
5892 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5893
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005894 my $exceptions = qr{
5895 $Declare|
5896 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005897 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005898 DECLARE_PER_CPU|
5899 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005900 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005901 union|
5902 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005903 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005904 ^\"|\"$|
5905 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005906 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005907 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005908
5909 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005910 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005911 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005912
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005913 if ($dstat ne '' &&
5914 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5915 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005916 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005917 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005918 $dstat !~ /$exceptions/ &&
5919 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005920 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Stanislaw Gruszkadc3f4de2022-10-27 15:43:34 +02005921 $dstat !~ /^case\b/ && # case ...
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005922 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005923 $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...}
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005924 $dstat !~ /^for\s*$Constant$/ && # for (...)
5925 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5926 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005927 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005928 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005929 {
Joe Perchese7955562017-05-08 15:55:48 -07005930 if ($dstat =~ /^\s*if\b/) {
5931 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5932 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5933 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005934 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5935 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5936 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005937 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005938 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005939 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005940
5941 }
Joe Perches52076492016-10-11 13:52:14 -07005942
5943 # Make $define_stmt single line, comment-free, etc
5944 my @stmt_array = split('\n', $define_stmt);
5945 my $first = 1;
5946 $define_stmt = "";
5947 foreach my $l (@stmt_array) {
5948 $l =~ s/\\$//;
5949 if ($first) {
5950 $define_stmt = $l;
5951 $first = 0;
5952 } elsif ($l =~ /^[\+ ]/) {
5953 $define_stmt .= substr($l, 1);
5954 }
5955 }
5956 $define_stmt =~ s/$;//g;
5957 $define_stmt =~ s/\s+/ /g;
5958 $define_stmt = trim($define_stmt);
5959
Joe Perchesf59b64b2016-10-11 13:52:08 -07005960# check if any macro arguments are reused (ignore '...' and 'type')
5961 foreach my $arg (@def_args) {
5962 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005963 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005964 my $tmp_stmt = $define_stmt;
Vincent Mailhol7b844342021-05-06 18:03:58 -07005965 $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 -07005966 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5967 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005968 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005969 if ($use_cnt > 1) {
5970 CHK("MACRO_ARG_REUSE",
5971 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005972 }
5973# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005974 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005975 ((defined($1) && $1 ne ',') ||
5976 (defined($2) && $2 ne ','))) {
5977 CHK("MACRO_ARG_PRECEDENCE",
5978 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005979 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005980 }
Joe Perches5023d342012-12-17 16:01:47 -08005981
Joe Perches08a28432014-10-13 15:51:55 -07005982# check for macros with flow control, but without ## concatenation
5983# ## concatenation is commonly a macro that defines a function so ignore those
5984 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005985 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005986 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005987
Joe Perches08a28432014-10-13 15:51:55 -07005988 WARN("MACRO_WITH_FLOW_CONTROL",
5989 "Macros with flow control statements should be avoided\n" . "$herectx");
5990 }
5991
Joe Perches481eb482012-12-17 16:01:56 -08005992# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005993
5994 } else {
5995 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005996 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5997 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005998 $line =~ /^\+.*\\$/) {
5999 WARN("LINE_CONTINUATIONS",
6000 "Avoid unnecessary line continuations\n" . $herecurr);
6001 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006002 }
6003
Joe Perchesb13edf72012-07-30 14:41:24 -07006004# do {} while (0) macro tests:
6005# single-statement macros do not need to be enclosed in do while (0) loop,
6006# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07006007 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07006008 $realfile !~ m@/vmlinux.lds.h$@ &&
6009 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
6010 my $ln = $linenr;
6011 my $cnt = $realcnt;
6012 my ($off, $dstat, $dcond, $rest);
6013 my $ctx = '';
6014 ($dstat, $dcond, $ln, $cnt, $off) =
6015 ctx_statement_block($linenr, $realcnt, 0);
6016 $ctx = $dstat;
6017
6018 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08006019 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07006020
6021 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
6022 my $stmts = $2;
6023 my $semis = $3;
6024
6025 $ctx =~ s/\n*$//;
6026 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006027 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07006028
Joe Perchesac8e97f2012-08-21 16:15:53 -07006029 if (($stmts =~ tr/;/;/) == 1 &&
6030 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07006031 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
6032 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
6033 }
6034 if (defined $semis && $semis ne "") {
6035 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
6036 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
6037 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07006038 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
6039 $ctx =~ s/\n*$//;
6040 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006041 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07006042
6043 WARN("TRAILING_SEMICOLON",
6044 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07006045 }
6046 }
6047
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006048# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006049 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
6050 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08006051 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006052 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08006053 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
6054 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07006055 my @allowed = ();
6056 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006057 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07006058 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08006059 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006060 for my $chunk (@chunks) {
6061 my ($cond, $block) = @{$chunk};
6062
Andy Whitcroft773647a2008-03-28 14:15:58 -07006063 # If the condition carries leading newlines, then count those as offsets.
6064 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
6065 my $offset = statement_rawlines($whitespace) - 1;
6066
Joe Perchesaad4f612012-03-23 15:02:19 -07006067 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07006068 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
6069
6070 # We have looked at and allowed this specific line.
6071 $suppress_ifbraces{$ln + $offset} = 1;
6072
6073 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08006074 $ln += statement_rawlines($block) - 1;
6075
Andy Whitcroft773647a2008-03-28 14:15:58 -07006076 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006077
6078 $seen++ if ($block =~ /^\s*{/);
6079
Joe Perchesaad4f612012-03-23 15:02:19 -07006080 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08006081 if (statement_lines($cond) > 1) {
6082 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07006083 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006084 }
6085 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08006086 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07006087 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006088 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08006089 if (statement_block_size($block) > 1) {
6090 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07006091 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006092 }
Joe Perchesaad4f612012-03-23 15:02:19 -07006093 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006094 }
Joe Perchesaad4f612012-03-23 15:02:19 -07006095 if ($seen) {
6096 my $sum_allowed = 0;
6097 foreach (@allowed) {
6098 $sum_allowed += $_;
6099 }
6100 if ($sum_allowed == 0) {
6101 WARN("BRACES",
6102 "braces {} are not necessary for any arm of this statement\n" . $herectx);
6103 } elsif ($sum_allowed != $allow &&
6104 $seen != $allow) {
6105 CHK("BRACES",
6106 "braces {} should be used on all arms of this statement\n" . $herectx);
6107 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006108 }
6109 }
6110 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006111 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006112 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08006113 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006114
Andy Whitcroftcf655042008-03-04 14:28:20 -08006115 # Check the pre-context.
6116 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
6117 #print "APW: ALLOWED: pre<$1>\n";
6118 $allowed = 1;
6119 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006120
6121 my ($level, $endln, @chunks) =
6122 ctx_statement_full($linenr, $realcnt, $-[0]);
6123
Andy Whitcroftcf655042008-03-04 14:28:20 -08006124 # Check the condition.
6125 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07006126 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08006127 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07006128 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08006129 }
6130 if (statement_lines($cond) > 1) {
6131 #print "APW: ALLOWED: cond<$cond>\n";
6132 $allowed = 1;
6133 }
6134 if ($block =~/\b(?:if|for|while)\b/) {
6135 #print "APW: ALLOWED: block<$block>\n";
6136 $allowed = 1;
6137 }
6138 if (statement_block_size($block) > 1) {
6139 #print "APW: ALLOWED: lines block<$block>\n";
6140 $allowed = 1;
6141 }
6142 # Check the post-context.
6143 if (defined $chunks[1]) {
6144 my ($cond, $block) = @{$chunks[1]};
6145 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07006146 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006147 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08006148 if ($block =~ /^\s*\{/) {
6149 #print "APW: ALLOWED: chunk-1 block<$block>\n";
6150 $allowed = 1;
6151 }
6152 }
6153 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07006154 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006155 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08006156
Joe Perches000d1cc12011-07-25 17:13:25 -07006157 WARN("BRACES",
6158 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006159 }
6160 }
6161
Joe Perchese4c5bab2017-02-24 15:01:41 -08006162# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08006163 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
6164 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08006165 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
6166 }
6167
Joe Perches0979ae62012-12-17 16:01:59 -08006168# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07006169 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08006170 if (CHK("BRACES",
6171 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
6172 $fix && $prevrawline =~ /^\+/) {
6173 fix_delete_line($fixlinenr - 1, $prevrawline);
6174 }
Joe Perches0979ae62012-12-17 16:01:59 -08006175 }
Joe Perches77b9a532013-07-03 15:05:29 -07006176 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08006177 if (CHK("BRACES",
6178 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
6179 $fix) {
6180 fix_delete_line($fixlinenr, $rawline);
6181 }
Joe Perches0979ae62012-12-17 16:01:59 -08006182 }
6183
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006184# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07006185 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
6186 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006187 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006188 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006189 }
6190
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006191# Check for user-visible strings broken across lines, which breaks the ability
6192# to grep for the string. Make exceptions when the previous string ends in a
6193# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
6194# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07006195 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006196 $prevline =~ /"\s*$/ &&
6197 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
6198 if (WARN("SPLIT_STRING",
6199 "quoted string split across lines\n" . $hereprev) &&
6200 $fix &&
6201 $prevrawline =~ /^\+.*"\s*$/ &&
6202 $last_coalesced_string_linenr != $linenr - 1) {
6203 my $extracted_string = get_quoted_string($line, $rawline);
6204 my $comma_close = "";
6205 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
6206 $comma_close = $1;
6207 }
6208
6209 fix_delete_line($fixlinenr - 1, $prevrawline);
6210 fix_delete_line($fixlinenr, $rawline);
6211 my $fixedline = $prevrawline;
6212 $fixedline =~ s/"\s*$//;
6213 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
6214 fix_insert_line($fixlinenr - 1, $fixedline);
6215 $fixedline = $rawline;
6216 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
6217 if ($fixedline !~ /\+\s*$/) {
6218 fix_insert_line($fixlinenr, $fixedline);
6219 }
6220 $last_coalesced_string_linenr = $linenr;
6221 }
6222 }
6223
6224# check for missing a space in a string concatenation
6225 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
6226 WARN('MISSING_SPACE',
6227 "break quoted strings at a space character\n" . $hereprev);
6228 }
6229
Joe Perchese4b7d302017-05-08 15:55:51 -07006230# check for an embedded function name in a string when the function is known
6231# This does not work very well for -f --file checking as it depends on patch
6232# context providing the function name or a single line form for in-file
6233# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08006234 if ($line =~ /^\+.*$String/ &&
6235 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07006236 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
6237 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08006238 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07006239 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08006240 }
6241
Joe Perchesadb2da82021-02-25 17:21:50 -08006242# check for unnecessary function tracing like uses
6243# This does not use $logFunctions because there are many instances like
6244# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions
6245 if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) {
6246 if (WARN("TRACING_LOGGING",
6247 "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) &&
6248 $fix) {
6249 fix_delete_line($fixlinenr, $rawline);
6250 }
6251 }
6252
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006253# check for spaces before a quoted newline
6254 if ($rawline =~ /^.*\".*\s\\n/) {
6255 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
6256 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
6257 $fix) {
6258 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
6259 }
6260
6261 }
6262
Joe Perchesf17dba42014-10-13 15:51:51 -07006263# concatenated string without spaces between elements
Joe Perchesd2af5aa2021-09-07 19:59:51 -07006264 if ($line =~ /$String[A-Z_]/ ||
6265 ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) {
Joe Perches79682c02018-08-21 21:57:29 -07006266 if (CHK("CONCATENATED_STRING",
6267 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
6268 $fix) {
6269 while ($line =~ /($String)/g) {
6270 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6271 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
6272 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
6273 }
6274 }
Joe Perchesf17dba42014-10-13 15:51:51 -07006275 }
6276
Joe Perches90ad30e2014-12-10 15:51:59 -08006277# uncoalesced string fragments
Joe Perchesd2af5aa2021-09-07 19:59:51 -07006278 if ($line =~ /$String\s*[Lu]?"/) {
Joe Perches79682c02018-08-21 21:57:29 -07006279 if (WARN("STRING_FRAGMENTS",
6280 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
6281 $fix) {
6282 while ($line =~ /($String)(?=\s*")/g) {
6283 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6284 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
6285 }
6286 }
Joe Perches90ad30e2014-12-10 15:51:59 -08006287 }
6288
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006289# check for non-standard and hex prefixed decimal printf formats
6290 my $show_L = 1; #don't show the same defect twice
6291 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006292 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006293 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006294 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006295 # check for %L
6296 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006297 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006298 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
6299 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006300 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006301 # check for %Z
6302 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
6303 WARN("PRINTF_Z",
6304 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
6305 $show_Z = 0;
6306 }
6307 # check for 0x<decimal>
6308 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
6309 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07006310 "Prefixing 0x with decimal output is defective\n" . $herecurr);
6311 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006312 }
6313
6314# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08006315 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006316 WARN("LINE_CONTINUATIONS",
6317 "Avoid line continuations in quoted strings\n" . $herecurr);
6318 }
6319
Andy Whitcroft00df3442007-06-08 13:47:06 -07006320# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006321 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07006322 WARN("IF_0",
6323 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
6324 }
6325
6326# warn about #if 1
6327 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
6328 WARN("IF_1",
6329 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006330 }
6331
Andy Whitcroft03df4b52012-12-17 16:01:52 -08006332# check for needless "if (<foo>) fn(<foo>)" uses
6333 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07006334 my $tested = quotemeta($1);
6335 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
6336 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6337 my $func = $1;
6338 if (WARN('NEEDLESS_IF',
6339 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
6340 $fix) {
6341 my $do_fix = 1;
6342 my $leading_tabs = "";
6343 my $new_leading_tabs = "";
6344 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
6345 $leading_tabs = $1;
6346 } else {
6347 $do_fix = 0;
6348 }
6349 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
6350 $new_leading_tabs = $1;
6351 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
6352 $do_fix = 0;
6353 }
6354 } else {
6355 $do_fix = 0;
6356 }
6357 if ($do_fix) {
6358 fix_delete_line($fixlinenr - 1, $prevrawline);
6359 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
6360 }
6361 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07006362 }
6363 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006364
Joe Perchesebfdc402014-08-06 16:10:27 -07006365# check for unnecessary "Out of Memory" messages
6366 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
6367 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
6368 (defined $1 || defined $3) &&
6369 $linenr > 3) {
6370 my $testval = $2;
6371 my $testline = $lines[$linenr - 3];
6372
6373 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
6374# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6375
Joe Perchese29a70f2019-03-07 16:28:35 -08006376 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6377 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07006378 WARN("OOM_MESSAGE",
6379 "Possible unnecessary 'out of memory' message\n" . $hereprev);
6380 }
6381 }
6382
Joe Perchesf78d98f2014-10-13 15:52:01 -07006383# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08006384 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07006385 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
6386 my $level = $1;
6387 if (WARN("UNNECESSARY_KERN_LEVEL",
6388 "Possible unnecessary $level\n" . $herecurr) &&
6389 $fix) {
6390 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
6391 }
6392 }
6393
Joe Perches45c55e92017-02-24 15:01:31 -08006394# check for logging continuations
6395 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
6396 WARN("LOGGING_CONTINUATION",
6397 "Avoid logging continuation uses where feasible\n" . $herecurr);
6398 }
6399
Dwaipayan Ray70eb2272020-12-15 20:45:15 -08006400# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6401 if (defined $stat &&
6402 $line =~ /\b$logFunctions\s*\(/ &&
6403 index($stat, '"') >= 0) {
6404 my $lc = $stat =~ tr@\n@@;
6405 $lc = $lc + $linenr;
6406 my $stat_real = get_stat_real($linenr, $lc);
6407 pos($stat_real) = index($stat_real, '"');
6408 while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) {
6409 my $pspec = $1;
6410 my $h = $2;
6411 my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@;
6412 if (WARN("UNNECESSARY_MODIFIER",
6413 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") &&
6414 $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) {
6415 my $nspec = $pspec;
6416 $nspec =~ s/h//g;
6417 $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/;
6418 }
6419 }
6420 }
6421
Joe Perchesabb08a52014-12-10 15:51:46 -08006422# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07006423 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08006424 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
6425 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
6426 WARN("MASK_THEN_SHIFT",
6427 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
6428 }
6429
Joe Perchesb75ac612014-12-10 15:52:02 -08006430# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07006431 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08006432 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
6433 my $val = $1;
6434 my $equal = "!";
6435 $equal = "" if ($4 eq "!=");
6436 if (CHK("COMPARISON_TO_NULL",
6437 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
6438 $fix) {
6439 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
6440 }
6441 }
6442 }
6443
Joe Perches8716de32013-09-11 14:24:05 -07006444# check for bad placement of section $InitAttribute (e.g.: __initdata)
6445 if ($line =~ /(\b$InitAttribute\b)/) {
6446 my $attr = $1;
6447 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6448 my $ptr = $1;
6449 my $var = $2;
6450 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
6451 ERROR("MISPLACED_INIT",
6452 "$attr should be placed after $var\n" . $herecurr)) ||
6453 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
6454 WARN("MISPLACED_INIT",
6455 "$attr should be placed after $var\n" . $herecurr))) &&
6456 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006457 $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 -07006458 }
6459 }
6460 }
6461
Joe Perchese970b8842013-11-12 15:10:10 -08006462# check for $InitAttributeData (ie: __initdata) with const
6463 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
6464 my $attr = $1;
6465 $attr =~ /($InitAttributePrefix)(.*)/;
6466 my $attr_prefix = $1;
6467 my $attr_type = $2;
6468 if (ERROR("INIT_ATTRIBUTE",
6469 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
6470 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006471 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006472 s/$InitAttributeData/${attr_prefix}initconst/;
6473 }
6474 }
6475
6476# check for $InitAttributeConst (ie: __initconst) without const
6477 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
6478 my $attr = $1;
6479 if (ERROR("INIT_ATTRIBUTE",
6480 "Use of $attr requires a separate use of const\n" . $herecurr) &&
6481 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006482 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006483 /(^\+\s*(?:static\s+))/;
6484 $lead = rtrim($1);
6485 $lead = "$lead " if ($lead !~ /^\+$/);
6486 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07006487 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08006488 }
6489 }
6490
Joe Perchesc17893c2015-04-16 12:44:42 -07006491# check for __read_mostly with const non-pointer (should just be const)
6492 if ($line =~ /\b__read_mostly\b/ &&
6493 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
6494 if (ERROR("CONST_READ_MOSTLY",
6495 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
6496 $fix) {
6497 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
6498 }
6499 }
6500
Joe Perchesfbdb8132014-04-03 14:49:14 -07006501# don't use __constant_<foo> functions outside of include/uapi/
6502 if ($realfile !~ m@^include/uapi/@ &&
6503 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6504 my $constant_func = $1;
6505 my $func = $constant_func;
6506 $func =~ s/^__constant_//;
6507 if (WARN("CONSTANT_CONVERSION",
6508 "$constant_func should be $func\n" . $herecurr) &&
6509 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006510 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07006511 }
6512 }
6513
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006514# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08006515 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07006516 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006517 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07006518 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006519 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006520 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07006521 }
6522 if ($delay > 2000) {
6523 WARN("LONG_UDELAY",
6524 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006525 }
6526 }
6527
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006528# warn about unexpectedly long msleep's
6529 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
6530 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006531 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006532 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006533 }
6534 }
6535
Joe Perches36ec1932013-07-03 15:05:25 -07006536# check for comparisons of jiffies
6537 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
6538 WARN("JIFFIES_COMPARISON",
6539 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6540 }
6541
Joe Perches9d7a34a2013-07-03 15:05:26 -07006542# check for comparisons of get_jiffies_64()
6543 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
6544 WARN("JIFFIES_COMPARISON",
6545 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6546 }
6547
Andy Whitcroft00df3442007-06-08 13:47:06 -07006548# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006549# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07006550# print "#ifdef in C files should be avoided\n";
6551# print "$herecurr";
6552# $clean = 0;
6553# }
6554
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006555# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006556 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07006557 if (ERROR("SPACING",
6558 "exactly one space required after that #$1\n" . $herecurr) &&
6559 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006560 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07006561 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
6562 }
6563
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006564 }
6565
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006566# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006567 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
6568 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006569 my $which = $1;
6570 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006571 CHK("UNCOMMENTED_DEFINITION",
6572 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006573 }
6574 }
6575# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006576
6577 my $barriers = qr{
6578 mb|
6579 rmb|
Will Deaconad83ec62019-11-07 14:49:00 +00006580 wmb
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006581 }x;
6582 my $barrier_stems = qr{
6583 mb__before_atomic|
6584 mb__after_atomic|
6585 store_release|
6586 load_acquire|
6587 store_mb|
6588 (?:$barriers)
6589 }x;
6590 my $all_barriers = qr{
6591 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02006592 smp_(?:$barrier_stems)|
6593 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006594 }x;
6595
6596 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006597 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08006598 WARN("MEMORY_BARRIER",
6599 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006600 }
6601 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006602
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02006603 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6604
6605 if ($realfile !~ m@^include/asm-generic/@ &&
6606 $realfile !~ m@/barrier\.h$@ &&
6607 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6608 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6609 WARN("MEMORY_BARRIER",
6610 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6611 }
6612
Joe Perchescb426e92015-06-25 15:02:46 -07006613# check for waitqueue_active without a comment.
6614 if ($line =~ /\bwaitqueue_active\s*\(/) {
6615 if (!ctx_has_comment($first_line, $linenr)) {
6616 WARN("WAITQUEUE_ACTIVE",
6617 "waitqueue_active without comment\n" . $herecurr);
6618 }
6619 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006620
Marco Elver5099a722020-04-01 12:17:14 +02006621# check for data_race without a comment.
6622 if ($line =~ /\bdata_race\s*\(/) {
6623 if (!ctx_has_comment($first_line, $linenr)) {
6624 WARN("DATA_RACE",
6625 "data_race without comment\n" . $herecurr);
6626 }
6627 }
6628
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006629# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006630 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006631 CHK("ARCH_DEFINES",
6632 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006633 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006634
Joe Perches596ed452017-07-12 14:37:02 -07006635# check that the storage class is not after a type
6636 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006637 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07006638 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6639 }
6640# Check that the storage class is at the beginning of a declaration
6641 if ($line =~ /\b$Storage\b/ &&
6642 $line !~ /^.\s*$Storage/ &&
6643 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6644 $1 !~ /[\,\)]\s*$/) {
6645 WARN("STORAGE_CLASS",
6646 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07006647 }
6648
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006649# check the location of the inline attribute, that it is between
6650# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006651 if ($line =~ /\b$Type\s+$Inline\b/ ||
6652 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006653 ERROR("INLINE_LOCATION",
6654 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006655 }
6656
Andy Whitcroft8905a672007-11-28 16:21:06 -08006657# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08006658 if ($realfile !~ m@\binclude/uapi/@ &&
6659 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006660 if (WARN("INLINE",
6661 "plain inline is preferred over $1\n" . $herecurr) &&
6662 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006663 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006664
6665 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006666 }
6667
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006668# Check for compiler attributes
Joe Perches2b7ab452013-11-12 15:10:14 -08006669 if ($realfile !~ m@\binclude/uapi/@ &&
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006670 $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
6671 my $attr = $1;
6672 $attr =~ s/\s*\(\s*(.*)\)\s*/$1/;
Joe Perches3d130fd2011-01-12 17:00:00 -08006673
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006674 my %attr_list = (
Joe Perches0830aab2020-12-15 20:44:50 -08006675 "alias" => "__alias",
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006676 "aligned" => "__aligned",
6677 "always_inline" => "__always_inline",
6678 "assume_aligned" => "__assume_aligned",
6679 "cold" => "__cold",
6680 "const" => "__attribute_const__",
6681 "copy" => "__copy",
6682 "designated_init" => "__designated_init",
6683 "externally_visible" => "__visible",
6684 "format" => "printf|scanf",
6685 "gnu_inline" => "__gnu_inline",
6686 "malloc" => "__malloc",
6687 "mode" => "__mode",
6688 "no_caller_saved_registers" => "__no_caller_saved_registers",
6689 "noclone" => "__noclone",
6690 "noinline" => "noinline",
6691 "nonstring" => "__nonstring",
6692 "noreturn" => "__noreturn",
6693 "packed" => "__packed",
6694 "pure" => "__pure",
Joe Perches339f29d2020-12-15 20:44:43 -08006695 "section" => "__section",
Joe Perches0830aab2020-12-15 20:44:50 -08006696 "used" => "__used",
6697 "weak" => "__weak"
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006698 );
Joe Perches39b7e282011-07-25 17:13:24 -07006699
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006700 while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
Joe Perches339f29d2020-12-15 20:44:43 -08006701 my $orig_attr = $1;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006702 my $params = '';
6703 $params = $2 if defined($2);
Joe Perches339f29d2020-12-15 20:44:43 -08006704 my $curr_attr = $orig_attr;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006705 $curr_attr =~ s/^[\s_]+|[\s_]+$//g;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006706 if (exists($attr_list{$curr_attr})) {
Joe Perches339f29d2020-12-15 20:44:43 -08006707 my $new = $attr_list{$curr_attr};
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006708 if ($curr_attr eq "format" && $params) {
6709 $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
Joe Perches339f29d2020-12-15 20:44:43 -08006710 $new = "__$1\($2";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006711 } else {
Joe Perches339f29d2020-12-15 20:44:43 -08006712 $new = "$new$params";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006713 }
Joe Perches339f29d2020-12-15 20:44:43 -08006714 if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6715 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
6716 $fix) {
6717 my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
6718 $fixed[$fixlinenr] =~ s/$remove//;
6719 $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
6720 $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
6721 $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
6722 }
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006723 }
6724 }
6725
6726 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6727 if ($attr =~ /^_*unused/) {
6728 WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6729 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
Joe Perchesd5e616f2013-09-11 14:23:54 -07006730 }
Joe Perches6061d942012-03-23 15:02:16 -07006731 }
6732
Joe Perches619a9082014-12-10 15:51:35 -08006733# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07006734 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08006735 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6736 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6737 $line =~ /\b__weak\b/)) {
6738 ERROR("WEAK_DECLARATION",
6739 "Using weak declarations can have unintended link defects\n" . $herecurr);
6740 }
6741
Tomas Winklerfd39f902016-12-12 16:46:34 -08006742# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07006743 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08006744 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07006745 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6746 my $type = $1;
6747 if ($type =~ /\b($typeC99Typedefs)\b/) {
6748 $type = $1;
6749 my $kernel_type = 'u';
6750 $kernel_type = 's' if ($type =~ /^_*[si]/);
6751 $type =~ /(\d+)/;
6752 $kernel_type .= $1;
6753 if (CHK("PREFER_KERNEL_TYPES",
6754 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6755 $fix) {
6756 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6757 }
6758 }
6759 }
6760
Joe Perches938224b2016-01-20 14:59:15 -08006761# check for cast of C90 native int or longer types constants
6762 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6763 my $cast = $1;
6764 my $const = $2;
Joe Perches0972b8b2021-02-25 17:21:54 -08006765 my $suffix = "";
6766 my $newconst = $const;
6767 $newconst =~ s/${Int_type}$//;
6768 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6769 if ($cast =~ /\blong\s+long\b/) {
6770 $suffix .= 'LL';
6771 } elsif ($cast =~ /\blong\b/) {
6772 $suffix .= 'L';
6773 }
Joe Perches938224b2016-01-20 14:59:15 -08006774 if (WARN("TYPECAST_INT_CONSTANT",
Joe Perches0972b8b2021-02-25 17:21:54 -08006775 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
Joe Perches938224b2016-01-20 14:59:15 -08006776 $fix) {
Joe Perches938224b2016-01-20 14:59:15 -08006777 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6778 }
6779 }
6780
Joe Perches8f53a9b2010-03-05 13:43:48 -08006781# check for sizeof(&)
6782 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006783 WARN("SIZEOF_ADDRESS",
6784 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006785 }
6786
Joe Perches66c80b62012-07-30 14:41:22 -07006787# check for sizeof without parenthesis
6788 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006789 if (WARN("SIZEOF_PARENTHESIS",
6790 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6791 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006792 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006793 }
Joe Perches66c80b62012-07-30 14:41:22 -07006794 }
6795
Joe Perches88982fe2012-12-17 16:02:00 -08006796# check for struct spinlock declarations
6797 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6798 WARN("USE_SPINLOCK_T",
6799 "struct spinlock should be spinlock_t\n" . $herecurr);
6800 }
6801
Joe Perchesa6962d72013-04-29 16:18:13 -07006802# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006803 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006804 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006805 $fmt =~ s/%%//g;
6806 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006807 if (WARN("PREFER_SEQ_PUTS",
6808 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6809 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006810 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006811 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006812 }
6813 }
6814
Joe Perches478b1792018-04-10 16:33:34 -07006815# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006816 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006817 defined $stat &&
6818 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6819 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006820 my $stat_real;
6821
Joe Perches0b523762017-05-08 15:55:36 -07006822 my $lc = $stat =~ tr@\n@@;
6823 $lc = $lc + $linenr;
6824 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006825 my $specifier;
6826 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006827 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006828 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006829 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6830 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006831
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006832 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006833 $specifier = $1;
6834 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006835 $qualifier = $3;
Sakari Ailusaf612e42021-02-16 17:57:20 +02006836 if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006837 ($extension eq "f" &&
Sakari Ailusaf612e42021-02-16 17:57:20 +02006838 defined $qualifier && $qualifier !~ /^w/) ||
6839 ($extension eq "4" &&
6840 defined $qualifier && $qualifier !~ /^cc/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006841 $bad_specifier = $specifier;
6842 last;
6843 }
6844 if ($extension eq "x" && !defined($stat_real)) {
6845 if (!defined($stat_real)) {
6846 $stat_real = get_stat_real($linenr, $lc);
6847 }
6848 WARN("VSPRINTF_SPECIFIER_PX",
6849 "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");
6850 }
6851 }
6852 if ($bad_specifier ne "") {
6853 my $stat_real = get_stat_real($linenr, $lc);
Miguel Ojedade48fa1a2022-05-22 03:11:08 +02006854 my $msg_level = \&WARN;
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006855 my $ext_type = "Invalid";
6856 my $use = "";
6857 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006858 $use = " - use %pS instead";
6859 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
Miguel Ojedade48fa1a2022-05-22 03:11:08 +02006860 } elsif ($bad_specifier =~ /pA/) {
6861 $use = " - '%pA' is only intended to be used from Rust code";
6862 $msg_level = \&ERROR;
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006863 }
6864
Miguel Ojedade48fa1a2022-05-22 03:11:08 +02006865 &{$msg_level}("VSPRINTF_POINTER_EXTENSION",
6866 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006867 }
Joe Perches0b523762017-05-08 15:55:36 -07006868 }
6869 }
6870
Andy Whitcroft554e1652012-01-10 15:09:57 -08006871# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006872 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006873 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006874 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006875
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006876 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006877 my $ms_val = $7;
6878 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006879
Andy Whitcroft554e1652012-01-10 15:09:57 -08006880 if ($ms_size =~ /^(0x|)0$/i) {
6881 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006882 "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 -08006883 } elsif ($ms_size =~ /^(0x|)1$/i) {
6884 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006885 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6886 }
6887 }
6888
Joe Perches98a9bba2014-01-23 15:54:52 -08006889# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006890# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006891# defined $stat &&
6892# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6893# if (WARN("PREFER_ETHER_ADDR_COPY",
6894# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6895# $fix) {
6896# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6897# }
6898# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006899
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006900# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006901# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006902# defined $stat &&
6903# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6904# WARN("PREFER_ETHER_ADDR_EQUAL",
6905# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6906# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006907
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006908# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6909# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006910# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006911# defined $stat &&
6912# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6913#
6914# my $ms_val = $7;
6915#
6916# if ($ms_val =~ /^(?:0x|)0+$/i) {
6917# if (WARN("PREFER_ETH_ZERO_ADDR",
6918# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6919# $fix) {
6920# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6921# }
6922# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6923# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6924# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6925# $fix) {
6926# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6927# }
6928# }
6929# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006930
Joe Perches5dbdb2d2020-12-29 15:14:31 -08006931# strlcpy uses that should likely be strscpy
6932 if ($line =~ /\bstrlcpy\s*\(/) {
6933 WARN("STRLCPY",
6934 "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr);
6935 }
6936
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006937# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006938 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006939 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006940 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006941 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006942 my $call = $1;
6943 my $cast1 = deparenthesize($2);
6944 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006945 my $cast2 = deparenthesize($7);
6946 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006947 my $cast;
6948
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006949 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006950 $cast = "$cast1 or $cast2";
6951 } elsif ($cast1 ne "") {
6952 $cast = $cast1;
6953 } else {
6954 $cast = $cast2;
6955 }
6956 WARN("MINMAX",
6957 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006958 }
6959 }
6960
Joe Perches4a273192012-07-30 14:41:20 -07006961# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006962 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006963 defined $stat &&
6964 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6965 my $min = $1;
6966 my $max = $7;
6967 if ($min eq $max) {
6968 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006969 "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 -07006970 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6971 $min > $max) {
6972 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006973 "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 -07006974 }
6975 }
6976
Joe Perches823b7942013-11-12 15:10:15 -08006977# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006978 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006979 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006980 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006981 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6982 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6983 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6984 my $lc = $stat =~ tr@\n@@;
6985 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006986 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006987 WARN("NAKED_SSCANF",
6988 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6989 }
6990
Joe Perchesafc819a2014-06-04 16:12:08 -07006991# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006992 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006993 defined $stat &&
6994 $line =~ /\bsscanf\b/) {
6995 my $lc = $stat =~ tr@\n@@;
6996 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006997 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006998 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6999 my $format = $6;
7000 my $count = $format =~ tr@%@%@;
7001 if ($count == 1 &&
7002 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
7003 WARN("SSCANF_TO_KSTRTO",
7004 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
7005 }
7006 }
7007 }
7008
Joe Perches70dc8a42013-09-11 14:23:58 -07007009# check for new externs in .h files.
7010 if ($realfile =~ /\.h$/ &&
7011 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07007012 if (CHK("AVOID_EXTERNS",
7013 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07007014 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07007015 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07007016 }
7017 }
7018
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07007019# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007020 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07007021 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007022 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07007023 my $function_name = $1;
7024 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007025
7026 my $s = $stat;
7027 if (defined $cond) {
7028 substr($s, 0, length($cond), '');
7029 }
Kees Cookd8b44b52020-06-03 14:18:09 -07007030 if ($s =~ /^\s*;/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07007031 {
Joe Perches000d1cc12011-07-25 17:13:25 -07007032 WARN("AVOID_EXTERNS",
7033 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007034 }
7035
7036 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007037 WARN("FUNCTION_ARGUMENTS",
7038 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007039 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07007040
7041 } elsif ($realfile =~ /\.c$/ && defined $stat &&
7042 $stat =~ /^.\s*extern\s+/)
7043 {
Joe Perches000d1cc12011-07-25 17:13:25 -07007044 WARN("AVOID_EXTERNS",
7045 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07007046 }
7047
Joe Perchesa0ad7592017-07-10 15:52:19 -07007048# check for function declarations that have arguments without identifier names
7049 if (defined $stat &&
Kees Cookd8b44b52020-06-03 14:18:09 -07007050 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
7051 $1 ne "void") {
7052 my $args = trim($1);
Joe Perchesca0d8922016-10-11 13:52:16 -07007053 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
7054 my $arg = trim($1);
Kees Cookd8b44b52020-06-03 14:18:09 -07007055 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07007056 WARN("FUNCTION_ARGUMENTS",
7057 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
7058 }
7059 }
7060 }
7061
Joe Perchesa0ad7592017-07-10 15:52:19 -07007062# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07007063 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07007064 defined $stat &&
7065 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
7066 $context_function = $1;
7067
7068# check for multiline function definition with misplaced open brace
7069 my $ok = 0;
7070 my $cnt = statement_rawlines($stat);
7071 my $herectx = $here . "\n";
7072 for (my $n = 0; $n < $cnt; $n++) {
7073 my $rl = raw_line($linenr, $n);
7074 $herectx .= $rl . "\n";
7075 $ok = 1 if ($rl =~ /^[ \+]\{/);
7076 $ok = 1 if ($rl =~ /\{/ && $n == 0);
7077 last if $rl =~ /^[ \+].*\{/;
7078 }
7079 if (!$ok) {
7080 ERROR("OPEN_BRACE",
7081 "open brace '{' following function definitions go on the next line\n" . $herectx);
7082 }
7083 }
7084
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07007085# checks for new __setup's
7086 if ($rawline =~ /\b__setup\("([^"]*)"/) {
7087 my $name = $1;
7088
7089 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007090 CHK("UNDOCUMENTED_SETUP",
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07007091 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07007092 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07007093 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07007094
Joe Perchese29a70f2019-03-07 16:28:35 -08007095# check for pointless casting of alloc functions
7096 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007097 WARN("UNNECESSARY_CASTS",
7098 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07007099 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007100
Joe Perchesa640d252013-07-03 15:05:21 -07007101# alloc style
7102# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07007103 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08007104 $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 -07007105 CHK("ALLOC_SIZEOF_STRUCT",
7106 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
7107 }
7108
Gustavo A. R. Silva73f1d072022-04-26 00:32:12 -05007109# check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07007110 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07007111 defined $stat &&
Gustavo A. R. Silva73f1d072022-04-26 00:32:12 -05007112 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07007113 my $oldfunc = $3;
7114 my $a1 = $4;
7115 my $a2 = $10;
7116 my $newfunc = "kmalloc_array";
Gustavo A. R. Silva73f1d072022-04-26 00:32:12 -05007117 $newfunc = "kvmalloc_array" if ($oldfunc eq "kvmalloc");
7118 $newfunc = "kvcalloc" if ($oldfunc eq "kvzalloc");
Joe Perches60a55362014-06-04 16:12:07 -07007119 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07007120 my $r1 = $a1;
7121 my $r2 = $a2;
7122 if ($a1 =~ /^sizeof\s*\S/) {
7123 $r1 = $a2;
7124 $r2 = $a1;
7125 }
7126 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
7127 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07007128 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07007129 my $herectx = get_stat_here($linenr, $cnt, $here);
7130
Joe Perches60a55362014-06-04 16:12:07 -07007131 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07007132 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
7133 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07007134 $fix) {
Gustavo A. R. Silva73f1d072022-04-26 00:32:12 -05007135 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
Joe Perches60a55362014-06-04 16:12:07 -07007136 }
7137 }
7138 }
7139
Joe Perches972fdea2013-04-29 16:18:12 -07007140# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07007141 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07007142 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
7143 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07007144 WARN("KREALLOC_ARG_REUSE",
7145 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
7146 }
7147
Joe Perches5ce59ae2013-02-21 16:44:18 -08007148# check for alloc argument mismatch
Liao Chang39652922022-11-04 15:05:23 +08007149 if ($line =~ /\b((?:devm_)?((?:k|kv)?(calloc|malloc_array)(?:_node)?))\s*\(\s*sizeof\b/) {
Joe Perches5ce59ae2013-02-21 16:44:18 -08007150 WARN("ALLOC_ARRAY_ARGS",
7151 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
7152 }
7153
Joe Perchescaf2a542011-01-12 16:59:56 -08007154# check for multiple semicolons
7155 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07007156 if (WARN("ONE_SEMICOLON",
7157 "Statements terminations use 1 semicolon\n" . $herecurr) &&
7158 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07007159 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07007160 }
Joe Perchesd1e2ad072012-12-17 16:02:01 -08007161 }
7162
Tomas Winklercec3aaa2016-08-02 14:04:39 -07007163# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
7164 if ($realfile !~ m@^include/uapi/@ &&
7165 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08007166 my $ull = "";
7167 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
7168 if (CHK("BIT_MACRO",
7169 "Prefer using the BIT$ull macro\n" . $herecurr) &&
7170 $fix) {
7171 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
7172 }
7173 }
7174
Joe Perches50161262020-08-11 18:35:07 -07007175# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007176 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
Joe Perches50161262020-08-11 18:35:07 -07007177 WARN("IS_ENABLED_CONFIG",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007178 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
Joe Perches50161262020-08-11 18:35:07 -07007179 }
7180
Joe Perches2d632742016-05-20 17:04:00 -07007181# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007182 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 -07007183 my $config = $1;
7184 if (WARN("PREFER_IS_ENABLED",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07007185 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
Joe Perches2d632742016-05-20 17:04:00 -07007186 $fix) {
7187 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
7188 }
7189 }
7190
Joe Perchesf36d3eb2020-04-06 20:10:58 -07007191# check for /* fallthrough */ like comment, prefer fallthrough;
7192 my @fallthroughs = (
7193 'fallthrough',
7194 '@fallthrough@',
7195 'lint -fallthrough[ \t]*',
7196 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
7197 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
7198 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7199 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7200 );
7201 if ($raw_comment ne '') {
7202 foreach my $ft (@fallthroughs) {
7203 if ($raw_comment =~ /$ft/) {
7204 my $msg_level = \&WARN;
7205 $msg_level = \&CHK if ($file);
7206 &{$msg_level}("PREFER_FALLTHROUGH",
7207 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
7208 last;
7209 }
7210 }
7211 }
7212
Joe Perchesd1e2ad072012-12-17 16:02:01 -08007213# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07007214 if ($perl_version_ok &&
Joe Perchesd1e2ad072012-12-17 16:02:01 -08007215 defined $stat &&
7216 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad072012-12-17 16:02:01 -08007217 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07007218 my $herectx = get_stat_here($linenr, $cnt, $here);
7219
Joe Perchesd1e2ad072012-12-17 16:02:01 -08007220 WARN("DEFAULT_NO_BREAK",
7221 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08007222 }
7223
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007224# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07007225 if ($line =~ /\b__FUNCTION__\b/) {
7226 if (WARN("USE_FUNC",
7227 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
7228 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07007229 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07007230 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007231 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07007232
Joe Perches62ec8182015-02-13 14:38:18 -08007233# check for uses of __DATE__, __TIME__, __TIMESTAMP__
7234 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
7235 ERROR("DATE_TIME",
7236 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
7237 }
7238
Joe Perches2c924882012-03-23 15:02:20 -07007239# check for use of yield()
7240 if ($line =~ /\byield\s*\(\s*\)/) {
7241 WARN("YIELD",
7242 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
7243 }
7244
Joe Perches179f8f42013-07-03 15:05:30 -07007245# check for comparisons against true and false
7246 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
7247 my $lead = $1;
7248 my $arg = $2;
7249 my $test = $3;
7250 my $otype = $4;
7251 my $trail = $5;
7252 my $op = "!";
7253
7254 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
7255
7256 my $type = lc($otype);
7257 if ($type =~ /^(?:true|false)$/) {
7258 if (("$test" eq "==" && "$type" eq "true") ||
7259 ("$test" eq "!=" && "$type" eq "false")) {
7260 $op = "";
7261 }
7262
7263 CHK("BOOL_COMPARISON",
7264 "Using comparison to $otype is error prone\n" . $herecurr);
7265
7266## maybe suggesting a correct construct would better
7267## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
7268
7269 }
7270 }
7271
Thomas Gleixner4882720b2010-09-07 14:34:01 +00007272# check for semaphores initialized locked
7273 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007274 WARN("CONSIDER_COMPLETION",
7275 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07007276 }
Joe Perches6712d852012-03-23 15:02:20 -07007277
Joe Perches67d0a072011-10-31 17:13:10 -07007278# recommend kstrto* over simple_strto* and strict_strto*
7279 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007280 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07007281 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07007282 }
Joe Perches6712d852012-03-23 15:02:20 -07007283
Fabian Frederickae3ccc42014-06-04 16:12:10 -07007284# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07007285 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007286 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07007287 "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 -07007288 }
Joe Perches6712d852012-03-23 15:02:20 -07007289
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08007290# check for spin_is_locked(), suggest lockdep instead
7291 if ($line =~ /\bspin_is_locked\(/) {
7292 WARN("USE_LOCKDEP",
7293 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
7294 }
7295
Joe Perches9189c7e2018-09-07 15:26:18 -07007296# check for deprecated apis
7297 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
7298 my $deprecated_api = $1;
7299 my $new_api = $deprecated_apis{$deprecated_api};
7300 WARN("DEPRECATED_API",
7301 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
7302 }
7303
Joe Perches0f3c5aa2015-02-13 14:39:05 -08007304# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07007305# and avoid what seem like struct definitions 'struct foo {'
Quentin Monnetced69da12020-08-11 18:35:13 -07007306 if (defined($const_structs) &&
7307 $line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07007308 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007309 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07007310 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08007311 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07007312
7313# use of NR_CPUS is usually wrong
7314# ignore definitions of NR_CPUS and usage to define arrays as likely right
Peng Wang35cdcbf2021-02-25 17:21:44 -08007315# ignore designated initializers using NR_CPUS
Andy Whitcroft773647a2008-03-28 14:15:58 -07007316 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07007317 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
7318 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007319 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
7320 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
Peng Wang35cdcbf2021-02-25 17:21:44 -08007321 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ &&
7322 $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07007323 {
Joe Perches000d1cc12011-07-25 17:13:25 -07007324 WARN("NR_CPUS",
7325 "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 -07007326 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07007327
Joe Perches52ea8502013-11-12 15:10:09 -08007328# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7329 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
7330 ERROR("DEFINE_ARCH_HAS",
7331 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
7332 }
7333
Joe Perchesacd93622015-02-13 14:38:38 -08007334# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07007335 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08007336 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
7337 WARN("LIKELY_MISUSE",
7338 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
7339 }
7340
Joe Perchesfbe74542021-05-06 18:03:55 -07007341# return sysfs_emit(foo, fmt, ...) fmt without newline
7342 if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ &&
7343 substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) {
7344 my $offset = $+[6] - 1;
7345 if (WARN("SYSFS_EMIT",
7346 "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) &&
7347 $fix) {
7348 substr($fixed[$fixlinenr], $offset, 0) = '\\n';
7349 }
7350 }
7351
Denis Efremovde3f1862019-09-25 16:49:25 -07007352# nested likely/unlikely calls
7353 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
7354 WARN("LIKELY_MISUSE",
7355 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
7356 }
7357
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007358# whine mightly about in_atomic
7359 if ($line =~ /\bin_atomic\s*\(/) {
7360 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007361 ERROR("IN_ATOMIC",
7362 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08007363 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007364 WARN("IN_ATOMIC",
7365 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007366 }
7367 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01007368
7369# check for lockdep_set_novalidate_class
7370 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
7371 $line =~ /__lockdep_no_validate__\s*\)/ ) {
7372 if ($realfile !~ m@^kernel/lockdep@ &&
7373 $realfile !~ m@^include/linux/lockdep@ &&
7374 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007375 ERROR("LOCKDEP",
7376 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01007377 }
7378 }
Dave Jones88f88312011-01-12 16:59:59 -08007379
Joe Perchesb392c642015-04-16 12:44:16 -07007380 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
7381 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007382 WARN("EXPORTED_WORLD_WRITABLE",
7383 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08007384 }
Joe Perches24358802014-04-03 14:49:13 -07007385
Joe Perches00180462018-02-06 15:38:55 -08007386# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7387# and whether or not function naming is typical and if
7388# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07007389 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08007390 defined $stat &&
7391 $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*\)/) {
7392 my $var = $1;
7393 my $perms = $2;
7394 my $show = $3;
7395 my $store = $4;
7396 my $octal_perms = perms_to_octal($perms);
7397 if ($show =~ /^${var}_show$/ &&
7398 $store =~ /^${var}_store$/ &&
7399 $octal_perms eq "0644") {
7400 if (WARN("DEVICE_ATTR_RW",
7401 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
7402 $fix) {
7403 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7404 }
7405 } elsif ($show =~ /^${var}_show$/ &&
7406 $store =~ /^NULL$/ &&
7407 $octal_perms eq "0444") {
7408 if (WARN("DEVICE_ATTR_RO",
7409 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
7410 $fix) {
7411 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7412 }
7413 } elsif ($show =~ /^NULL$/ &&
7414 $store =~ /^${var}_store$/ &&
7415 $octal_perms eq "0200") {
7416 if (WARN("DEVICE_ATTR_WO",
7417 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
7418 $fix) {
7419 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7420 }
7421 } elsif ($octal_perms eq "0644" ||
7422 $octal_perms eq "0444" ||
7423 $octal_perms eq "0200") {
7424 my $newshow = "$show";
7425 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
7426 my $newstore = $store;
7427 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
7428 my $rename = "";
7429 if ($show ne $newshow) {
7430 $rename .= " '$show' to '$newshow'";
7431 }
7432 if ($store ne $newstore) {
7433 $rename .= " '$store' to '$newstore'";
7434 }
7435 WARN("DEVICE_ATTR_FUNCTIONS",
7436 "Consider renaming function(s)$rename\n" . $herecurr);
7437 } else {
7438 WARN("DEVICE_ATTR_PERMS",
7439 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
7440 }
7441 }
7442
Joe Perches515a2352014-04-03 14:49:24 -07007443# Mode permission misuses where it seems decimal should be octal
7444# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08007445# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7446# specific definition of not visible in sysfs.
7447# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7448# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07007449 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07007450 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07007451 $line =~ /$mode_perms_search/) {
7452 foreach my $entry (@mode_permission_funcs) {
7453 my $func = $entry->[0];
7454 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07007455
Joe Perches459cf0a2016-10-11 13:52:19 -07007456 my $lc = $stat =~ tr@\n@@;
7457 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07007458 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07007459
Joe Perches515a2352014-04-03 14:49:24 -07007460 my $skip_args = "";
7461 if ($arg_pos > 1) {
7462 $arg_pos--;
7463 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
7464 }
Joe Perchesf90774e2016-10-11 13:51:47 -07007465 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07007466 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07007467 my $val = $1;
7468 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08007469 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
7470 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
7471 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07007472 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07007473 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007474 }
7475 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08007476 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07007477 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007478 }
Joe Perches24358802014-04-03 14:49:13 -07007479 }
7480 }
7481 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007482
Joe Perches459cf0a2016-10-11 13:52:19 -07007483# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07007484 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08007485 my $oval = $1;
7486 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07007487 if (WARN("SYMBOLIC_PERMS",
7488 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7489 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08007490 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07007491 }
7492 }
7493
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007494# validate content of MODULE_LICENSE against list from include/linux/module.h
7495 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
7496 my $extracted_string = get_quoted_string($line, $rawline);
7497 my $valid_licenses = qr{
7498 GPL|
7499 GPL\ v2|
7500 GPL\ and\ additional\ rights|
7501 Dual\ BSD/GPL|
7502 Dual\ MIT/GPL|
7503 Dual\ MPL/GPL|
7504 Proprietary
7505 }x;
7506 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
7507 WARN("MODULE_LICENSE",
7508 "unknown module license " . $extracted_string . "\n" . $herecurr);
7509 }
Joe Perches6e8f42d2022-03-23 16:05:56 -07007510 if (!$file && $extracted_string eq '"GPL v2"') {
7511 if (WARN("MODULE_LICENSE",
7512 "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) &&
7513 $fix) {
7514 $fixed[$fixlinenr] =~ s/\bMODULE_LICENSE\s*\(\s*"GPL v2"\s*\)/MODULE_LICENSE("GPL")/;
7515 }
7516 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007517 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07007518
7519# check for sysctl duplicate constants
7520 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
7521 WARN("DUPLICATED_SYSCTL_CONST",
7522 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7523 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007524 }
7525
7526 # If we have no input at all, then there is nothing to report on
7527 # so just keep quiet.
7528 if ($#rawlines == -1) {
7529 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007530 }
7531
Andy Whitcroft8905a672007-11-28 16:21:06 -08007532 # In mailback mode only produce a report in the negative, for
7533 # things that appear to be patches.
7534 if ($mailback && ($clean == 1 || !$is_patch)) {
7535 exit(0);
7536 }
7537
Dwaipayan Raye73d2712020-12-15 20:44:56 -08007538 # This is not a patch, and we are in 'no-patch' mode so
Andy Whitcroft8905a672007-11-28 16:21:06 -08007539 # just keep quiet.
7540 if (!$chk_patch && !$is_patch) {
7541 exit(0);
7542 }
7543
Stafford Hornea08ffbe2017-10-03 16:16:51 -07007544 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007545 ERROR("NOT_UNIFIED_DIFF",
7546 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007547 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007548 if ($is_patch && $has_commit_log && $chk_signoff) {
7549 if ($signoff == 0) {
7550 ERROR("MISSING_SIGN_OFF",
7551 "Missing Signed-off-by: line(s)\n");
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07007552 } elsif ($authorsignoff != 1) {
7553 # authorsignoff values:
7554 # 0 -> missing sign off
7555 # 1 -> sign off identical
7556 # 2 -> names and addresses match, comments mismatch
7557 # 3 -> addresses match, names different
7558 # 4 -> names match, addresses different
7559 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7560
7561 my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";
7562
7563 if ($authorsignoff == 0) {
7564 ERROR("NO_AUTHOR_SIGN_OFF",
7565 "Missing Signed-off-by: line by nominal patch author '$author'\n");
7566 } elsif ($authorsignoff == 2) {
7567 CHK("FROM_SIGN_OFF_MISMATCH",
7568 "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
7569 } elsif ($authorsignoff == 3) {
7570 WARN("FROM_SIGN_OFF_MISMATCH",
7571 "From:/Signed-off-by: email name mismatch: $sob_msg\n");
7572 } elsif ($authorsignoff == 4) {
7573 WARN("FROM_SIGN_OFF_MISMATCH",
7574 "From:/Signed-off-by: email address mismatch: $sob_msg\n");
7575 } elsif ($authorsignoff == 5) {
7576 WARN("FROM_SIGN_OFF_MISMATCH",
7577 "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
7578 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007579 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007580 }
7581
Andy Whitcroft8905a672007-11-28 16:21:06 -08007582 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007583 if ($summary && !($clean == 1 && $quiet == 1)) {
7584 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08007585 print "total: $cnt_error errors, $cnt_warn warnings, " .
7586 (($check)? "$cnt_chk checks, " : "") .
7587 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07007588 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08007589
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007590 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07007591 # If there were any defects found and not already fixing them
7592 if (!$clean and !$fix) {
7593 print << "EOM"
7594
7595NOTE: For some of the reported defects, checkpatch may be able to
7596 mechanically convert to the typical style using --fix or --fix-inplace.
7597EOM
7598 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007599 # If there were whitespace errors which cleanpatch can fix
7600 # then suggest that.
7601 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07007602 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07007603 print << "EOM"
7604
7605NOTE: Whitespace errors detected.
7606 You may wish to use scripts/cleanpatch or scripts/cleanfile
7607EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007608 }
7609 }
7610
Joe Perchesd752fcc2014-08-06 16:11:05 -07007611 if ($clean == 0 && $fix &&
7612 ("@rawlines" ne "@fixed" ||
7613 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08007614 my $newfile = $filename;
7615 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07007616 my $linecount = 0;
7617 my $f;
7618
Joe Perchesd752fcc2014-08-06 16:11:05 -07007619 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
7620
Joe Perches3705ce52013-07-03 15:05:31 -07007621 open($f, '>', $newfile)
7622 or die "$P: Can't open $newfile for write\n";
7623 foreach my $fixed_line (@fixed) {
7624 $linecount++;
7625 if ($file) {
7626 if ($linecount > 3) {
7627 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07007628 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07007629 }
7630 } else {
7631 print $f $fixed_line . "\n";
7632 }
7633 }
7634 close($f);
7635
7636 if (!$quiet) {
7637 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07007638
Joe Perches3705ce52013-07-03 15:05:31 -07007639Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
7640
7641Do _NOT_ trust the results written to this file.
7642Do _NOT_ submit these changes without inspecting them for correctness.
7643
7644This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7645No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07007646EOM
7647 }
7648 }
7649
Joe Perchesd8469f12015-06-25 15:03:00 -07007650 if ($quiet == 0) {
7651 print "\n";
7652 if ($clean == 1) {
7653 print "$vname has no obvious style problems and is ready for submission.\n";
7654 } else {
7655 print "$vname has style problems, please review.\n";
7656 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007657 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007658 return $clean;
7659}