blob: b7dde726092196351a0cd75387225b5cd954da58 [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;
26my $tree = 1;
27my $chk_signoff = 1;
28my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070029my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080031my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070032my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070034my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070035my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070037my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080038my $summary = 1;
39my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080040my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070041my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070042my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070043my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080044my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070045my $root;
Joe Perches0f7f6352020-10-24 16:59:04 -070046my $gitroot = $ENV{'GIT_DIR'};
47$gitroot = ".git" if !defined($gitroot);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080048my %debug;
Joe Perches34456862013-07-03 15:05:34 -070049my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070050my %use_type = ();
51my @use = ();
52my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070053my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070054my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070055my $configuration_file = ".checkpatch.conf";
Joe Perchesbdc48fa2020-05-29 16:12:21 -070056my $max_line_length = 100;
Dave Hansend62a2012013-09-11 14:23:56 -070057my $ignore_perl_version = 0;
58my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070059my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070060my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070061my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070062my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070063my $conststructsfile = "$D/const_structs.checkpatch";
Quentin Monnetced69da12020-08-11 18:35:13 -070064my $typedefsfile;
John Brooks737c0762017-07-10 15:52:24 -070065my $color = "auto";
Vadim Bendebury98005e82019-03-07 16:28:38 -080066my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
Joe Perchesdbbf8692019-09-25 16:46:52 -070067# git output parsing needs US English output, so first set backtick child process LANGUAGE
68my $git_command ='export LANGUAGE=en_US.UTF-8; git';
Antonio Borneo713a09d2020-04-06 20:11:07 -070069my $tabsize = 8;
Jerome Forissier3e89ad82020-10-15 20:11:49 -070070my ${CONFIG_} = "CONFIG_";
Hannes Eder77f5b102009-09-21 17:04:37 -070071
72sub help {
73 my ($exitcode) = @_;
74
75 print << "EOM";
76Usage: $P [OPTION]... [FILE]...
77Version: $V
78
79Options:
80 -q, --quiet quiet
81 --no-tree run without a kernel tree
82 --no-signoff do not check for 'Signed-off-by' line
83 --patch treat FILE as patchfile (default)
84 --emacs emacs compile window format
85 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070086 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070087 -g, --git treat FILE as a single commit or git revision range
88 single git commit with:
89 <rev>
90 <rev>^
91 <rev>~n
92 multiple git commits with:
93 <rev1>..<rev2>
94 <rev1>...<rev2>
95 <rev>-<count>
96 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070097 -f, --file treat FILE as regular source file
98 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070099 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -0700100 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -0700101 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -0700102 --show-types show the specific message type in the output
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700103 --max-line-length=n set the maximum line length, (default $max_line_length)
104 if exceeded, warn on patches
105 requires --strict for use with --file
Vadim Bendebury56193272014-10-13 15:51:48 -0700106 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700107 --tab-size=n set the number of spaces for tab (default $tabsize)
Hannes Eder77f5b102009-09-21 17:04:37 -0700108 --root=PATH PATH to the kernel tree root
109 --no-summary suppress the per-file summary
110 --mailback only produce a report in case of warnings/errors
111 --summary-file include the filename in summary
112 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
113 'values', 'possible', 'type', and 'attr' (default
114 is all off)
115 --test-only=WORD report only warnings/errors containing WORD
116 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700117 --fix EXPERIMENTAL - may create horrible results
118 If correctable single-line errors exist, create
119 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
120 with potential errors corrected to the preferred
121 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800122 --fix-inplace EXPERIMENTAL - may create horrible results
123 Is the same as --fix, but overwrites the input
124 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700125 --ignore-perl-version override checking of perl version. expect
126 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700127 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700128 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700129 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700130 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700131 --color[=WHEN] Use colors 'always', 'never', or only when output
132 is a terminal ('auto'). Default is 'auto'.
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700133 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default
134 ${CONFIG_})
Hannes Eder77f5b102009-09-21 17:04:37 -0700135 -h, --help, --version display this help and exit
136
137When FILE is - read standard input.
138EOM
139
140 exit($exitcode);
141}
142
Joe Perches3beb42e2016-05-20 17:04:14 -0700143sub uniq {
144 my %seen;
145 return grep { !$seen{$_}++ } @_;
146}
147
148sub list_types {
149 my ($exitcode) = @_;
150
151 my $count = 0;
152
153 local $/ = undef;
154
155 open(my $script, '<', abs_path($P)) or
156 die "$P: Can't read '$P' $!\n";
157
158 my $text = <$script>;
159 close($script);
160
161 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700162 # Also catch when type or level is passed through a variable
163 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700164 push (@types, $_);
165 }
166 @types = sort(uniq(@types));
167 print("#\tMessage type\n\n");
168 foreach my $type (@types) {
169 print(++$count . "\t" . $type . "\n");
170 }
171
172 exit($exitcode);
173}
174
Joe Perches000d1cc12011-07-25 17:13:25 -0700175my $conf = which_conf($configuration_file);
176if (-f $conf) {
177 my @conf_args;
178 open(my $conffile, '<', "$conf")
179 or warn "$P: Can't find a readable $configuration_file file $!\n";
180
181 while (<$conffile>) {
182 my $line = $_;
183
184 $line =~ s/\s*\n?$//g;
185 $line =~ s/^\s*//g;
186 $line =~ s/\s+/ /g;
187
188 next if ($line =~ m/^\s*#/);
189 next if ($line =~ m/^\s*$/);
190
191 my @words = split(" ", $line);
192 foreach my $word (@words) {
193 last if ($word =~ m/^#/);
194 push (@conf_args, $word);
195 }
196 }
197 close($conffile);
198 unshift(@ARGV, @conf_args) if @conf_args;
199}
200
John Brooks737c0762017-07-10 15:52:24 -0700201# Perl's Getopt::Long allows options to take optional arguments after a space.
202# Prevent --color by itself from consuming other arguments
203foreach (@ARGV) {
204 if ($_ eq "--color" || $_ eq "-color") {
205 $_ = "--color=$color";
206 }
207}
208
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700209GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700210 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700211 'tree!' => \$tree,
212 'signoff!' => \$chk_signoff,
213 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700214 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800215 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700216 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700217 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700218 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700219 'subjective!' => \$check,
220 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700221 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700222 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700223 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700224 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800225 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700226 'min-conf-desc-length=i' => \$min_conf_desc_length,
Antonio Borneo713a09d2020-04-06 20:11:07 -0700227 'tab-size=i' => \$tabsize,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700228 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800229 'summary!' => \$summary,
230 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800231 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700232 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800233 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700234 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800235 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700236 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700237 'codespell!' => \$codespell,
238 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700239 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700240 'color=s' => \$color,
241 'no-color' => \$color, #keep old behaviors of -nocolor
242 'nocolor' => \$color, #keep old behaviors of -nocolor
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700243 'kconfig-prefix=s' => \${CONFIG_},
Hannes Eder77f5b102009-09-21 17:04:37 -0700244 'h|help' => \$help,
245 'version' => \$help
246) or help(1);
247
248help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700249
Joe Perches3beb42e2016-05-20 17:04:14 -0700250list_types(0) if ($list_types);
251
Joe Perches9624b8d2014-01-23 15:54:44 -0800252$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700253$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800254
Joe Perches32f30ca2020-06-04 16:50:40 -0700255die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
256
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700257my $exit = 0;
258
Joe Perches5b579802018-08-21 21:57:33 -0700259my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700260if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700261 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700262 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700263 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700264}
265
Allen Hubbe45107ff2016-08-02 14:04:47 -0700266#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700267if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700268 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700269}
270
John Brooks737c0762017-07-10 15:52:24 -0700271if ($color =~ /^[01]$/) {
272 $color = !$color;
273} elsif ($color =~ /^always$/i) {
274 $color = 1;
275} elsif ($color =~ /^never$/i) {
276 $color = 0;
277} elsif ($color =~ /^auto$/i) {
278 $color = (-t STDOUT);
279} else {
Joe Perches32f30ca2020-06-04 16:50:40 -0700280 die "$P: Invalid color mode: $color\n";
John Brooks737c0762017-07-10 15:52:24 -0700281}
282
Antonio Borneo713a09d2020-04-06 20:11:07 -0700283# skip TAB size 1 to avoid additional checks on $tabsize - 1
Joe Perches32f30ca2020-06-04 16:50:40 -0700284die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
Antonio Borneo713a09d2020-04-06 20:11:07 -0700285
Joe Perches91bfe482013-09-11 14:23:59 -0700286sub hash_save_array_words {
287 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700288
Joe Perches91bfe482013-09-11 14:23:59 -0700289 my @array = split(/,/, join(',', @$arrayRef));
290 foreach my $word (@array) {
291 $word =~ s/\s*\n?$//g;
292 $word =~ s/^\s*//g;
293 $word =~ s/\s+/ /g;
294 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700295
Joe Perches91bfe482013-09-11 14:23:59 -0700296 next if ($word =~ m/^\s*#/);
297 next if ($word =~ m/^\s*$/);
298
299 $hashRef->{$word}++;
300 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700301}
302
Joe Perches91bfe482013-09-11 14:23:59 -0700303sub hash_show_words {
304 my ($hashRef, $prefix) = @_;
305
Joe Perches3c816e42015-06-25 15:03:29 -0700306 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700307 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700308 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700309 print " $word";
310 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700311 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700312 }
313}
314
315hash_save_array_words(\%ignore_type, \@ignore);
316hash_save_array_words(\%use_type, \@use);
317
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800318my $dbg_values = 0;
319my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700320my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700321my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800322for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800323 ## no critic
324 eval "\${dbg_$key} = '$debug{$key}';";
325 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800326}
327
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700328my $rpt_cleaners = 0;
329
Andy Whitcroft8905a672007-11-28 16:21:06 -0800330if ($terse) {
331 $emacs = 1;
332 $quiet++;
333}
334
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700335if ($tree) {
336 if (defined $root) {
337 if (!top_of_kernel_tree($root)) {
338 die "$P: $root: --root does not point at a valid tree\n";
339 }
340 } else {
341 if (top_of_kernel_tree('.')) {
342 $root = '.';
343 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
344 top_of_kernel_tree($1)) {
345 $root = $1;
346 }
347 }
348
349 if (!defined $root) {
350 print "Must be run from the top-level dir. of a kernel tree\n";
351 exit(2);
352 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700353}
354
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700355my $emitted_corrupt = 0;
356
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700357our $Ident = qr{
358 [A-Za-z_][A-Za-z\d_]*
359 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
360 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700361our $Storage = qr{extern|static|asmlinkage};
362our $Sparse = qr{
363 __user|
364 __kernel|
365 __force|
366 __iomem|
367 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800368 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700369 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700370 __refconst|
371 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800372 __rcu|
373 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700374 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800375our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
376our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
377our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
378our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
379our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700380
Wolfram Sang52131292010-03-05 13:43:51 -0800381# Notes to $Attribute:
382# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700383our $Attribute = qr{
384 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700385 __percpu|
386 __nocast|
387 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200388 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700389 __packed__|
390 __packed2__|
391 __naked|
392 __maybe_unused|
393 __always_unused|
394 __noreturn|
395 __used|
396 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800397 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700398 __noclone|
399 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700400 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700401 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700402 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700403 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700404 ____cacheline_aligned|
405 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800406 ____cacheline_internodealigned_in_smp|
407 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700408 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700409our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700410our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700411our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
412our $Lval = qr{$Ident(?:$Member)*};
413
Joe Perches95e2c602013-07-03 15:05:20 -0700414our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
415our $Binary = qr{(?i)0b[01]+$Int_type?};
416our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
417our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700418our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800419our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800420our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
421our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
422our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800423our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700424our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800425our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700426our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700427our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700428our $Operators = qr{
429 <=|>=|==|!=|
430 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700431 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700432 }x;
433
Joe Perches91cb5192014-04-03 14:49:32 -0700434our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
435
Joe Perchesab7e23f2015-04-16 12:44:22 -0700436our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800437our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700438our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700439our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700441our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800442our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700443our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800444
Joe Perches15662b32011-10-31 17:13:12 -0700445our $NON_ASCII_UTF8 = qr{
446 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700447 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
448 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
449 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
450 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
451 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
452 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
453}x;
454
Joe Perches15662b32011-10-31 17:13:12 -0700455our $UTF8 = qr{
456 [\x09\x0A\x0D\x20-\x7E] # ASCII
457 | $NON_ASCII_UTF8
458}x;
459
Joe Perchese6176fa2015-06-25 15:02:49 -0700460our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800461our $typeOtherOSTypedefs = qr{(?x:
462 u_(?:char|short|int|long) | # bsd
463 u(?:nchar|short|int|long) # sysv
464)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700465our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700466 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700467 atomic_t
468)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700469our $typeTypedefs = qr{(?x:
470 $typeC99Typedefs\b|
471 $typeOtherOSTypedefs\b|
472 $typeKernelTypedefs\b
473)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700474
Joe Perches6d32f7a2015-11-06 16:31:37 -0800475our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
476
Joe Perches691e6692010-03-05 13:43:51 -0800477our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800478 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700479 (?:[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 -0800480 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700481 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700482 panic|
Joe Perches06668722013-11-12 15:10:07 -0800483 MODULE_[A-Z_]+|
484 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800485)};
486
Joe Perchese29a70f2019-03-07 16:28:35 -0800487our $allocFunctions = qr{(?x:
488 (?:(?:devm_)?
489 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
490 kstrdup(?:_const)? |
491 kmemdup(?:_nul)?) |
Christophe JAILLET461e1562020-04-20 18:13:58 -0700492 (?:\w+)?alloc_skb(?:_ip_align)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800493 # dev_alloc_skb/netdev_alloc_skb, et al
494 dma_alloc_coherent
495)};
496
Joe Perches20112472011-07-25 17:13:23 -0700497our $signature_tags = qr{(?xi:
498 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800499 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700500 Acked-by:|
501 Tested-by:|
502 Reviewed-by:|
503 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700504 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700505 To:|
506 Cc:
507)};
508
Aditya Srivastava831242a2020-12-15 20:45:12 -0800509sub edit_distance_min {
510 my (@arr) = @_;
511 my $len = scalar @arr;
512 if ((scalar @arr) < 1) {
513 # if underflow, return
514 return;
515 }
516 my $min = $arr[0];
517 for my $i (0 .. ($len-1)) {
518 if ($arr[$i] < $min) {
519 $min = $arr[$i];
520 }
521 }
522 return $min;
523}
524
525sub get_edit_distance {
526 my ($str1, $str2) = @_;
527 $str1 = lc($str1);
528 $str2 = lc($str2);
529 $str1 =~ s/-//g;
530 $str2 =~ s/-//g;
531 my $len1 = length($str1);
532 my $len2 = length($str2);
533 # two dimensional array storing minimum edit distance
534 my @distance;
535 for my $i (0 .. $len1) {
536 for my $j (0 .. $len2) {
537 if ($i == 0) {
538 $distance[$i][$j] = $j;
539 } elsif ($j == 0) {
540 $distance[$i][$j] = $i;
541 } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) {
542 $distance[$i][$j] = $distance[$i - 1][$j - 1];
543 } else {
544 my $dist1 = $distance[$i][$j - 1]; #insert distance
545 my $dist2 = $distance[$i - 1][$j]; # remove
546 my $dist3 = $distance[$i - 1][$j - 1]; #replace
547 $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3);
548 }
549 }
550 }
551 return $distance[$len1][$len2];
552}
553
554sub find_standard_signature {
555 my ($sign_off) = @_;
556 my @standard_signature_tags = (
557 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
558 'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
559 );
560 foreach my $signature (@standard_signature_tags) {
561 return $signature if (get_edit_distance($sign_off, $signature) <= 2);
562 }
563
564 return "";
565}
566
Joe Perches18130872014-08-06 16:11:22 -0700567our @typeListMisordered = (
568 qr{char\s+(?:un)?signed},
569 qr{int\s+(?:(?:un)?signed\s+)?short\s},
570 qr{int\s+short(?:\s+(?:un)?signed)},
571 qr{short\s+int(?:\s+(?:un)?signed)},
572 qr{(?:un)?signed\s+int\s+short},
573 qr{short\s+(?:un)?signed},
574 qr{long\s+int\s+(?:un)?signed},
575 qr{int\s+long\s+(?:un)?signed},
576 qr{long\s+(?:un)?signed\s+int},
577 qr{int\s+(?:un)?signed\s+long},
578 qr{int\s+(?:un)?signed},
579 qr{int\s+long\s+long\s+(?:un)?signed},
580 qr{long\s+long\s+int\s+(?:un)?signed},
581 qr{long\s+long\s+(?:un)?signed\s+int},
582 qr{long\s+long\s+(?:un)?signed},
583 qr{long\s+(?:un)?signed},
584);
585
Andy Whitcroft8905a672007-11-28 16:21:06 -0800586our @typeList = (
587 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700588 qr{(?:(?:un)?signed\s+)?char},
589 qr{(?:(?:un)?signed\s+)?short\s+int},
590 qr{(?:(?:un)?signed\s+)?short},
591 qr{(?:(?:un)?signed\s+)?int},
592 qr{(?:(?:un)?signed\s+)?long\s+int},
593 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
594 qr{(?:(?:un)?signed\s+)?long\s+long},
595 qr{(?:(?:un)?signed\s+)?long},
596 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800597 qr{float},
598 qr{double},
599 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800600 qr{struct\s+$Ident},
601 qr{union\s+$Ident},
602 qr{enum\s+$Ident},
603 qr{${Ident}_t},
604 qr{${Ident}_handler},
605 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700606 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800607);
Joe Perches938224b2016-01-20 14:59:15 -0800608
609our $C90_int_types = qr{(?x:
610 long\s+long\s+int\s+(?:un)?signed|
611 long\s+long\s+(?:un)?signed\s+int|
612 long\s+long\s+(?:un)?signed|
613 (?:(?:un)?signed\s+)?long\s+long\s+int|
614 (?:(?:un)?signed\s+)?long\s+long|
615 int\s+long\s+long\s+(?:un)?signed|
616 int\s+(?:(?:un)?signed\s+)?long\s+long|
617
618 long\s+int\s+(?:un)?signed|
619 long\s+(?:un)?signed\s+int|
620 long\s+(?:un)?signed|
621 (?:(?:un)?signed\s+)?long\s+int|
622 (?:(?:un)?signed\s+)?long|
623 int\s+long\s+(?:un)?signed|
624 int\s+(?:(?:un)?signed\s+)?long|
625
626 int\s+(?:un)?signed|
627 (?:(?:un)?signed\s+)?int
628)};
629
Alex Dowad485ff232015-06-25 15:02:52 -0700630our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700631our @typeListWithAttr = (
632 @typeList,
633 qr{struct\s+$InitAttribute\s+$Ident},
634 qr{union\s+$InitAttribute\s+$Ident},
635);
636
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700637our @modifierList = (
638 qr{fastcall},
639);
Alex Dowad485ff232015-06-25 15:02:52 -0700640our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800641
Joe Perches24358802014-04-03 14:49:13 -0700642our @mode_permission_funcs = (
643 ["module_param", 3],
644 ["module_param_(?:array|named|string)", 4],
645 ["module_param_array_named", 5],
646 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
647 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700648 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
649 ["IIO_DEV_ATTR_[A-Z_]+", 1],
650 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
651 ["SENSOR_TEMPLATE(?:_2|)", 3],
652 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700653);
654
Joe Perches1a3dcf22020-08-11 18:35:16 -0700655my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
656
Joe Perches515a2352014-04-03 14:49:24 -0700657#Create a search pattern for all these functions to speed up a loop below
658our $mode_perms_search = "";
659foreach my $entry (@mode_permission_funcs) {
660 $mode_perms_search .= '|' if ($mode_perms_search ne "");
661 $mode_perms_search .= $entry->[0];
662}
Joe Perches00180462018-02-06 15:38:55 -0800663$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700664
Joe Perches9189c7e2018-09-07 15:26:18 -0700665our %deprecated_apis = (
666 "synchronize_rcu_bh" => "synchronize_rcu",
667 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
668 "call_rcu_bh" => "call_rcu",
669 "rcu_barrier_bh" => "rcu_barrier",
670 "synchronize_sched" => "synchronize_rcu",
671 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
672 "call_rcu_sched" => "call_rcu",
673 "rcu_barrier_sched" => "rcu_barrier",
674 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
675 "cond_synchronize_sched" => "cond_synchronize_rcu",
676);
677
678#Create a search pattern for all these strings to speed up a loop below
679our $deprecated_apis_search = "";
680foreach my $entry (keys %deprecated_apis) {
681 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
682 $deprecated_apis_search .= $entry;
683}
684$deprecated_apis_search = "(?:${deprecated_apis_search})";
685
Joe Perchesb392c642015-04-16 12:44:16 -0700686our $mode_perms_world_writable = qr{
687 S_IWUGO |
688 S_IWOTH |
689 S_IRWXUGO |
690 S_IALLUGO |
691 0[0-7][0-7][2367]
692}x;
693
Joe Perchesf90774e2016-10-11 13:51:47 -0700694our %mode_permission_string_types = (
695 "S_IRWXU" => 0700,
696 "S_IRUSR" => 0400,
697 "S_IWUSR" => 0200,
698 "S_IXUSR" => 0100,
699 "S_IRWXG" => 0070,
700 "S_IRGRP" => 0040,
701 "S_IWGRP" => 0020,
702 "S_IXGRP" => 0010,
703 "S_IRWXO" => 0007,
704 "S_IROTH" => 0004,
705 "S_IWOTH" => 0002,
706 "S_IXOTH" => 0001,
707 "S_IRWXUGO" => 0777,
708 "S_IRUGO" => 0444,
709 "S_IWUGO" => 0222,
710 "S_IXUGO" => 0111,
711);
712
713#Create a search pattern for all these strings to speed up a loop below
714our $mode_perms_string_search = "";
715foreach my $entry (keys %mode_permission_string_types) {
716 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
717 $mode_perms_string_search .= $entry;
718}
Joe Perches00180462018-02-06 15:38:55 -0800719our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
720our $multi_mode_perms_string_search = qr{
721 ${single_mode_perms_string_search}
722 (?:\s*\|\s*${single_mode_perms_string_search})*
723}x;
724
725sub perms_to_octal {
726 my ($string) = @_;
727
728 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
729
730 my $val = "";
731 my $oval = "";
732 my $to = 0;
733 my $curpos = 0;
734 my $lastpos = 0;
735 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
736 $curpos = pos($string);
737 my $match = $2;
738 my $omatch = $1;
739 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
740 $lastpos = $curpos;
741 $to |= $mode_permission_string_types{$match};
742 $val .= '\s*\|\s*' if ($val ne "");
743 $val .= $match;
744 $oval .= $omatch;
745 }
746 $oval =~ s/^\s*\|\s*//;
747 $oval =~ s/\s*\|\s*$//;
748 return sprintf("%04o", $to);
749}
Joe Perchesf90774e2016-10-11 13:51:47 -0700750
Wolfram Sang7840a942010-08-09 17:20:57 -0700751our $allowed_asm_includes = qr{(?x:
752 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700753 memory|
754 time|
755 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700756)};
757# memory.h: ARM has a custom one
758
Kees Cook66b47b42014-10-13 15:51:57 -0700759# Load common spelling mistakes and build regular expression list.
760my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700761my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700762
Joe Perches36061e32014-12-10 15:51:43 -0800763if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800764 while (<$spelling>) {
765 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700766
Joe Perches36061e32014-12-10 15:51:43 -0800767 $line =~ s/\s*\n?$//g;
768 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700769
Joe Perches36061e32014-12-10 15:51:43 -0800770 next if ($line =~ m/^\s*#/);
771 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700772
Joe Perches36061e32014-12-10 15:51:43 -0800773 my ($suspect, $fix) = split(/\|\|/, $line);
774
Joe Perches36061e32014-12-10 15:51:43 -0800775 $spelling_fix{$suspect} = $fix;
776 }
777 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800778} else {
779 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700780}
Kees Cook66b47b42014-10-13 15:51:57 -0700781
Joe Perchesebfd7d62015-04-16 12:44:14 -0700782if ($codespell) {
783 if (open(my $spelling, '<', $codespellfile)) {
784 while (<$spelling>) {
785 my $line = $_;
786
787 $line =~ s/\s*\n?$//g;
788 $line =~ s/^\s*//g;
789
790 next if ($line =~ m/^\s*#/);
791 next if ($line =~ m/^\s*$/);
792 next if ($line =~ m/, disabled/i);
793
794 $line =~ s/,.*$//;
795
796 my ($suspect, $fix) = split(/->/, $line);
797
798 $spelling_fix{$suspect} = $fix;
799 }
800 close($spelling);
801 } else {
802 warn "No codespell typos will be found - file '$codespellfile': $!\n";
803 }
804}
805
806$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
807
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700808sub read_words {
809 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700810
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700811 if (open(my $words, '<', $file)) {
812 while (<$words>) {
813 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700814
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700815 $line =~ s/\s*\n?$//g;
816 $line =~ s/^\s*//g;
817
818 next if ($line =~ m/^\s*#/);
819 next if ($line =~ m/^\s*$/);
820 if ($line =~ /\s/) {
821 print("$file: '$line' invalid - ignored\n");
822 next;
823 }
824
Quentin Monnetced69da12020-08-11 18:35:13 -0700825 $$wordsRef .= '|' if (defined $$wordsRef);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700826 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700827 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700828 close($file);
829 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700830 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700831
832 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700833}
834
Quentin Monnetced69da12020-08-11 18:35:13 -0700835my $const_structs;
836if (show_type("CONST_STRUCT")) {
837 read_words(\$const_structs, $conststructsfile)
838 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
839}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700840
Quentin Monnetced69da12020-08-11 18:35:13 -0700841if (defined($typedefsfile)) {
842 my $typeOtherTypedefs;
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700843 read_words(\$typeOtherTypedefs, $typedefsfile)
844 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
Quentin Monnetced69da12020-08-11 18:35:13 -0700845 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700846}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700847
Andy Whitcroft8905a672007-11-28 16:21:06 -0800848sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700849 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
850 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700851 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700852 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700853 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700854 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700855 (?:$typeTypedefs\b)|
856 (?:${all}\b)
857 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800858 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700859 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800860 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800861 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700862 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700863 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800864 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700865 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800866 }x;
Joe Perches18130872014-08-06 16:11:22 -0700867 $NonptrTypeMisordered = qr{
868 (?:$Modifier\s+|const\s+)*
869 (?:
870 (?:${Misordered}\b)
871 )
872 (?:\s+$Modifier|\s+const)*
873 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700874 $NonptrTypeWithAttr = qr{
875 (?:$Modifier\s+|const\s+)*
876 (?:
877 (?:typeof|__typeof__)\s*\([^\)]*\)|
878 (?:$typeTypedefs\b)|
879 (?:${allWithAttr}\b)
880 )
881 (?:\s+$Modifier|\s+const)*
882 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800883 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700884 $NonptrType
Antonio Borneo7b184962020-04-06 20:11:04 -0700885 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700886 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800887 }x;
Joe Perches18130872014-08-06 16:11:22 -0700888 $TypeMisordered = qr{
889 $NonptrTypeMisordered
Antonio Borneo7b184962020-04-06 20:11:04 -0700890 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Perches18130872014-08-06 16:11:22 -0700891 (?:\s+$Inline|\s+$Modifier)*
892 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700893 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700894 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800895}
896build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700897
Joe Perches7d2367a2011-07-25 17:13:22 -0700898our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700899
900# Using $balanced_parens, $LvalOrFunc, or $FuncArg
901# requires at least perl version v5.10.0
902# Any use must be runtime checked with $^V
903
904our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700905our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800906our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700907
Joe Perchesf8422302014-08-06 16:11:31 -0700908our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700909 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700910 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700911 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700912)};
913
Aditya Srivastava8d0325c2020-12-15 20:44:24 -0800914our %allow_repeated_words = (
915 add => '',
916 added => '',
917 bad => '',
918 be => '',
919);
920
Joe Perches7d2367a2011-07-25 17:13:22 -0700921sub deparenthesize {
922 my ($string) = @_;
923 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700924
925 while ($string =~ /^\s*\(.*\)\s*$/) {
926 $string =~ s@^\s*\(\s*@@;
927 $string =~ s@\s*\)\s*$@@;
928 }
929
Joe Perches7d2367a2011-07-25 17:13:22 -0700930 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700931
Joe Perches7d2367a2011-07-25 17:13:22 -0700932 return $string;
933}
934
Joe Perches34456862013-07-03 15:05:34 -0700935sub seed_camelcase_file {
936 my ($file) = @_;
937
938 return if (!(-f $file));
939
940 local $/;
941
942 open(my $include_file, '<', "$file")
943 or warn "$P: Can't read '$file' $!\n";
944 my $text = <$include_file>;
945 close($include_file);
946
947 my @lines = split('\n', $text);
948
949 foreach my $line (@lines) {
950 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
951 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
952 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800953 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
954 $camelcase{$1} = 1;
955 } 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 -0700956 $camelcase{$1} = 1;
957 }
958 }
959}
960
Joe Perchescd28b112019-12-04 16:52:09 -0800961our %maintained_status = ();
962
Joe Perches85b0ee12016-10-11 13:51:44 -0700963sub is_maintained_obsolete {
964 my ($filename) = @_;
965
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800966 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700967
Joe Perchescd28b112019-12-04 16:52:09 -0800968 if (!exists($maintained_status{$filename})) {
969 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
970 }
Joe Perches85b0ee12016-10-11 13:51:44 -0700971
Joe Perchescd28b112019-12-04 16:52:09 -0800972 return $maintained_status{$filename} =~ /obsolete/i;
Joe Perches85b0ee12016-10-11 13:51:44 -0700973}
974
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700975sub is_SPDX_License_valid {
976 my ($license) = @_;
977
Joe Perches0f7f6352020-10-24 16:59:04 -0700978 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700979
Joe Perches56294112018-08-21 21:58:04 -0700980 my $root_path = abs_path($root);
981 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700982 return 0 if ($status ne "");
983 return 1;
984}
985
Joe Perches34456862013-07-03 15:05:34 -0700986my $camelcase_seeded = 0;
987sub seed_camelcase_includes {
988 return if ($camelcase_seeded);
989
990 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700991 my $camelcase_cache = "";
992 my @include_files = ();
993
994 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700995
Joe Perches0f7f6352020-10-24 16:59:04 -0700996 if (-e "$gitroot") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700997 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -0700998 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700999 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -07001000 } else {
Joe Perchesc707a812013-07-08 16:00:43 -07001001 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -07001002 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -07001003 @include_files = split('\n', $files);
1004 foreach my $file (@include_files) {
1005 my $date = POSIX::strftime("%Y%m%d%H%M",
1006 localtime((stat $file)[9]));
1007 $last_mod_date = $date if ($last_mod_date < $date);
1008 }
1009 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -07001010 }
Joe Perchesc707a812013-07-08 16:00:43 -07001011
1012 if ($camelcase_cache ne "" && -f $camelcase_cache) {
1013 open(my $camelcase_file, '<', "$camelcase_cache")
1014 or warn "$P: Can't read '$camelcase_cache' $!\n";
1015 while (<$camelcase_file>) {
1016 chomp;
1017 $camelcase{$_} = 1;
1018 }
1019 close($camelcase_file);
1020
1021 return;
1022 }
1023
Joe Perches0f7f6352020-10-24 16:59:04 -07001024 if (-e "$gitroot") {
Joe Perchesdbbf8692019-09-25 16:46:52 -07001025 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -07001026 @include_files = split('\n', $files);
1027 }
1028
Joe Perches34456862013-07-03 15:05:34 -07001029 foreach my $file (@include_files) {
1030 seed_camelcase_file($file);
1031 }
Joe Perches351b2a12013-07-03 15:05:36 -07001032
Joe Perchesc707a812013-07-08 16:00:43 -07001033 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -07001034 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -07001035 open(my $camelcase_file, '>', "$camelcase_cache")
1036 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -07001037 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
1038 print $camelcase_file ("$_\n");
1039 }
1040 close($camelcase_file);
1041 }
Joe Perches34456862013-07-03 15:05:34 -07001042}
1043
Joe Perchesf5f61322020-10-15 20:12:12 -07001044sub git_is_single_file {
1045 my ($filename) = @_;
1046
1047 return 0 if ((which("git") eq "") || !(-e "$gitroot"));
1048
1049 my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
1050 my $count = $output =~ tr/\n//;
1051 return $count eq 1 && $output =~ m{^${filename}$};
1052}
1053
Joe Perchesd311cd42014-08-06 16:10:57 -07001054sub git_commit_info {
1055 my ($commit, $id, $desc) = @_;
1056
Joe Perches0f7f6352020-10-24 16:59:04 -07001057 return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
Joe Perchesd311cd42014-08-06 16:10:57 -07001058
Joe Perchesdbbf8692019-09-25 16:46:52 -07001059 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -07001060 $output =~ s/^\s*//gm;
1061 my @lines = split("\n", $output);
1062
Joe Perches0d7835f2015-02-13 14:38:35 -08001063 return ($id, $desc) if ($#lines < 0);
1064
Sean Christopherson5a7f4452019-09-25 16:46:49 -07001065 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -07001066# Maybe one day convert this block of bash into something that returns
1067# all matching commit ids, but it's very slow...
1068#
1069# echo "checking commits $1..."
1070# git rev-list --remotes | grep -i "^$1" |
1071# while read line ; do
1072# git log --format='%H %s' -1 $line |
1073# echo "commit $(cut -c 1-12,41-)"
1074# done
1075 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07001076 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -07001077 } else {
1078 $id = substr($lines[0], 0, 12);
1079 $desc = substr($lines[0], 41);
1080 }
1081
1082 return ($id, $desc);
1083}
1084
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001085$chk_signoff = 0 if ($file);
1086
Andy Whitcroft00df3442007-06-08 13:47:06 -07001087my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001088my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001089my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001090my @fixed_inserted = ();
1091my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001092my $fixlinenr = -1;
1093
Du, Changbin4a593c32016-05-20 17:04:16 -07001094# If input is git commits, extract all commits from the commit expressions.
1095# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
Joe Perches0f7f6352020-10-24 16:59:04 -07001096die "$P: No git repository found\n" if ($git && !-e "$gitroot");
Du, Changbin4a593c32016-05-20 17:04:16 -07001097
1098if ($git) {
1099 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001100 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001101 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001102 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1103 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001104 } elsif ($commit_expr =~ m/\.\./) {
1105 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001106 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001107 $git_range = "-1 $commit_expr";
1108 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001109 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001110 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001111 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1112 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001113 my $sha1 = $1;
1114 my $subject = $2;
1115 unshift(@commits, $sha1);
1116 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001117 }
1118 }
1119 die "$P: no git commits after extraction!\n" if (@commits == 0);
1120 @ARGV = @commits;
1121}
1122
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001123my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001124$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001125for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001126 my $FILE;
Joe Perchesf5f61322020-10-15 20:12:12 -07001127 my $is_git_file = git_is_single_file($filename);
1128 my $oldfile = $file;
1129 $file = 1 if ($is_git_file);
Du, Changbin4a593c32016-05-20 17:04:16 -07001130 if ($git) {
1131 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1132 die "$P: $filename: git format-patch failed - $!\n";
1133 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001134 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001135 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001136 } elsif ($filename eq '-') {
1137 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001138 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001139 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001140 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001141 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001142 if ($filename eq '-') {
1143 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001144 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001145 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001146 } else {
1147 $vname = $filename;
1148 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001149 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001150 chomp;
1151 push(@rawlines, $_);
Geert Uytterhoevenc7f574d2020-06-04 16:50:43 -07001152 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001153 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001154 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001155
1156 if ($#ARGV > 0 && $quiet == 0) {
1157 print '-' x length($vname) . "\n";
1158 print "$vname\n";
1159 print '-' x length($vname) . "\n";
1160 }
1161
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001162 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001163 $exit = 1;
1164 }
1165 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001166 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001167 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001168 @fixed_inserted = ();
1169 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001170 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001171 @modifierListFile = ();
1172 @typeListFile = ();
1173 build_types();
Joe Perchesf5f61322020-10-15 20:12:12 -07001174 $file = $oldfile if ($is_git_file);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001175}
1176
Joe Perchesd8469f12015-06-25 15:03:00 -07001177if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001178 hash_show_words(\%use_type, "Used");
1179 hash_show_words(\%ignore_type, "Ignored");
1180
Joe Perches5b579802018-08-21 21:57:33 -07001181 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001182 print << "EOM"
1183
1184NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001185 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001186EOM
1187 }
1188 if ($exit) {
1189 print << "EOM"
1190
1191NOTE: If any of the errors are false positives, please report
1192 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1193EOM
1194 }
1195}
1196
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001197exit($exit);
1198
1199sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001200 my ($root) = @_;
1201
1202 my @tree_check = (
1203 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1204 "README", "Documentation", "arch", "include", "drivers",
1205 "fs", "init", "ipc", "kernel", "lib", "scripts",
1206 );
1207
1208 foreach my $check (@tree_check) {
1209 if (! -e $root . '/' . $check) {
1210 return 0;
1211 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001212 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001213 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001214}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001215
Joe Perches20112472011-07-25 17:13:23 -07001216sub parse_email {
1217 my ($formatted_email) = @_;
1218
1219 my $name = "";
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001220 my $quoted = "";
Joe Perchesdfa05c22020-04-06 20:10:48 -07001221 my $name_comment = "";
Joe Perches20112472011-07-25 17:13:23 -07001222 my $address = "";
1223 my $comment = "";
1224
1225 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1226 $name = $1;
1227 $address = $2;
1228 $comment = $3 if defined $3;
1229 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1230 $address = $1;
1231 $comment = $2 if defined $2;
1232 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1233 $address = $1;
1234 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001235 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001236 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001237 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001238 $name =~ s/^\"|\"$//g;
1239 # If there's a name left after stripping spaces and
1240 # leading quotes, and the address doesn't have both
1241 # leading and trailing angle brackets, the address
1242 # is invalid. ie:
1243 # "joe smith joe@smith.com" bad
1244 # "joe smith <joe@smith.com" bad
1245 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1246 $name = "";
1247 $address = "";
1248 $comment = "";
1249 }
1250 }
1251
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001252 # Extract comments from names excluding quoted parts
1253 # "John D. (Doe)" - Do not extract
1254 if ($name =~ s/\"(.+)\"//) {
1255 $quoted = $1;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001256 }
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001257 while ($name =~ s/\s*($balanced_parens)\s*/ /) {
1258 $name_comment .= trim($1);
1259 }
1260 $name =~ s/^[ \"]+|[ \"]+$//g;
1261 $name = trim("$quoted $name");
1262
Joe Perches3705ce52013-07-03 15:05:31 -07001263 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001264 $address =~ s/^\<|\>$//g;
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001265 $comment = trim($comment);
Joe Perches20112472011-07-25 17:13:23 -07001266
1267 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1268 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1269 $name = "\"$name\"";
1270 }
1271
Joe Perchesdfa05c22020-04-06 20:10:48 -07001272 return ($name, $name_comment, $address, $comment);
Joe Perches20112472011-07-25 17:13:23 -07001273}
1274
1275sub format_email {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001276 my ($name, $name_comment, $address, $comment) = @_;
Joe Perches20112472011-07-25 17:13:23 -07001277
1278 my $formatted_email;
1279
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001280 $name =~ s/^[ \"]+|[ \"]+$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001281 $address = trim($address);
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001282 $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes
Joe Perches20112472011-07-25 17:13:23 -07001283
1284 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1285 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1286 $name = "\"$name\"";
1287 }
1288
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001289 $name_comment = trim($name_comment);
1290 $name_comment = " $name_comment" if ($name_comment ne "");
1291 $comment = trim($comment);
1292 $comment = " $comment" if ($comment ne "");
1293
Joe Perches20112472011-07-25 17:13:23 -07001294 if ("$name" eq "") {
1295 $formatted_email = "$address";
1296 } else {
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001297 $formatted_email = "$name$name_comment <$address>";
Joe Perches20112472011-07-25 17:13:23 -07001298 }
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001299 $formatted_email .= "$comment";
Joe Perches20112472011-07-25 17:13:23 -07001300 return $formatted_email;
1301}
1302
Joe Perchesdfa05c22020-04-06 20:10:48 -07001303sub reformat_email {
1304 my ($email) = @_;
1305
1306 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001307 return format_email($email_name, $name_comment, $email_address, $comment);
Joe Perchesdfa05c22020-04-06 20:10:48 -07001308}
1309
1310sub same_email_addresses {
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08001311 my ($email1, $email2) = @_;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001312
1313 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1314 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1315
1316 return $email1_name eq $email2_name &&
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07001317 $email1_address eq $email2_address &&
1318 $name1_comment eq $name2_comment &&
1319 $comment1 eq $comment2;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001320}
1321
Joe Perchesd311cd42014-08-06 16:10:57 -07001322sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001323 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001324
Joe Perchesbd474ca2014-08-06 16:11:10 -07001325 foreach my $path (split(/:/, $ENV{PATH})) {
1326 if (-e "$path/$bin") {
1327 return "$path/$bin";
1328 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001329 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001330
Joe Perchesbd474ca2014-08-06 16:11:10 -07001331 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001332}
1333
Joe Perches000d1cc12011-07-25 17:13:25 -07001334sub which_conf {
1335 my ($conf) = @_;
1336
1337 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1338 if (-e "$path/$conf") {
1339 return "$path/$conf";
1340 }
1341 }
1342
1343 return "";
1344}
1345
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001346sub expand_tabs {
1347 my ($str) = @_;
1348
1349 my $res = '';
1350 my $n = 0;
1351 for my $c (split(//, $str)) {
1352 if ($c eq "\t") {
1353 $res .= ' ';
1354 $n++;
Antonio Borneo713a09d2020-04-06 20:11:07 -07001355 for (; ($n % $tabsize) != 0; $n++) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001356 $res .= ' ';
1357 }
1358 next;
1359 }
1360 $res .= $c;
1361 $n++;
1362 }
1363
1364 return $res;
1365}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001366sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001367 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001368 return $res;
1369}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001370
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001371sub line_stats {
1372 my ($line) = @_;
1373
1374 # Drop the diff line leader and expand tabs
1375 $line =~ s/^.//;
1376 $line = expand_tabs($line);
1377
1378 # Pick the indent from the front of the line.
1379 my ($white) = ($line =~ /^(\s*)/);
1380
1381 return (length($line), length($white));
1382}
1383
Andy Whitcroft773647a2008-03-28 14:15:58 -07001384my $sanitise_quote = '';
1385
1386sub sanitise_line_reset {
1387 my ($in_comment) = @_;
1388
1389 if ($in_comment) {
1390 $sanitise_quote = '*/';
1391 } else {
1392 $sanitise_quote = '';
1393 }
1394}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001395sub sanitise_line {
1396 my ($line) = @_;
1397
1398 my $res = '';
1399 my $l = '';
1400
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001401 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001402 my $off = 0;
1403 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001404
Andy Whitcroft773647a2008-03-28 14:15:58 -07001405 # Always copy over the diff marker.
1406 $res = substr($line, 0, 1);
1407
1408 for ($off = 1; $off < length($line); $off++) {
1409 $c = substr($line, $off, 1);
1410
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001411 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001412 # and end, all to $;.
1413 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1414 $sanitise_quote = '*/';
1415
1416 substr($res, $off, 2, "$;$;");
1417 $off++;
1418 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001419 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001420 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001421 $sanitise_quote = '';
1422 substr($res, $off, 2, "$;$;");
1423 $off++;
1424 next;
1425 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001426 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1427 $sanitise_quote = '//';
1428
1429 substr($res, $off, 2, $sanitise_quote);
1430 $off++;
1431 next;
1432 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001433
1434 # A \ in a string means ignore the next character.
1435 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1436 $c eq "\\") {
1437 substr($res, $off, 2, 'XX');
1438 $off++;
1439 next;
1440 }
1441 # Regular quotes.
1442 if ($c eq "'" || $c eq '"') {
1443 if ($sanitise_quote eq '') {
1444 $sanitise_quote = $c;
1445
1446 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001447 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001448 } elsif ($sanitise_quote eq $c) {
1449 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001450 }
1451 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001452
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001453 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001454 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1455 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001456 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1457 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001458 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1459 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001460 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001461 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001462 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001463 }
1464
Daniel Walker113f04a2009-09-21 17:04:35 -07001465 if ($sanitise_quote eq '//') {
1466 $sanitise_quote = '';
1467 }
1468
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001469 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001470 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001471 my $clean = 'X' x length($1);
1472 $res =~ s@\<.*\>@<$clean>@;
1473
1474 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001475 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001476 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001477 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001478 }
1479
Joe Perchesdadf6802016-08-02 14:04:33 -07001480 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1481 my $match = $1;
1482 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1483 }
1484
Andy Whitcroft00df3442007-06-08 13:47:06 -07001485 return $res;
1486}
1487
Joe Perchesa6962d72013-04-29 16:18:13 -07001488sub get_quoted_string {
1489 my ($line, $rawline) = @_;
1490
Joe Perches478b1792018-04-10 16:33:34 -07001491 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001492 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001493 return substr($rawline, $-[0], $+[0] - $-[0]);
1494}
1495
Andy Whitcroft8905a672007-11-28 16:21:06 -08001496sub ctx_statement_block {
1497 my ($linenr, $remain, $off) = @_;
1498 my $line = $linenr - 1;
1499 my $blk = '';
1500 my $soff = $off;
1501 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001502 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001503
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001504 my $loff = 0;
1505
Andy Whitcroft8905a672007-11-28 16:21:06 -08001506 my $type = '';
1507 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001508 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001509 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001510 my $c;
1511 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001512
1513 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001514 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001515 @stack = (['', 0]) if ($#stack == -1);
1516
Andy Whitcroft773647a2008-03-28 14:15:58 -07001517 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001518 # If we are about to drop off the end, pull in more
1519 # context.
1520 if ($off >= $len) {
1521 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001522 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001523 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001524 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001525 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001526 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001527 $len = length($blk);
1528 $line++;
1529 last;
1530 }
1531 # Bail if there is no further context.
1532 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001533 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001534 last;
1535 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001536 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1537 $level++;
1538 $type = '#';
1539 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001540 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001541 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001542 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001543 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001544
Andy Whitcroft773647a2008-03-28 14:15:58 -07001545 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001546
1547 # Handle nested #if/#else.
1548 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1549 push(@stack, [ $type, $level ]);
1550 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1551 ($type, $level) = @{$stack[$#stack - 1]};
1552 } elsif ($remainder =~ /^#\s*endif\b/) {
1553 ($type, $level) = @{pop(@stack)};
1554 }
1555
Andy Whitcroft8905a672007-11-28 16:21:06 -08001556 # Statement ends at the ';' or a close '}' at the
1557 # outermost level.
1558 if ($level == 0 && $c eq ';') {
1559 last;
1560 }
1561
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001562 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001563 if ($level == 0 && $coff_set == 0 &&
1564 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1565 $remainder =~ /^(else)(?:\s|{)/ &&
1566 $remainder !~ /^else\s+if\b/) {
1567 $coff = $off + length($1) - 1;
1568 $coff_set = 1;
1569 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1570 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001571 }
1572
Andy Whitcroft8905a672007-11-28 16:21:06 -08001573 if (($type eq '' || $type eq '(') && $c eq '(') {
1574 $level++;
1575 $type = '(';
1576 }
1577 if ($type eq '(' && $c eq ')') {
1578 $level--;
1579 $type = ($level != 0)? '(' : '';
1580
1581 if ($level == 0 && $coff < $soff) {
1582 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001583 $coff_set = 1;
1584 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001585 }
1586 }
1587 if (($type eq '' || $type eq '{') && $c eq '{') {
1588 $level++;
1589 $type = '{';
1590 }
1591 if ($type eq '{' && $c eq '}') {
1592 $level--;
1593 $type = ($level != 0)? '{' : '';
1594
1595 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001596 if (substr($blk, $off + 1, 1) eq ';') {
1597 $off++;
1598 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001599 last;
1600 }
1601 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001602 # Preprocessor commands end at the newline unless escaped.
1603 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1604 $level--;
1605 $type = '';
1606 $off++;
1607 last;
1608 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001609 $off++;
1610 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001611 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001612 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001613 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001614 $line++;
1615 $remain--;
1616 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001617
1618 my $statement = substr($blk, $soff, $off - $soff + 1);
1619 my $condition = substr($blk, $soff, $coff - $soff + 1);
1620
1621 #warn "STATEMENT<$statement>\n";
1622 #warn "CONDITION<$condition>\n";
1623
Andy Whitcroft773647a2008-03-28 14:15:58 -07001624 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001625
1626 return ($statement, $condition,
1627 $line, $remain + 1, $off - $loff + 1, $level);
1628}
1629
Andy Whitcroftcf655042008-03-04 14:28:20 -08001630sub statement_lines {
1631 my ($stmt) = @_;
1632
1633 # Strip the diff line prefixes and rip blank lines at start and end.
1634 $stmt =~ s/(^|\n)./$1/g;
1635 $stmt =~ s/^\s*//;
1636 $stmt =~ s/\s*$//;
1637
1638 my @stmt_lines = ($stmt =~ /\n/g);
1639
1640 return $#stmt_lines + 2;
1641}
1642
1643sub statement_rawlines {
1644 my ($stmt) = @_;
1645
1646 my @stmt_lines = ($stmt =~ /\n/g);
1647
1648 return $#stmt_lines + 2;
1649}
1650
1651sub statement_block_size {
1652 my ($stmt) = @_;
1653
1654 $stmt =~ s/(^|\n)./$1/g;
1655 $stmt =~ s/^\s*{//;
1656 $stmt =~ s/}\s*$//;
1657 $stmt =~ s/^\s*//;
1658 $stmt =~ s/\s*$//;
1659
1660 my @stmt_lines = ($stmt =~ /\n/g);
1661 my @stmt_statements = ($stmt =~ /;/g);
1662
1663 my $stmt_lines = $#stmt_lines + 2;
1664 my $stmt_statements = $#stmt_statements + 1;
1665
1666 if ($stmt_lines > $stmt_statements) {
1667 return $stmt_lines;
1668 } else {
1669 return $stmt_statements;
1670 }
1671}
1672
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001673sub ctx_statement_full {
1674 my ($linenr, $remain, $off) = @_;
1675 my ($statement, $condition, $level);
1676
1677 my (@chunks);
1678
Andy Whitcroftcf655042008-03-04 14:28:20 -08001679 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001680 ($statement, $condition, $linenr, $remain, $off, $level) =
1681 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001682 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001683 push(@chunks, [ $condition, $statement ]);
1684 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1685 return ($level, $linenr, @chunks);
1686 }
1687
1688 # Pull in the following conditional/block pairs and see if they
1689 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001690 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001691 ($statement, $condition, $linenr, $remain, $off, $level) =
1692 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001693 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001694 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001695 #print "C: push\n";
1696 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001697 }
1698
1699 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001700}
1701
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001702sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001703 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001704 my $line;
1705 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001706 my $blk = '';
1707 my @o;
1708 my @c;
1709 my @res = ();
1710
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001711 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001712 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001713 for ($line = $start; $remain > 0; $line++) {
1714 next if ($rawlines[$line] =~ /^-/);
1715 $remain--;
1716
1717 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001718
1719 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001720 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001721 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001722 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001723 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001724 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001725 $level = pop(@stack);
1726 }
1727
Andy Whitcroft01464f32010-10-26 14:23:19 -07001728 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001729 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1730 if ($off > 0) {
1731 $off--;
1732 next;
1733 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001734
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001735 if ($c eq $close && $level > 0) {
1736 $level--;
1737 last if ($level == 0);
1738 } elsif ($c eq $open) {
1739 $level++;
1740 }
1741 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001742
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001743 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001744 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001745 }
1746
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001747 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001748 }
1749
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001750 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001751}
1752sub ctx_block_outer {
1753 my ($linenr, $remain) = @_;
1754
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001755 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1756 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001757}
1758sub ctx_block {
1759 my ($linenr, $remain) = @_;
1760
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001761 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1762 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001763}
1764sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001765 my ($linenr, $remain, $off) = @_;
1766
1767 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1768 return @r;
1769}
1770sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001771 my ($linenr, $remain) = @_;
1772
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001773 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001774}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001775sub ctx_statement_level {
1776 my ($linenr, $remain, $off) = @_;
1777
1778 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1779}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001780
1781sub ctx_locate_comment {
1782 my ($first_line, $end_line) = @_;
1783
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001784 # If c99 comment on the current line, or the line before or after
1785 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1786 return $current_comment if (defined $current_comment);
1787 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1788 return $current_comment if (defined $current_comment);
1789 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1790 return $current_comment if (defined $current_comment);
1791
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001792 # Catch a comment on the end of the line itself.
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001793 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001794 return $current_comment if (defined $current_comment);
1795
1796 # Look through the context and try and figure out if there is a
1797 # comment.
1798 my $in_comment = 0;
1799 $current_comment = '';
1800 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001801 my $line = $rawlines[$linenr - 1];
1802 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001803 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1804 $in_comment = 1;
1805 }
1806 if ($line =~ m@/\*@) {
1807 $in_comment = 1;
1808 }
1809 if (!$in_comment && $current_comment ne '') {
1810 $current_comment = '';
1811 }
1812 $current_comment .= $line . "\n" if ($in_comment);
1813 if ($line =~ m@\*/@) {
1814 $in_comment = 0;
1815 }
1816 }
1817
1818 chomp($current_comment);
1819 return($current_comment);
1820}
1821sub ctx_has_comment {
1822 my ($first_line, $end_line) = @_;
1823 my $cmt = ctx_locate_comment($first_line, $end_line);
1824
Andy Whitcroft00df3442007-06-08 13:47:06 -07001825 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001826 ##print "CMMT: $cmt\n";
1827
1828 return ($cmt ne '');
1829}
1830
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001831sub raw_line {
1832 my ($linenr, $cnt) = @_;
1833
1834 my $offset = $linenr - 1;
1835 $cnt++;
1836
1837 my $line;
1838 while ($cnt) {
1839 $line = $rawlines[$offset++];
1840 next if (defined($line) && $line =~ /^-/);
1841 $cnt--;
1842 }
1843
1844 return $line;
1845}
1846
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001847sub get_stat_real {
1848 my ($linenr, $lc) = @_;
1849
1850 my $stat_real = raw_line($linenr, 0);
1851 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1852 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1853 }
1854
1855 return $stat_real;
1856}
1857
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001858sub get_stat_here {
1859 my ($linenr, $cnt, $here) = @_;
1860
1861 my $herectx = $here . "\n";
1862 for (my $n = 0; $n < $cnt; $n++) {
1863 $herectx .= raw_line($linenr, $n) . "\n";
1864 }
1865
1866 return $herectx;
1867}
1868
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001869sub cat_vet {
1870 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001871 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001872
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001873 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001874 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1875 $res .= $1;
1876 if ($2 ne '') {
1877 $coded = sprintf("^%c", unpack('C', $2) + 64);
1878 $res .= $coded;
1879 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001880 }
1881 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001882
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001883 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001884}
1885
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001886my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001887my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001888my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001889my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001890
1891sub annotate_reset {
1892 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001893 $av_pending = '_';
1894 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001895 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001896}
1897
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001898sub annotate_values {
1899 my ($stream, $type) = @_;
1900
1901 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001902 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001903 my $cur = $stream;
1904
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001905 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001906
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001907 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001908 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001909 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001910 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001911 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001912 print "WS($1)\n" if ($dbg_values > 1);
1913 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001914 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001915 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001916 }
1917
Florian Micklerc023e4732011-01-12 16:59:58 -08001918 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001919 print "CAST($1)\n" if ($dbg_values > 1);
1920 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001921 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001922
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001923 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001924 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001925 $type = 'T';
1926
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001927 } elsif ($cur =~ /^($Modifier)\s*/) {
1928 print "MODIFIER($1)\n" if ($dbg_values > 1);
1929 $type = 'T';
1930
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001931 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001932 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001933 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001934 push(@av_paren_type, $type);
1935 if ($2 ne '') {
1936 $av_pending = 'N';
1937 }
1938 $type = 'E';
1939
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001940 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001941 print "UNDEF($1)\n" if ($dbg_values > 1);
1942 $av_preprocessor = 1;
1943 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001944
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001945 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001946 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001947 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001948
1949 push(@av_paren_type, $type);
1950 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001951 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001952
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001953 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001954 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1955 $av_preprocessor = 1;
1956
1957 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1958
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001959 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001960
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001961 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001962 print "PRE_END($1)\n" if ($dbg_values > 1);
1963
1964 $av_preprocessor = 1;
1965
1966 # Assume all arms of the conditional end as this
1967 # one does, and continue as if the #endif was not here.
1968 pop(@av_paren_type);
1969 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001970 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001971
1972 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001973 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001974
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001975 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1976 print "ATTR($1)\n" if ($dbg_values > 1);
1977 $av_pending = $type;
1978 $type = 'N';
1979
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001980 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001981 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001982 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001983 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001984 }
1985 $type = 'N';
1986
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001987 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001988 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001989 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001990 $type = 'N';
1991
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001992 } elsif ($cur =~/^(case)/o) {
1993 print "CASE($1)\n" if ($dbg_values > 1);
1994 $av_pend_colon = 'C';
1995 $type = 'N';
1996
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001997 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001998 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001999 $type = 'N';
2000
2001 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002002 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002003 push(@av_paren_type, $av_pending);
2004 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002005 $type = 'N';
2006
2007 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002008 my $new_type = pop(@av_paren_type);
2009 if ($new_type ne '_') {
2010 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002011 print "PAREN('$1') -> $type\n"
2012 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002013 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002014 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002015 }
2016
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07002017 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002018 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07002019 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08002020 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002021
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002022 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
2023 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002024 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002025 } elsif ($type eq 'E') {
2026 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002027 }
2028 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
2029 $type = 'V';
2030
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002031 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002032 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002033 $type = 'V';
2034
2035 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002036 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002037 $type = 'N';
2038
Andy Whitcroftcf655042008-03-04 14:28:20 -08002039 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002040 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002041 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002042 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002043
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002044 } elsif ($cur =~/^(,)/) {
2045 print "COMMA($1)\n" if ($dbg_values > 1);
2046 $type = 'C';
2047
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002048 } elsif ($cur =~ /^(\?)/o) {
2049 print "QUESTION($1)\n" if ($dbg_values > 1);
2050 $type = 'N';
2051
2052 } elsif ($cur =~ /^(:)/o) {
2053 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
2054
2055 substr($var, length($res), 1, $av_pend_colon);
2056 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
2057 $type = 'E';
2058 } else {
2059 $type = 'N';
2060 }
2061 $av_pend_colon = 'O';
2062
Andy Whitcroft8e761b02009-01-06 14:41:19 -08002063 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002064 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002065 $type = 'N';
2066
Andy Whitcroft0d413862008-10-15 22:02:16 -07002067 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002068 my $variant;
2069
2070 print "OPV($1)\n" if ($dbg_values > 1);
2071 if ($type eq 'V') {
2072 $variant = 'B';
2073 } else {
2074 $variant = 'U';
2075 }
2076
2077 substr($var, length($res), 1, $variant);
2078 $type = 'N';
2079
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002080 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002081 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002082 if ($1 ne '++' && $1 ne '--') {
2083 $type = 'N';
2084 }
2085
2086 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002087 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002088 }
2089 if (defined $1) {
2090 $cur = substr($cur, length($1));
2091 $res .= $type x length($1);
2092 }
2093 }
2094
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002095 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002096}
2097
Andy Whitcroft8905a672007-11-28 16:21:06 -08002098sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002099 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002100 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002101 ^(?:
2102 $Modifier|
2103 $Storage|
2104 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002105 DEFINE_\S+
2106 )$|
2107 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002108 goto|
2109 return|
2110 case|
2111 else|
2112 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08002113 do|
2114 \#|
2115 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002116 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07002117 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002118 )}x;
2119 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2120 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002121 # Check for modifiers.
2122 $possible =~ s/\s*$Storage\s*//g;
2123 $possible =~ s/\s*$Sparse\s*//g;
2124 if ($possible =~ /^\s*$/) {
2125
2126 } elsif ($possible =~ /\s/) {
2127 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07002128 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002129 if ($modifier !~ $notPermitted) {
2130 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002131 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002132 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07002133 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002134
2135 } else {
2136 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002137 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002138 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002139 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07002140 } else {
2141 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002142 }
2143}
2144
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002145my $prefix = '';
2146
Joe Perches000d1cc12011-07-25 17:13:25 -07002147sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002148 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002149
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002150 $type =~ tr/[a-z]/[A-Z]/;
2151
Joe Perchescbec18a2014-04-03 14:49:19 -07002152 return defined $use_type{$type} if (scalar keys %use_type > 0);
2153
2154 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002155}
2156
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002157sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002158 my ($level, $type, $msg) = @_;
2159
2160 if (!show_type($type) ||
2161 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002162 return 0;
2163 }
Joe Perches57230292015-06-25 15:03:03 -07002164 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002165 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002166 if ($level eq 'ERROR') {
2167 $output .= RED;
2168 } elsif ($level eq 'WARNING') {
2169 $output .= YELLOW;
2170 } else {
2171 $output .= GREEN;
2172 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002173 }
Joe Perches57230292015-06-25 15:03:03 -07002174 $output .= $prefix . $level . ':';
2175 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002176 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002177 $output .= "$type:";
2178 }
John Brooks737c0762017-07-10 15:52:24 -07002179 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002180 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002181
2182 if ($showfile) {
2183 my @lines = split("\n", $output, -1);
2184 splice(@lines, 1, 1);
2185 $output = join("\n", @lines);
2186 }
Joe Perches57230292015-06-25 15:03:03 -07002187 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002188
Joe Perches57230292015-06-25 15:03:03 -07002189 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002190
2191 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002192}
Joe Perchescbec18a2014-04-03 14:49:19 -07002193
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002194sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002195 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002196}
Joe Perches000d1cc12011-07-25 17:13:25 -07002197
Joe Perchesd752fcc2014-08-06 16:11:05 -07002198sub fixup_current_range {
2199 my ($lineRef, $offset, $length) = @_;
2200
2201 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2202 my $o = $1;
2203 my $l = $2;
2204 my $no = $o + $offset;
2205 my $nl = $l + $length;
2206 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2207 }
2208}
2209
2210sub fix_inserted_deleted_lines {
2211 my ($linesRef, $insertedRef, $deletedRef) = @_;
2212
2213 my $range_last_linenr = 0;
2214 my $delta_offset = 0;
2215
2216 my $old_linenr = 0;
2217 my $new_linenr = 0;
2218
2219 my $next_insert = 0;
2220 my $next_delete = 0;
2221
2222 my @lines = ();
2223
2224 my $inserted = @{$insertedRef}[$next_insert++];
2225 my $deleted = @{$deletedRef}[$next_delete++];
2226
2227 foreach my $old_line (@{$linesRef}) {
2228 my $save_line = 1;
2229 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002230 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002231 $delta_offset = 0;
2232 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2233 $range_last_linenr = $new_linenr;
2234 fixup_current_range(\$line, $delta_offset, 0);
2235 }
2236
2237 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2238 $deleted = @{$deletedRef}[$next_delete++];
2239 $save_line = 0;
2240 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2241 }
2242
2243 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2244 push(@lines, ${$inserted}{'LINE'});
2245 $inserted = @{$insertedRef}[$next_insert++];
2246 $new_linenr++;
2247 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2248 }
2249
2250 if ($save_line) {
2251 push(@lines, $line);
2252 $new_linenr++;
2253 }
2254
2255 $old_linenr++;
2256 }
2257
2258 return @lines;
2259}
2260
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002261sub fix_insert_line {
2262 my ($linenr, $line) = @_;
2263
2264 my $inserted = {
2265 LINENR => $linenr,
2266 LINE => $line,
2267 };
2268 push(@fixed_inserted, $inserted);
2269}
2270
2271sub fix_delete_line {
2272 my ($linenr, $line) = @_;
2273
2274 my $deleted = {
2275 LINENR => $linenr,
2276 LINE => $line,
2277 };
2278
2279 push(@fixed_deleted, $deleted);
2280}
2281
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002282sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002283 my ($type, $msg) = @_;
2284
2285 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002286 our $clean = 0;
2287 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002288 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002289 }
Joe Perches3705ce52013-07-03 15:05:31 -07002290 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002291}
2292sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002293 my ($type, $msg) = @_;
2294
2295 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002296 our $clean = 0;
2297 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002298 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002299 }
Joe Perches3705ce52013-07-03 15:05:31 -07002300 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002301}
2302sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002303 my ($type, $msg) = @_;
2304
2305 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002306 our $clean = 0;
2307 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002308 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002309 }
Joe Perches3705ce52013-07-03 15:05:31 -07002310 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002311}
2312
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002313sub check_absolute_file {
2314 my ($absolute, $herecurr) = @_;
2315 my $file = $absolute;
2316
2317 ##print "absolute<$absolute>\n";
2318
2319 # See if any suffix of this path is a path within the tree.
2320 while ($file =~ s@^[^/]*/@@) {
2321 if (-f "$root/$file") {
2322 ##print "file<$file>\n";
2323 last;
2324 }
2325 }
2326 if (! -f _) {
2327 return 0;
2328 }
2329
2330 # It is, so see if the prefix is acceptable.
2331 my $prefix = $absolute;
2332 substr($prefix, -length($file)) = '';
2333
2334 ##print "prefix<$prefix>\n";
2335 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002336 WARN("USE_RELATIVE_PATH",
2337 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002338 }
2339}
2340
Joe Perches3705ce52013-07-03 15:05:31 -07002341sub trim {
2342 my ($string) = @_;
2343
Joe Perchesb34c6482013-09-11 14:24:01 -07002344 $string =~ s/^\s+|\s+$//g;
2345
2346 return $string;
2347}
2348
2349sub ltrim {
2350 my ($string) = @_;
2351
2352 $string =~ s/^\s+//;
2353
2354 return $string;
2355}
2356
2357sub rtrim {
2358 my ($string) = @_;
2359
2360 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002361
2362 return $string;
2363}
2364
Joe Perches52ea8502013-11-12 15:10:09 -08002365sub string_find_replace {
2366 my ($string, $find, $replace) = @_;
2367
2368 $string =~ s/$find/$replace/g;
2369
2370 return $string;
2371}
2372
Joe Perches3705ce52013-07-03 15:05:31 -07002373sub tabify {
2374 my ($leading) = @_;
2375
Antonio Borneo713a09d2020-04-06 20:11:07 -07002376 my $source_indent = $tabsize;
Joe Perches3705ce52013-07-03 15:05:31 -07002377 my $max_spaces_before_tab = $source_indent - 1;
2378 my $spaces_to_tab = " " x $source_indent;
2379
2380 #convert leading spaces to tabs
2381 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2382 #Remove spaces before a tab
2383 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2384
2385 return "$leading";
2386}
2387
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002388sub pos_last_openparen {
2389 my ($line) = @_;
2390
2391 my $pos = 0;
2392
2393 my $opens = $line =~ tr/\(/\(/;
2394 my $closes = $line =~ tr/\)/\)/;
2395
2396 my $last_openparen = 0;
2397
2398 if (($opens == 0) || ($closes >= $opens)) {
2399 return -1;
2400 }
2401
2402 my $len = length($line);
2403
2404 for ($pos = 0; $pos < $len; $pos++) {
2405 my $string = substr($line, $pos);
2406 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2407 $pos += length($1) - 1;
2408 } elsif (substr($line, $pos, 1) eq '(') {
2409 $last_openparen = $pos;
2410 } elsif (index($string, '(') == -1) {
2411 last;
2412 }
2413 }
2414
Joe Perches91cb5192014-04-03 14:49:32 -07002415 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002416}
2417
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002418sub get_raw_comment {
2419 my ($line, $rawline) = @_;
2420 my $comment = '';
2421
2422 for my $i (0 .. (length($line) - 1)) {
2423 if (substr($line, $i, 1) eq "$;") {
2424 $comment .= substr($rawline, $i, 1);
2425 }
2426 }
2427
2428 return $comment;
2429}
2430
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002431sub process {
2432 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002433
2434 my $linenr=0;
2435 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002436 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002437 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002438 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002439
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002440 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002441 my $indent;
2442 my $previndent=0;
2443 my $stashindent=0;
2444
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002445 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002446 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002447 my $author = '';
2448 my $authorsignoff = 0;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002449 my $author_sob = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002450 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002451 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002452 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002453 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches44d303e2020-04-06 20:11:10 -07002454 my $has_patch_separator = 0; #Found a --- line
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002455 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002456 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002457 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002458 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002459 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002460 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002461 my $non_utf8_charset = 0;
2462
Joe Perches365dd4e2014-08-06 16:10:42 -07002463 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002464 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002465
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002466 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002467 our $cnt_lines = 0;
2468 our $cnt_error = 0;
2469 our $cnt_warn = 0;
2470 our $cnt_chk = 0;
2471
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002472 # Trace the real file/line as we go.
2473 my $realfile = '';
2474 my $realline = 0;
2475 my $realcnt = 0;
2476 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002477 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002478 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002479 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002480 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002481 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002482
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002483 my $prev_values = 'E';
2484
2485 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002486 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002487 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002488 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002489 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002490
Joe Perches7e51f192013-09-11 14:23:57 -07002491 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002492
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002493 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002494 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002495 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002496 my @setup_docs = ();
2497 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002498
Joe Perchesd8b07712013-11-12 15:10:06 -08002499 my $camelcase_file_seeded = 0;
2500
Rob Herring9f3a8992018-04-10 16:33:13 -07002501 my $checklicenseline = 1;
2502
Andy Whitcroft773647a2008-03-28 14:15:58 -07002503 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002504 my $line;
2505 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002506 $linenr++;
2507 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002508
Joe Perches3705ce52013-07-03 15:05:31 -07002509 push(@fixed, $rawline) if ($fix);
2510
Andy Whitcroft773647a2008-03-28 14:15:58 -07002511 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002512 $setup_docs = 0;
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07002513 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002514 $setup_docs = 1;
2515 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002516 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002517 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002518 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002519 $realline=$1-1;
2520 if (defined $2) {
2521 $realcnt=$3+1;
2522 } else {
2523 $realcnt=1+1;
2524 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002525 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002526
2527 # Guestimate if this is a continuing comment. Run
2528 # the context looking for a comment "edge". If this
2529 # edge is a close comment then we must be in a comment
2530 # at context start.
2531 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002532 my $cnt = $realcnt;
2533 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2534 next if (defined $rawlines[$ln - 1] &&
2535 $rawlines[$ln - 1] =~ /^-/);
2536 $cnt--;
2537 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002538 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002539 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2540 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2541 ($edge) = $1;
2542 last;
2543 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002544 }
2545 if (defined $edge && $edge eq '*/') {
2546 $in_comment = 1;
2547 }
2548
2549 # Guestimate if this is a continuing comment. If this
2550 # is the start of a diff block and this line starts
2551 # ' *' then it is very likely a comment.
2552 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002553 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002554 {
2555 $in_comment = 1;
2556 }
2557
2558 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2559 sanitise_line_reset($in_comment);
2560
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002561 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002562 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002563 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002564 $line = sanitise_line($rawline);
2565 }
2566 push(@lines, $line);
2567
2568 if ($realcnt > 1) {
2569 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2570 } else {
2571 $realcnt = 0;
2572 }
2573
2574 #print "==>$rawline\n";
2575 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002576
2577 if ($setup_docs && $line =~ /^\+/) {
2578 push(@setup_docs, $line);
2579 }
2580 }
2581
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002582 $prefix = '';
2583
Andy Whitcroft773647a2008-03-28 14:15:58 -07002584 $realcnt = 0;
2585 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002586 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002587 foreach my $line (@lines) {
2588 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002589 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002590 my $sline = $line; #copy of $line
2591 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002592
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002593 my $rawline = $rawlines[$linenr - 1];
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002594 my $raw_comment = get_raw_comment($line, $rawline);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002595
Joe Perches12c253a2018-06-07 17:10:58 -07002596# check if it's a mode change, rename or start of a patch
2597 if (!$in_commit_log &&
2598 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2599 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2600 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2601 $is_patch = 1;
2602 }
2603
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002604#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002605 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002606 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2607 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002608 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002609 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002610 $realline=$1-1;
2611 if (defined $2) {
2612 $realcnt=$3+1;
2613 } else {
2614 $realcnt=1+1;
2615 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002616 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002617 $prev_values = 'E';
2618
Andy Whitcroft773647a2008-03-28 14:15:58 -07002619 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002620 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002621 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002622 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002623 if ($context =~ /\b(\w+)\s*\(/) {
2624 $context_function = $1;
2625 } else {
2626 undef $context_function;
2627 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002628 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002629
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002630# track the line number as we move through the hunk, note that
2631# new versions of GNU diff omit the leading space on completely
2632# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002633 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002634 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002635 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002636
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002637 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002638 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002639
2640 # Track the previous line.
2641 ($prevline, $stashline) = ($stashline, $line);
2642 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002643 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2644
Andy Whitcroft773647a2008-03-28 14:15:58 -07002645 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002646
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002647 } elsif ($realcnt == 1) {
2648 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002649 }
2650
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002651 my $hunk_line = ($realcnt != 0);
2652
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002653 $here = "#$linenr: " if (!$file);
2654 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002655
Joe Perches2ac73b42014-06-04 16:12:05 -07002656 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002657 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002658 if ($line =~ /^diff --git.*?(\S+)$/) {
2659 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002660 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002661 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002662 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002663 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002664 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002665 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002666 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002667
2668 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002669 if (!$file && $tree && $p1_prefix ne '' &&
2670 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002671 WARN("PATCH_PREFIX",
2672 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002673 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002674
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002675 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002676 ERROR("MODIFIED_INCLUDE_ASM",
2677 "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 -07002678 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002679 $found_file = 1;
2680 }
2681
Joe Perches34d88152015-06-25 15:03:05 -07002682#make up the handle for any error we report on this line
2683 if ($showfile) {
2684 $prefix = "$realfile:$realline: "
2685 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002686 if ($file) {
2687 $prefix = "$filename:$realline: ";
2688 } else {
2689 $prefix = "$filename:$linenr: ";
2690 }
Joe Perches34d88152015-06-25 15:03:05 -07002691 }
2692
Joe Perches2ac73b42014-06-04 16:12:05 -07002693 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002694 if (is_maintained_obsolete($realfile)) {
2695 WARN("OBSOLETE",
2696 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2697 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002698 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002699 $check = 1;
2700 } else {
2701 $check = $check_orig;
2702 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002703 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002704
2705 if ($realfile !~ /^MAINTAINERS/) {
2706 my $last_binding_patch = $is_binding_patch;
2707
2708 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2709
2710 if (($last_binding_patch != -1) &&
2711 ($last_binding_patch ^ $is_binding_patch)) {
2712 WARN("DT_SPLIT_BINDING_PATCH",
Mauro Carvalho Chehab858e6842020-04-15 16:45:25 +02002713 "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 -07002714 }
2715 }
2716
Andy Whitcroft773647a2008-03-28 14:15:58 -07002717 next;
2718 }
2719
Randy Dunlap389834b2007-06-08 13:47:03 -07002720 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002721
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002722 my $hereline = "$here\n$rawline\n";
2723 my $herecurr = "$here\n$rawline\n";
2724 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002725
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002726 $cnt_lines++ if ($realcnt != 0);
2727
Joe Perches490b2922018-08-21 21:58:01 -07002728# Verify the existence of a commit log if appropriate
2729# 2 is used because a $signature is counted in $commit_log_lines
2730 if ($in_commit_log) {
2731 if ($line !~ /^\s*$/) {
2732 $commit_log_lines++; #could be a $signature
2733 }
2734 } elsif ($has_commit_log && $commit_log_lines < 2) {
2735 WARN("COMMIT_MESSAGE",
2736 "Missing commit description - Add an appropriate one\n");
2737 $commit_log_lines = 2; #warn only once
2738 }
2739
Joe Perchese518e9a2015-06-25 15:03:27 -07002740# Check if the commit log has what seems like a diff which can confuse patch
2741 if ($in_commit_log && !$commit_log_has_diff &&
Mrinal Pandey13e45412020-09-04 16:35:52 -07002742 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
2743 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
Joe Perchese518e9a2015-06-25 15:03:27 -07002744 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2745 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2746 ERROR("DIFF_IN_COMMIT_MSG",
2747 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2748 $commit_log_has_diff = 1;
2749 }
2750
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002751# Check for incorrect file permissions
2752 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2753 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002754 if ($realfile !~ m@scripts/@ &&
2755 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002756 ERROR("EXECUTE_PERMISSIONS",
2757 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002758 }
2759 }
2760
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002761# Check the patch for a From:
2762 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2763 $author = $1;
Dwaipayan Raye7f929f2020-10-15 20:12:15 -07002764 my $curline = $linenr;
2765 while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) {
2766 $author .= $1;
2767 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002768 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2769 $author =~ s/"//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07002770 $author = reformat_email($author);
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002771 }
2772
Joe Perches20112472011-07-25 17:13:23 -07002773# Check the patch for a signoff:
Joe Perchesdfa05c22020-04-06 20:10:48 -07002774 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002775 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002776 $in_commit_log = 0;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002777 if ($author ne '' && $authorsignoff != 1) {
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08002778 if (same_email_addresses($1, $author)) {
Joe Perchesdfa05c22020-04-06 20:10:48 -07002779 $authorsignoff = 1;
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002780 } else {
2781 my $ctx = $1;
2782 my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
2783 my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);
2784
2785 if ($email_address eq $author_address && $email_name eq $author_name) {
2786 $author_sob = $ctx;
2787 $authorsignoff = 2;
2788 } elsif ($email_address eq $author_address) {
2789 $author_sob = $ctx;
2790 $authorsignoff = 3;
2791 } elsif ($email_name eq $author_name) {
2792 $author_sob = $ctx;
2793 $authorsignoff = 4;
2794
2795 my $address1 = $email_address;
2796 my $address2 = $author_address;
2797
2798 if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
2799 $address1 = "$1$2";
2800 }
2801 if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
2802 $address2 = "$1$2";
2803 }
2804 if ($address1 eq $address2) {
2805 $authorsignoff = 5;
2806 }
2807 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002808 }
2809 }
Joe Perches20112472011-07-25 17:13:23 -07002810 }
2811
Joe Perches44d303e2020-04-06 20:11:10 -07002812# Check for patch separator
2813 if ($line =~ /^---$/) {
2814 $has_patch_separator = 1;
2815 $in_commit_log = 0;
2816 }
2817
Joe Perchese0d975b2014-12-10 15:51:49 -08002818# Check if MAINTAINERS is being updated. If so, there's probably no need to
2819# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2820 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2821 $reported_maintainer_file = 1;
2822 }
2823
Joe Perches20112472011-07-25 17:13:23 -07002824# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002825 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002826 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002827 my $space_before = $1;
2828 my $sign_off = $2;
2829 my $space_after = $3;
2830 my $email = $4;
2831 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2832
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002833 if ($sign_off !~ /$signature_tags/) {
Aditya Srivastava831242a2020-12-15 20:45:12 -08002834 my $suggested_signature = find_standard_signature($sign_off);
2835 if ($suggested_signature eq "") {
2836 WARN("BAD_SIGN_OFF",
2837 "Non-standard signature: $sign_off\n" . $herecurr);
2838 } else {
2839 if (WARN("BAD_SIGN_OFF",
2840 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) &&
2841 $fix) {
2842 $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/;
2843 }
2844 }
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002845 }
Joe Perches20112472011-07-25 17:13:23 -07002846 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002847 if (WARN("BAD_SIGN_OFF",
2848 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2849 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002850 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002851 "$ucfirst_sign_off $email";
2852 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002853 }
Joe Perches20112472011-07-25 17:13:23 -07002854 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002855 if (WARN("BAD_SIGN_OFF",
2856 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2857 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002858 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002859 "$ucfirst_sign_off $email";
2860 }
2861
Joe Perches20112472011-07-25 17:13:23 -07002862 }
2863 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002864 if (WARN("BAD_SIGN_OFF",
2865 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2866 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002867 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002868 "$ucfirst_sign_off $email";
2869 }
Joe Perches20112472011-07-25 17:13:23 -07002870 }
2871
Joe Perchesdfa05c22020-04-06 20:10:48 -07002872 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07002873 my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment));
Joe Perches20112472011-07-25 17:13:23 -07002874 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002875 ERROR("BAD_SIGN_OFF",
2876 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002877 } else {
2878 my $dequoted = $suggested_email;
2879 $dequoted =~ s/^"//;
2880 $dequoted =~ s/" </ </;
2881 # Don't force email to have quotes
2882 # Allow just an angle bracketed address
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08002883 if (!same_email_addresses($email, $suggested_email)) {
2884 if (WARN("BAD_SIGN_OFF",
2885 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) &&
2886 $fix) {
2887 $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/;
2888 }
2889 }
2890
2891 # Address part shouldn't have comments
2892 my $stripped_address = $email_address;
2893 $stripped_address =~ s/\([^\(\)]*\)//g;
2894 if ($email_address ne $stripped_address) {
2895 if (WARN("BAD_SIGN_OFF",
2896 "address part of email should not have comments: '$email_address'\n" . $herecurr) &&
2897 $fix) {
2898 $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/;
2899 }
2900 }
2901
2902 # Only one name comment should be allowed
2903 my $comment_count = () = $name_comment =~ /\([^\)]+\)/g;
2904 if ($comment_count > 1) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002905 WARN("BAD_SIGN_OFF",
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08002906 "Use a single name comment in email: '$email'\n" . $herecurr);
2907 }
2908
2909
2910 # stable@vger.kernel.org or stable@kernel.org shouldn't
Dwaipayan Raye73d2712020-12-15 20:44:56 -08002911 # have an email name. In addition comments should strictly
Dwaipayan Rayfccaebf2020-12-15 20:44:53 -08002912 # begin with a #
2913 if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) {
2914 if (($comment ne "" && $comment !~ /^#.+/) ||
2915 ($email_name ne "")) {
2916 my $cur_name = $email_name;
2917 my $new_comment = $comment;
2918 $cur_name =~ s/[a-zA-Z\s\-\"]+//g;
2919
2920 # Remove brackets enclosing comment text
2921 # and # from start of comments to get comment text
2922 $new_comment =~ s/^\((.*)\)$/$1/;
2923 $new_comment =~ s/^\[(.*)\]$/$1/;
2924 $new_comment =~ s/^[\s\#]+|\s+$//g;
2925
2926 $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment);
2927 $new_comment = " # $new_comment" if ($new_comment ne "");
2928 my $new_email = "$email_address$new_comment";
2929
2930 if (WARN("BAD_STABLE_ADDRESS_STYLE",
2931 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) &&
2932 $fix) {
2933 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
2934 }
2935 }
2936 } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) {
2937 my $new_comment = $comment;
2938
2939 # Extract comment text from within brackets or
2940 # c89 style /*...*/ comments
2941 $new_comment =~ s/^\[(.*)\]$/$1/;
2942 $new_comment =~ s/^\/\*(.*)\*\/$/$1/;
2943
2944 $new_comment = trim($new_comment);
2945 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
2946 $new_comment = "($new_comment)" if ($new_comment ne "");
2947 my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment);
2948
2949 if (WARN("BAD_SIGN_OFF",
2950 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) &&
2951 $fix) {
2952 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
2953 }
Joe Perches20112472011-07-25 17:13:23 -07002954 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002955 }
Joe Perches7e51f192013-09-11 14:23:57 -07002956
2957# Check for duplicate signatures
2958 my $sig_nospace = $line;
2959 $sig_nospace =~ s/\s//g;
2960 $sig_nospace = lc($sig_nospace);
2961 if (defined $signatures{$sig_nospace}) {
2962 WARN("BAD_SIGN_OFF",
2963 "Duplicate signature\n" . $herecurr);
2964 } else {
2965 $signatures{$sig_nospace} = 1;
2966 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07002967
2968# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2969 if ($sign_off =~ /^co-developed-by:$/i) {
2970 if ($email eq $author) {
2971 WARN("BAD_SIGN_OFF",
2972 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2973 }
2974 if (!defined $lines[$linenr]) {
2975 WARN("BAD_SIGN_OFF",
2976 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2977 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2978 WARN("BAD_SIGN_OFF",
2979 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2980 } elsif ($1 ne $email) {
2981 WARN("BAD_SIGN_OFF",
2982 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2983 }
2984 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002985 }
2986
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002987# Check email subject for common tools that don't need to be mentioned
2988 if ($in_header_lines &&
2989 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2990 WARN("EMAIL_SUBJECT",
2991 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2992 }
2993
Joe Perches44d303e2020-04-06 20:11:10 -07002994# Check for Gerrit Change-Ids not in any patch context
2995 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Aditya Srivastava7580c5b2020-12-15 20:44:47 -08002996 if (ERROR("GERRIT_CHANGE_ID",
2997 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
2998 $fix) {
2999 fix_delete_line($fixlinenr, $rawline);
3000 }
Christopher Covington7ebd05e2014-04-03 14:49:31 -07003001 }
3002
Joe Perches369c8dd2015-11-06 16:31:34 -08003003# Check if the commit log is in a possible stack dump
3004 if ($in_commit_log && !$commit_log_possible_stack_dump &&
3005 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
3006 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
3007 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07003008 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
3009 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
3010 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
3011 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08003012 $commit_log_possible_stack_dump = 1;
3013 }
3014
Joe Perches2a076f42015-04-16 12:44:28 -07003015# Check for line lengths > 75 in commit log, warn once
3016 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08003017 length($line) > 75 &&
3018 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
3019 # file delta changes
3020 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
3021 # filename then :
Aditya Srivastava27b379a2020-12-15 20:44:59 -08003022 $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
3023 # A Fixes: or Link: line or signature tag line
Joe Perches369c8dd2015-11-06 16:31:34 -08003024 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07003025 WARN("COMMIT_LOG_LONG_LINE",
3026 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
3027 $commit_log_long_line = 1;
3028 }
3029
Joe Perchesbf4daf12015-09-09 15:37:50 -07003030# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08003031 if ($in_commit_log && $commit_log_possible_stack_dump &&
3032 $line =~ /^\s*$/) {
3033 $commit_log_possible_stack_dump = 0;
3034 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07003035
Dwaipayan Ray084a6172020-12-15 20:45:18 -08003036# Check for lines starting with a #
3037 if ($in_commit_log && $line =~ /^#/) {
3038 if (WARN("COMMIT_COMMENT_SYMBOL",
3039 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
3040 $fix) {
3041 $fixed[$fixlinenr] =~ s/^/ /;
3042 }
3043 }
3044
Joe Perches0d7835f2015-02-13 14:38:35 -08003045# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08003046 if ($in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07003047 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07003048 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07003049 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07003050 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08003051 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
3052 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07003053 my $init_char = "c";
3054 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08003055 my $short = 1;
3056 my $long = 0;
3057 my $case = 1;
3058 my $space = 1;
3059 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08003060 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08003061 my $id = '0123456789ab';
3062 my $orig_desc = "commit description";
3063 my $description = "";
3064
Joe Perchesfe043ea2015-09-09 15:37:25 -07003065 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
3066 $init_char = $1;
3067 $orig_commit = lc($2);
3068 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
3069 $orig_commit = lc($1);
3070 }
3071
Joe Perches0d7835f2015-02-13 14:38:35 -08003072 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
3073 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
3074 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
3075 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
3076 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
3077 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003078 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08003079 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
3080 defined $rawlines[$linenr] &&
3081 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
3082 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003083 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08003084 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
3085 defined $rawlines[$linenr] &&
3086 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
3087 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
3088 $orig_desc = $1;
3089 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
3090 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003091 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08003092 }
3093
3094 ($id, $description) = git_commit_info($orig_commit,
3095 $id, $orig_desc);
3096
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07003097 if (defined($id) &&
3098 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08003099 ERROR("GIT_COMMIT_ID",
3100 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
3101 }
Joe Perchesd311cd42014-08-06 16:10:57 -07003102 }
3103
Joe Perches13f19372014-08-06 16:10:59 -07003104# Check for added, moved or deleted files
3105 if (!$reported_maintainer_file && !$in_commit_log &&
3106 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
3107 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
3108 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
3109 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08003110 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07003111 $reported_maintainer_file = 1;
3112 WARN("FILE_PATH_CHANGES",
3113 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
3114 }
3115
Rob Herringe400edb2019-09-12 15:18:20 +01003116# Check for adding new DT bindings not in schema format
3117 if (!$in_commit_log &&
3118 ($line =~ /^new file mode\s*\d+\s*$/) &&
3119 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
3120 WARN("DT_SCHEMA_BINDING_PATCH",
3121 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
3122 }
3123
Andy Whitcroft00df3442007-06-08 13:47:06 -07003124# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08003125 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003126 ERROR("CORRUPTED_PATCH",
3127 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003128 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003129 }
3130
3131# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3132 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003133 $rawline !~ m/^$UTF8*$/) {
3134 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3135
3136 my $blank = copy_spacing($rawline);
3137 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3138 my $hereptr = "$hereline$ptr\n";
3139
Joe Perches34d99212011-07-25 17:13:26 -07003140 CHK("INVALID_UTF8",
3141 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003142 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003143
Joe Perches15662b32011-10-31 17:13:12 -07003144# Check if it's the start of a commit log
3145# (not a header line and we haven't seen the patch filename)
3146 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07003147 !($rawline =~ /^\s+(?:\S|$)/ ||
3148 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07003149 $in_header_lines = 0;
3150 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07003151 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07003152 }
3153
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003154# Check if there is UTF-8 in a commit log when a mail header has explicitly
3155# declined it, i.e defined some charset where it is missing.
3156 if ($in_header_lines &&
3157 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3158 $1 !~ /utf-8/i) {
3159 $non_utf8_charset = 1;
3160 }
3161
3162 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07003163 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003164 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07003165 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3166 }
3167
Joe Perchesd6430f72016-12-12 16:46:28 -08003168# Check for absolute kernel paths in commit message
3169 if ($tree && $in_commit_log) {
3170 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3171 my $file = $1;
3172
3173 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3174 check_absolute_file($1, $herecurr)) {
3175 #
3176 } else {
3177 check_absolute_file($file, $herecurr);
3178 }
3179 }
3180 }
3181
Kees Cook66b47b42014-10-13 15:51:57 -07003182# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07003183 if (defined($misspellings) &&
3184 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07003185 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07003186 my $typo = $1;
3187 my $typo_fix = $spelling_fix{lc($typo)};
3188 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3189 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07003190 my $msg_level = \&WARN;
3191 $msg_level = \&CHK if ($file);
3192 if (&{$msg_level}("TYPO_SPELLING",
3193 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07003194 $fix) {
3195 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3196 }
3197 }
3198 }
3199
Matteo Crocea8dd86b2019-09-25 16:46:38 -07003200# check for invalid commit id
3201 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3202 my $id;
3203 my $description;
3204 ($id, $description) = git_commit_info($2, undef, undef);
3205 if (!defined($id)) {
3206 WARN("UNKNOWN_COMMIT_ID",
3207 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3208 }
3209 }
3210
Joe Perches310cd062020-10-15 20:11:52 -07003211# check for repeated words separated by a single space
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003212# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3213 if (($rawline =~ /^\+/ || $in_commit_log) &&
3214 $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003215 pos($rawline) = 1 if (!$in_commit_log);
Joe Perches310cd062020-10-15 20:11:52 -07003216 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3217
3218 my $first = $1;
3219 my $second = $2;
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003220 my $start_pos = $-[1];
3221 my $end_pos = $+[2];
Joe Perches310cd062020-10-15 20:11:52 -07003222 if ($first =~ /(?:struct|union|enum)/) {
3223 pos($rawline) += length($first) + length($second) + 1;
3224 next;
3225 }
3226
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003227 next if (lc($first) ne lc($second));
Joe Perches310cd062020-10-15 20:11:52 -07003228 next if ($first eq 'long');
3229
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003230 # check for character before and after the word matches
3231 my $start_char = '';
3232 my $end_char = '';
3233 $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
3234 $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
3235
3236 next if ($start_char =~ /^\S$/);
3237 next if (index(" \t.,;?!", $end_char) == -1);
3238
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003239 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3240 if ($first =~ /\b[0-9a-f]{2,}\b/i) {
3241 next if (!exists($allow_repeated_words{lc($first)}));
3242 }
3243
Joe Perches310cd062020-10-15 20:11:52 -07003244 if (WARN("REPEATED_WORD",
3245 "Possible repeated word: '$first'\n" . $herecurr) &&
3246 $fix) {
3247 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3248 }
3249 }
3250
3251 # if it's a repeated word on consecutive lines in a comment block
3252 if ($prevline =~ /$;+\s*$/ &&
3253 $prevrawline =~ /($word_pattern)\s*$/) {
3254 my $last_word = $1;
3255 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3256 if (WARN("REPEATED_WORD",
3257 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3258 $fix) {
3259 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3260 }
3261 }
3262 }
3263 }
3264
Andy Whitcroft306708542008-10-15 22:02:28 -07003265# ignore non-hunk lines and lines being removed
3266 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003267
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003268#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003269 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003270 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07003271 if (ERROR("DOS_LINE_ENDINGS",
3272 "DOS line endings\n" . $herevet) &&
3273 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003274 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003275 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003276 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3277 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003278 if (ERROR("TRAILING_WHITESPACE",
3279 "trailing whitespace\n" . $herevet) &&
3280 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003281 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07003282 }
3283
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003284 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003285 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07003286
Josh Triplett4783f892013-11-12 15:10:12 -08003287# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08003288 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08003289 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08003290 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3291 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003292 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003293 my $msg_level = \&ERROR;
3294 $msg_level = \&CHK if ($file);
3295 &{$msg_level}("FSF_MAILING_ADDRESS",
3296 "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 -08003297 }
3298
Andi Kleen33549572010-05-24 14:33:29 -07003299# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003300# Only applies when adding the entry originally, after that we do not have
3301# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003302 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003303 # 'choice' is usually the last thing on the line (though
3304 # Kconfig supports named choices), so use a word boundary
3305 # (\b) rather than a whitespace character (\s)
3306 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07003307 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003308 my $cnt = $realcnt;
3309 my $ln = $linenr + 1;
3310 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003311 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003312 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003313 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003314 $f = $lines[$ln - 1];
3315 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3316 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003317
3318 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07003319 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08003320
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01003321 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003322 $is_start = 1;
Masahiro Yamada22a4ac02020-06-17 12:02:20 +09003323 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003324 $length = -1;
3325 }
3326
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003327 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07003328 $f =~ s/#.*//;
3329 $f =~ s/^\s+//;
3330 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01003331
3332 # This only checks context lines in the patch
3333 # and so hopefully shouldn't trigger false
3334 # positives, even though some of these are
3335 # common words in help texts
3336 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3337 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003338 $is_end = 1;
3339 last;
3340 }
Andi Kleen33549572010-05-24 14:33:29 -07003341 $length++;
3342 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003343 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3344 WARN("CONFIG_DESCRIPTION",
3345 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3346 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003347 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003348 }
3349
Joe Perches7ccf41a2020-06-04 16:50:33 -07003350# check MAINTAINERS entries
3351 if ($realfile =~ /^MAINTAINERS$/) {
3352# check MAINTAINERS entries for the right form
3353 if ($rawline =~ /^\+[A-Z]:/ &&
3354 $rawline !~ /^\+[A-Z]:\t\S/) {
3355 if (WARN("MAINTAINERS_STYLE",
3356 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3357 $fix) {
3358 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3359 }
3360 }
3361# check MAINTAINERS entries for the right ordering too
3362 my $preferred_order = 'MRLSWQBCPTFXNK';
3363 if ($rawline =~ /^\+[A-Z]:/ &&
3364 $prevrawline =~ /^[\+ ][A-Z]:/) {
3365 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3366 my $cur = $1;
3367 my $curval = $2;
3368 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3369 my $prev = $1;
3370 my $prevval = $2;
3371 my $curindex = index($preferred_order, $cur);
3372 my $previndex = index($preferred_order, $prev);
3373 if ($curindex < 0) {
3374 WARN("MAINTAINERS_STYLE",
3375 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3376 } else {
3377 if ($previndex >= 0 && $curindex < $previndex) {
3378 WARN("MAINTAINERS_STYLE",
3379 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3380 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3381 ($prev eq 'X' && $cur eq 'X')) &&
3382 ($prevval cmp $curval) > 0) {
3383 WARN("MAINTAINERS_STYLE",
3384 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3385 }
3386 }
Joe Perches628f91a2017-07-10 15:52:07 -07003387 }
3388 }
3389
Christoph Jaeger327953e2015-02-13 14:38:29 -08003390# discourage the use of boolean for type definition attributes of Kconfig options
3391 if ($realfile =~ /Kconfig/ &&
3392 $line =~ /^\+\s*\bboolean\b/) {
3393 WARN("CONFIG_TYPE_BOOLEAN",
3394 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3395 }
3396
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003397 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3398 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3399 my $flag = $1;
3400 my $replacement = {
3401 'EXTRA_AFLAGS' => 'asflags-y',
3402 'EXTRA_CFLAGS' => 'ccflags-y',
3403 'EXTRA_CPPFLAGS' => 'cppflags-y',
3404 'EXTRA_LDFLAGS' => 'ldflags-y',
3405 };
3406
3407 WARN("DEPRECATED_VARIABLE",
3408 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3409 }
3410
Rob Herringbff5da42014-01-23 15:54:51 -08003411# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003412 if (defined $root &&
3413 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3414 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3415
Rob Herringbff5da42014-01-23 15:54:51 -08003416 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3417
Florian Vaussardcc933192014-04-03 14:49:27 -07003418 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003419 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003420
Rob Herringbff5da42014-01-23 15:54:51 -08003421 foreach my $compat (@compats) {
3422 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003423 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3424 my $compat3 = $compat;
3425 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3426 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003427 if ( $? >> 8 ) {
3428 WARN("UNDOCUMENTED_DT_STRING",
3429 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3430 }
3431
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003432 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3433 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003434 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003435 if ( $? >> 8 ) {
3436 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003437 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003438 }
3439 }
3440 }
3441
Rob Herring9f3a8992018-04-10 16:33:13 -07003442# check for using SPDX license tag at beginning of files
3443 if ($realline == $checklicenseline) {
3444 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3445 $checklicenseline = 2;
3446 } elsif ($rawline =~ /^\+/) {
3447 my $comment = "";
3448 if ($realfile =~ /\.(h|s|S)$/) {
3449 $comment = '/*';
3450 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3451 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003452 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003453 $comment = '#';
3454 } elsif ($realfile =~ /\.rst$/) {
3455 $comment = '..';
3456 }
3457
Joe Perchesfdf13692019-03-07 16:28:32 -08003458# check SPDX comment style for .[chsS] files
3459 if ($realfile =~ /\.[chsS]$/ &&
3460 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003461 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003462 WARN("SPDX_LICENSE_TAG",
3463 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3464 }
3465
Rob Herring9f3a8992018-04-10 16:33:13 -07003466 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003467 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3468 WARN("SPDX_LICENSE_TAG",
3469 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003470 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003471 my $spdx_license = $1;
3472 if (!is_SPDX_License_valid($spdx_license)) {
3473 WARN("SPDX_LICENSE_TAG",
3474 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3475 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003476 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3477 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3478 my $msg_level = \&WARN;
3479 $msg_level = \&CHK if ($file);
3480 if (&{$msg_level}("SPDX_LICENSE_TAG",
3481
3482 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3483 $fix) {
3484 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3485 }
3486 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003487 }
3488 }
3489 }
3490
Joe Perchesa0154cd2020-10-15 20:12:19 -07003491# check for embedded filenames
3492 if ($rawline =~ /^\+.*\Q$realfile\E/) {
3493 WARN("EMBEDDED_FILENAME",
3494 "It's generally not useful to have the filename in the file\n" . $herecurr);
3495 }
3496
Andy Whitcroft5368df202008-10-15 22:02:27 -07003497# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003498 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003499
Joe Perchesa8da38a2019-03-07 16:28:42 -08003500# check for using SPDX-License-Identifier on the wrong line number
3501 if ($realline != $checklicenseline &&
3502 $rawline =~ /\bSPDX-License-Identifier:/ &&
3503 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3504 WARN("SPDX_LICENSE_TAG",
3505 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3506 }
3507
Joe Perches47e0c882015-06-25 15:02:57 -07003508# line length limit (with some exclusions)
3509#
3510# There are a few types of lines that may extend beyond $max_line_length:
3511# logging functions like pr_info that end in a string
3512# lines with a single string
3513# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003514# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003515#
3516# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003517# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003518# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3519# LONG_LINE all other lines longer than $max_line_length
3520#
3521# if LONG_LINE is ignored, the other 2 types are also ignored
3522#
3523
Joe Perchesb4749e92015-07-17 16:24:01 -07003524 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003525 my $msg_type = "LONG_LINE";
3526
3527 # Check the allowed long line types first
3528
3529 # logging functions that end in a string that starts
3530 # before $max_line_length
3531 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3532 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3533 $msg_type = "";
3534
3535 # lines with only strings (w/ possible termination)
3536 # #defines with only strings
3537 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3538 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3539 $msg_type = "";
3540
Joe Perchescc147502017-11-17 15:28:44 -08003541 # More special cases
3542 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3543 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003544 $msg_type = "";
3545
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003546 # URL ($rawline is used in case the URL is in a comment)
3547 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3548 $msg_type = "";
3549
Joe Perches47e0c882015-06-25 15:02:57 -07003550 # Otherwise set the alternate message types
3551
3552 # a comment starts before $max_line_length
3553 } elsif ($line =~ /($;[\s$;]*)$/ &&
3554 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3555 $msg_type = "LONG_LINE_COMMENT"
3556
3557 # a quoted string starts before $max_line_length
3558 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3559 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3560 $msg_type = "LONG_LINE_STRING"
3561 }
3562
3563 if ($msg_type ne "" &&
3564 (show_type("LONG_LINE") || show_type($msg_type))) {
Joe Perchesbdc48fa2020-05-29 16:12:21 -07003565 my $msg_level = \&WARN;
3566 $msg_level = \&CHK if ($file);
3567 &{$msg_level}($msg_type,
3568 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Joe Perches47e0c882015-06-25 15:02:57 -07003569 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003570 }
3571
Andy Whitcroft8905a672007-11-28 16:21:06 -08003572# check for adding lines without a newline.
3573 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Tom Rix47ca69b2020-12-15 20:44:40 -08003574 if (WARN("MISSING_EOF_NEWLINE",
3575 "adding a line without newline at end of file\n" . $herecurr) &&
3576 $fix) {
3577 fix_delete_line($fixlinenr+1, "No newline at end of file");
3578 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003579 }
3580
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003581# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003582 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003583
3584# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003585# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003586 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3587 $rawline =~ /^\+\s* \s*/) {
3588 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003589 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003590 if (ERROR("CODE_INDENT",
3591 "code indent should use tabs where possible\n" . $herevet) &&
3592 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003593 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003594 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003595 }
3596
Alberto Panizzo08e44362010-03-05 13:43:54 -08003597# check for space before tabs.
3598 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3599 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003600 if (WARN("SPACE_BEFORE_TAB",
3601 "please, no space before tabs\n" . $herevet) &&
3602 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003603 while ($fixed[$fixlinenr] =~
Antonio Borneo713a09d2020-04-06 20:11:07 -07003604 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003605 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003606 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003607 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003608 }
3609
Joe Perches6a487212018-04-10 16:34:04 -07003610# check for assignments on the start of a line
3611 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
Aditya Srivastavada7355a2020-12-15 20:45:06 -08003612 my $operator = $1;
3613 if (CHK("ASSIGNMENT_CONTINUATIONS",
3614 "Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
3615 $fix && $prevrawline =~ /^\+/) {
3616 # add assignment operator to the previous line, remove from current line
3617 $fixed[$fixlinenr - 1] .= " $operator";
3618 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3619 }
Joe Perches6a487212018-04-10 16:34:04 -07003620 }
3621
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003622# check for && or || at the start of a line
3623 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
Aditya Srivastava8e08f072020-12-15 20:45:09 -08003624 my $operator = $1;
3625 if (CHK("LOGICAL_CONTINUATIONS",
3626 "Logical continuations should be on the previous line\n" . $hereprev) &&
3627 $fix && $prevrawline =~ /^\+/) {
3628 # insert logical operator at last non-comment, non-whitepsace char on previous line
3629 $prevline =~ /[\s$;]*$/;
3630 my $line_end = substr($prevrawline, $-[0]);
3631 $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
3632 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3633 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003634 }
3635
Joe Perchesa91e8992016-05-20 17:04:05 -07003636# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003637 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003638 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003639 my $indent = length($1);
Antonio Borneo713a09d2020-04-06 20:11:07 -07003640 if ($indent % $tabsize) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003641 if (WARN("TABSTOP",
3642 "Statements should start on a tabstop\n" . $herecurr) &&
3643 $fix) {
Antonio Borneo713a09d2020-04-06 20:11:07 -07003644 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Joe Perchesa91e8992016-05-20 17:04:05 -07003645 }
3646 }
3647 }
3648
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003649# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003650 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003651 $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 -07003652 $prevline =~ /^\+(\t*)(.*)$/;
3653 my $oldindent = $1;
3654 my $rest = $2;
3655
3656 my $pos = pos_last_openparen($rest);
3657 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003658 $line =~ /^(\+| )([ \t]*)/;
3659 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003660
3661 my $goodtabindent = $oldindent .
Antonio Borneo713a09d2020-04-06 20:11:07 -07003662 "\t" x ($pos / $tabsize) .
3663 " " x ($pos % $tabsize);
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003664 my $goodspaceindent = $oldindent . " " x $pos;
3665
3666 if ($newindent ne $goodtabindent &&
3667 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003668
3669 if (CHK("PARENTHESIS_ALIGNMENT",
3670 "Alignment should match open parenthesis\n" . $hereprev) &&
3671 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003672 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003673 s/^\+[ \t]*/\+$goodtabindent/;
3674 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003675 }
3676 }
3677 }
3678
Joe Perches6ab3a972015-04-16 12:44:05 -07003679# check for space after cast like "(int) foo" or "(struct foo) bar"
3680# avoid checking a few false positives:
3681# "sizeof(<type>)" or "__alignof__(<type>)"
3682# function pointer declarations like "(*foo)(int) = bar;"
3683# structure definitions like "(struct foo) { 0 };"
3684# multiline macros that define functions
3685# known attributes or the __attribute__ keyword
3686 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3687 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003688 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003689 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003690 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003691 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003692 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003693 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003694 }
3695
Joe Perches86406b12015-09-09 15:37:41 -07003696# Block comment styles
3697# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003698 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003699 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003700 $rawline =~ /^\+[ \t]*\*/ &&
Łukasz Stelmachc70735c2020-10-15 20:12:25 -07003701 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
Joe Perches05880602012-10-04 17:13:35 -07003702 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3703 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3704 }
3705
Joe Perches86406b12015-09-09 15:37:41 -07003706# Block comments use * on subsequent lines
3707 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3708 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003709 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003710 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003711 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003712 WARN("BLOCK_COMMENT_STYLE",
3713 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003714 }
3715
Joe Perches86406b12015-09-09 15:37:41 -07003716# Block comments use */ on trailing lines
3717 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003718 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3719 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3720 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003721 WARN("BLOCK_COMMENT_STYLE",
3722 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003723 }
3724
Joe Perches08eb9b82016-10-11 13:51:50 -07003725# Block comment * alignment
3726 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003727 $line =~ /^\+[ \t]*$;/ && #leading comment
3728 $rawline =~ /^\+[ \t]*\*/ && #leading *
3729 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003730 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003731 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3732 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003733 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003734 if (defined($1)) {
3735 $oldindent = expand_tabs($1);
3736 } else {
3737 $prevrawline =~ m@^\+(.*/?)\*@;
3738 $oldindent = expand_tabs($1);
3739 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003740 $rawline =~ m@^\+([ \t]*)\*@;
3741 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003742 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003743 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003744 WARN("BLOCK_COMMENT_STYLE",
3745 "Block comments should align the * on each line\n" . $hereprev);
3746 }
3747 }
3748
Joe Perches7f619192014-08-06 16:10:39 -07003749# check for missing blank lines after struct/union declarations
3750# with exceptions for various attributes and macros
3751 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3752 $line =~ /^\+/ &&
3753 !($line =~ /^\+\s*$/ ||
3754 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3755 $line =~ /^\+\s*MODULE_/i ||
3756 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3757 $line =~ /^\+[a-z_]*init/ ||
3758 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3759 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003760 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003761 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003762 if (CHK("LINE_SPACING",
3763 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3764 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003765 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003766 }
Joe Perches7f619192014-08-06 16:10:39 -07003767 }
3768
Joe Perches365dd4e2014-08-06 16:10:42 -07003769# check for multiple consecutive blank lines
3770 if ($prevline =~ /^[\+ ]\s*$/ &&
3771 $line =~ /^\+\s*$/ &&
3772 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003773 if (CHK("LINE_SPACING",
3774 "Please don't use multiple blank lines\n" . $hereprev) &&
3775 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003776 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003777 }
3778
Joe Perches365dd4e2014-08-06 16:10:42 -07003779 $last_blank_line = $linenr;
3780 }
3781
Joe Perches3b617e32014-04-03 14:49:28 -07003782# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003783 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3784 # actual declarations
3785 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003786 # function pointer declarations
3787 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003788 # foo bar; where foo is some local typedef or #define
3789 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3790 # known declaration macros
3791 $prevline =~ /^\+\s+$declaration_macros/) &&
3792 # for "else if" which can look like "$Ident $Ident"
3793 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3794 # other possible extensions of declaration lines
3795 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3796 # not starting a section or a macro "\" extended line
3797 $prevline =~ /(?:\{\s*|\\)$/) &&
3798 # looks like a declaration
3799 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003800 # function pointer declarations
3801 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003802 # foo bar; where foo is some local typedef or #define
3803 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3804 # known declaration macros
3805 $sline =~ /^\+\s+$declaration_macros/ ||
3806 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003807 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003808 # start or end of block or continuation of declaration
3809 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3810 # bitfield continuation
3811 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3812 # other possible extensions of declaration lines
3813 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3814 # indentation of previous and current line are the same
3815 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003816 if (WARN("LINE_SPACING",
3817 "Missing a blank line after declarations\n" . $hereprev) &&
3818 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003819 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003820 }
Joe Perches3b617e32014-04-03 14:49:28 -07003821 }
3822
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003823# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003824# Exceptions:
3825# 1) within comments
3826# 2) indented preprocessor commands
3827# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003828 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003829 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003830 if (WARN("LEADING_SPACE",
3831 "please, no spaces at the start of a line\n" . $herevet) &&
3832 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003833 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003834 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003835 }
3836
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003837# check we are in a valid C source file if not then ignore this hunk
3838 next if ($realfile !~ /\.(h|c)$/);
3839
Joe Perches5751a242017-11-17 15:28:52 -08003840# check for unusual line ending [ or (
3841 if ($line =~ /^\+.*([\[\(])\s*$/) {
3842 CHK("OPEN_ENDED_LINE",
3843 "Lines should not end with a '$1'\n" . $herecurr);
3844 }
3845
Joe Perches4dbed762017-05-08 15:55:39 -07003846# check if this appears to be the start function declaration, save the name
3847 if ($sline =~ /^\+\{\s*$/ &&
3848 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3849 $context_function = $1;
3850 }
3851
3852# check if this appears to be the end of function declaration
3853 if ($sline =~ /^\+\}\s*$/) {
3854 undef $context_function;
3855 }
3856
Joe Perches032a4c02014-08-06 16:10:29 -07003857# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003858# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003859# if the previous line is a break or return and is indented 1 tab more...
3860 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3861 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003862 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3863 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3864 defined $lines[$linenr] &&
3865 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003866 WARN("UNNECESSARY_ELSE",
3867 "else is not generally useful after a break or return\n" . $hereprev);
3868 }
3869 }
3870
Joe Perchesc00df192014-08-06 16:11:01 -07003871# check indentation of a line with a break;
Joe Perchesdc58bc52020-12-15 20:44:33 -08003872# if the previous line is a goto, return or break
3873# and is indented the same # of tabs
Joe Perchesc00df192014-08-06 16:11:01 -07003874 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3875 my $tabs = $1;
Joe Perchesdc58bc52020-12-15 20:44:33 -08003876 if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
3877 if (WARN("UNNECESSARY_BREAK",
3878 "break is not useful after a $1\n" . $hereprev) &&
3879 $fix) {
3880 fix_delete_line($fixlinenr, $rawline);
3881 }
Joe Perchesc00df192014-08-06 16:11:01 -07003882 }
3883 }
3884
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003885# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003886 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003887 WARN("CVS_KEYWORD",
3888 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003889 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003890
Joe Perches56e77d72013-02-21 16:44:14 -08003891# check for old HOTPLUG __dev<foo> section markings
3892 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3893 WARN("HOTPLUG_SECTION",
3894 "Using $1 is unnecessary\n" . $herecurr);
3895 }
3896
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003897# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003898 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3899 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003900#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003901 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003902 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003903 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003904 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003905 $stat =~ s/\n./\n /g;
3906 $cond =~ s/\n./\n /g;
3907
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003908#print "linenr<$linenr> <$stat>\n";
3909 # If this statement has no statement boundaries within
3910 # it there is no point in retrying a statement scan
3911 # until we hit end of it.
3912 my $frag = $stat; $frag =~ s/;+\s*$//;
3913 if ($frag !~ /(?:{|;)/) {
3914#print "skip<$line_nr_next>\n";
3915 $suppress_statement = $line_nr_next;
3916 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003917
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003918 # Find the real next line.
3919 $realline_next = $line_nr_next;
3920 if (defined $realline_next &&
3921 (!defined $lines[$realline_next - 1] ||
3922 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3923 $realline_next++;
3924 }
3925
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003926 my $s = $stat;
3927 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003928
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003929 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003930 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003931
3932 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003933 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003934
Andy Whitcroft463f2862009-09-21 17:04:34 -07003935 } elsif ($s =~ /^.\s*else\b/s) {
3936
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003937 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003938 } 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 -07003939 my $type = $1;
3940 $type =~ s/\s+/ /g;
3941 possible($type, "A:" . $s);
3942
Andy Whitcroft8905a672007-11-28 16:21:06 -08003943 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003944 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003945 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003946 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003947
3948 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003949 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003950 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003951 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003952
3953 # Check for any sort of function declaration.
3954 # int foo(something bar, other baz);
3955 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003956 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 -08003957 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003958
Andy Whitcroftcf655042008-03-04 14:28:20 -08003959 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003960 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003961 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003962
Andy Whitcroft8905a672007-11-28 16:21:06 -08003963 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003964 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003965
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003966 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003967 }
3968 }
3969 }
3970
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003971 }
3972
Andy Whitcroft653d4872007-06-23 17:16:34 -07003973#
3974# Checks which may be anchored in the context.
3975#
3976
3977# Check for switch () and associated case and default
3978# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003979 if ($line=~/\bswitch\s*\(.*\)/) {
3980 my $err = '';
3981 my $sep = '';
3982 my @ctx = ctx_block_outer($linenr, $realcnt);
3983 shift(@ctx);
3984 for my $ctx (@ctx) {
3985 my ($clen, $cindent) = line_stats($ctx);
3986 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3987 $indent != $cindent) {
3988 $err .= "$sep$ctx\n";
3989 $sep = '';
3990 } else {
3991 $sep = "[...]\n";
3992 }
3993 }
3994 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003995 ERROR("SWITCH_CASE_INDENT_LEVEL",
3996 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003997 }
3998 }
3999
4000# if/while/etc brace do not go on next line, unless defining a do while loop,
4001# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07004002 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 -07004003 my $pre_ctx = "$1$2";
4004
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004005 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08004006
4007 if ($line =~ /^\+\t{6,}/) {
4008 WARN("DEEP_INDENTATION",
4009 "Too many leading tabs - consider code refactoring\n" . $herecurr);
4010 }
4011
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004012 my $ctx_cnt = $realcnt - $#ctx - 1;
4013 my $ctx = join("\n", @ctx);
4014
Andy Whitcroft548596d2008-07-23 21:29:01 -07004015 my $ctx_ln = $linenr;
4016 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004017
Andy Whitcroft548596d2008-07-23 21:29:01 -07004018 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
4019 defined $lines[$ctx_ln - 1] &&
4020 $lines[$ctx_ln - 1] =~ /^-/)) {
4021 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4022 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004023 $ctx_ln++;
4024 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07004025
Andy Whitcroft53210162008-07-23 21:29:03 -07004026 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4027 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07004028
Joe Perchesd752fcc2014-08-06 16:11:05 -07004029 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004030 ERROR("OPEN_BRACE",
4031 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004032 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07004033 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004034 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
4035 $ctx =~ /\)\s*\;\s*$/ &&
4036 defined $lines[$ctx_ln - 1])
4037 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004038 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
4039 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004040 WARN("TRAILING_SEMICOLON",
4041 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004042 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004043 }
4044 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004045 }
4046
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004047# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07004048 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 -08004049 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4050 ctx_statement_block($linenr, $realcnt, 0)
4051 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004052 my ($s, $c) = ($stat, $cond);
4053
4054 substr($s, 0, length($c), '');
4055
Joe Perches9f5af482015-09-09 15:37:30 -07004056 # remove inline comments
4057 $s =~ s/$;/ /g;
4058 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004059
4060 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07004061 my @newlines = ($c =~ /\n/gs);
4062 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004063
Joe Perches9f5af482015-09-09 15:37:30 -07004064 # Make sure we remove the line prefixes as we have
4065 # none on the first line, and are going to readd them
4066 # where necessary.
4067 $s =~ s/\n./\n/gs;
4068 while ($s =~ /\n\s+\\\n/) {
4069 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
4070 }
4071
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004072 # We want to check the first line inside the block
4073 # starting at the end of the conditional, so remove:
4074 # 1) any blank line termination
4075 # 2) any opening brace { on end of the line
4076 # 3) any do (...) {
4077 my $continuation = 0;
4078 my $check = 0;
4079 $s =~ s/^.*\bdo\b//;
4080 $s =~ s/^\s*{//;
4081 if ($s =~ s/^\s*\\//) {
4082 $continuation = 1;
4083 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004084 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004085 $check = 1;
4086 $cond_lines++;
4087 }
4088
4089 # Also ignore a loop construct at the end of a
4090 # preprocessor statement.
4091 if (($prevline =~ /^.\s*#\s*define\s/ ||
4092 $prevline =~ /\\\s*$/) && $continuation == 0) {
4093 $check = 0;
4094 }
4095
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004096 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07004097 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004098 while ($cond_ptr != $cond_lines) {
4099 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004100
Andy Whitcroftf16fa282008-10-15 22:02:32 -07004101 # If we see an #else/#elif then the code
4102 # is not linear.
4103 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
4104 $check = 0;
4105 }
4106
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004107 # Ignore:
4108 # 1) blank lines, they should be at 0,
4109 # 2) preprocessor lines, and
4110 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07004111 if ($continuation ||
4112 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004113 $s =~ /^\s*#\s*?/ ||
4114 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07004115 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07004116 if ($s =~ s/^.*?\n//) {
4117 $cond_lines++;
4118 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004119 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004120 }
4121
4122 my (undef, $sindent) = line_stats("+" . $s);
4123 my $stat_real = raw_line($linenr, $cond_lines);
4124
4125 # Check if either of these lines are modified, else
4126 # this is not this patch's fault.
4127 if (!defined($stat_real) ||
4128 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
4129 $check = 0;
4130 }
4131 if (defined($stat_real) && $cond_lines > 1) {
4132 $stat_real = "[...]\n$stat_real";
4133 }
4134
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004135 #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 -07004136
Joe Perches9f5af482015-09-09 15:37:30 -07004137 if ($check && $s ne '' &&
Antonio Borneo713a09d2020-04-06 20:11:07 -07004138 (($sindent % $tabsize) != 0 ||
Joe Perches9f5af482015-09-09 15:37:30 -07004139 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07004140 ($sindent == $indent &&
4141 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Antonio Borneo713a09d2020-04-06 20:11:07 -07004142 ($sindent > $indent + $tabsize))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004143 WARN("SUSPECT_CODE_INDENT",
4144 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004145 }
4146 }
4147
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004148 # Track the 'values' across context and added lines.
4149 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004150 my ($curr_values, $curr_vars) =
4151 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004152 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004153 if ($dbg_values) {
4154 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004155 print "$linenr > .$outline\n";
4156 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004157 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004158 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004159 $prev_values = substr($curr_values, -1);
4160
Andy Whitcroft00df3442007-06-08 13:47:06 -07004161#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07004162 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07004163
Joe Perches99ca38c2020-10-15 20:12:09 -07004164# check for self assignments used to avoid compiler warnings
4165# e.g.: int foo = foo, *bar = NULL;
4166# struct foo bar = *(&(bar));
4167 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
4168 my $var = $1;
4169 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4170 WARN("SELF_ASSIGNMENT",
4171 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
4172 }
4173 }
4174
Joe Perches11ca40a2016-12-12 16:46:31 -08004175# check for dereferences that span multiple lines
4176 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
4177 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
4178 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
4179 my $ref = $1;
4180 $line =~ /^.\s*($Lval)/;
4181 $ref .= $1;
4182 $ref =~ s/\s//g;
4183 WARN("MULTILINE_DEREFERENCE",
4184 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
4185 }
4186
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004187# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07004188 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 -07004189 my $type = $1;
4190 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07004191 $var = "" if (!defined $var);
4192 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004193 my $sign = $1;
4194 my $pointer = $2;
4195
4196 $pointer = "" if (!defined $pointer);
4197
4198 if (WARN("UNSPECIFIED_INT",
4199 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4200 $fix) {
4201 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07004202 my $comp_pointer = $pointer;
4203 $comp_pointer =~ s/\s//g;
4204 $decl .= $comp_pointer;
4205 $decl = rtrim($decl) if ($var eq "");
4206 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004207 }
4208 }
4209 }
4210
Andy Whitcroft653d4872007-06-23 17:16:34 -07004211# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07004212 if ($dbg_type) {
4213 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004214 ERROR("TEST_TYPE",
4215 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004216 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004217 ERROR("TEST_NOT_TYPE",
4218 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004219 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004220 next;
4221 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004222# TEST: allow direct testing of the attribute matcher.
4223 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004224 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004225 ERROR("TEST_ATTR",
4226 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004227 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004228 ERROR("TEST_NOT_ATTR",
4229 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004230 }
4231 next;
4232 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004233
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004234# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07004235 if ($line =~ /^.\s*{/ &&
4236 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07004237 if (ERROR("OPEN_BRACE",
4238 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004239 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4240 fix_delete_line($fixlinenr - 1, $prevrawline);
4241 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004242 my $fixedline = $prevrawline;
4243 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004244 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004245 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004246 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004247 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004248 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004249 }
4250
Andy Whitcroft653d4872007-06-23 17:16:34 -07004251#
4252# Checks which are anchored on the added line.
4253#
4254
4255# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004256 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07004257 my $path = $1;
4258 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004259 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08004260 "malformed #include filename\n" . $herecurr);
4261 }
4262 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4263 ERROR("UAPI_INCLUDE",
4264 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004265 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004266 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004267
4268# no C99 // comments
4269 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07004270 if (ERROR("C99_COMMENTS",
4271 "do not use C99 // comments\n" . $herecurr) &&
4272 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004273 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07004274 if ($line =~ /\/\/(.*)$/) {
4275 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07004276 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07004277 }
4278 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004279 }
4280 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004281 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004282 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004283
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004284# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4285# the whole statement.
4286#print "APW <$lines[$realline_next - 1]>\n";
4287 if (defined $realline_next &&
4288 exists $lines[$realline_next - 1] &&
4289 !defined $suppress_export{$realline_next} &&
4290 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4291 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004292 # Handle definitions which produce identifiers with
4293 # a prefix:
4294 # XXX(foo);
4295 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004296 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08004297 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004298 $name =~ /^${Ident}_$2/) {
4299#print "FOO C name<$name>\n";
4300 $suppress_export{$realline_next} = 1;
4301
4302 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004303 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07004304 ^.DEFINE_$Ident\(\Q$name\E\)|
4305 ^.DECLARE_$Ident\(\Q$name\E\)|
4306 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004307 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4308 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07004309 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004310#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4311 $suppress_export{$realline_next} = 2;
4312 } else {
4313 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004314 }
4315 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004316 if (!defined $suppress_export{$linenr} &&
4317 $prevline =~ /^.\s*$/ &&
4318 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4319 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4320#print "FOO B <$lines[$linenr - 1]>\n";
4321 $suppress_export{$linenr} = 2;
4322 }
4323 if (defined $suppress_export{$linenr} &&
4324 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004325 WARN("EXPORT_SYMBOL",
4326 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004327 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004328
Joe Eloff5150bda2010-08-09 17:21:00 -07004329# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004330 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004331 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004332 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07004333 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004334 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004335 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004336 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004337# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004338 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004339 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004340 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07004341 $herecurr) &&
4342 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004343 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004344 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004345 }
4346
Joe Perches18130872014-08-06 16:11:22 -07004347# check for misordered declarations of char/short/int/long with signed/unsigned
4348 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4349 my $tmp = trim($1);
4350 WARN("MISORDERED_TYPE",
4351 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4352 }
4353
Joe Perches809e0822018-08-21 21:58:12 -07004354# check for unnecessary <signed> int declarations of short/long/long long
4355 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4356 my $type = trim($1);
4357 next if ($type !~ /\bint\b/);
4358 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4359 my $new_type = $type;
4360 $new_type =~ s/\b\s*int\s*\b/ /;
4361 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4362 $new_type =~ s/^const\s+//;
4363 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4364 $new_type = "const $new_type" if ($type =~ /^const\b/);
4365 $new_type =~ s/\s+/ /g;
4366 $new_type = trim($new_type);
4367 if (WARN("UNNECESSARY_INT",
4368 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4369 $fix) {
4370 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4371 }
4372 }
4373
Joe Perchescb710ec2010-10-26 14:23:20 -07004374# check for static const char * arrays.
4375 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004376 WARN("STATIC_CONST_CHAR_ARRAY",
4377 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004378 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004379 }
4380
4381# check for initialized const char arrays that should be static const
4382 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4383 if (WARN("STATIC_CONST_CHAR_ARRAY",
4384 "const array should probably be static const\n" . $herecurr) &&
4385 $fix) {
4386 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4387 }
4388 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004389
4390# check for static char foo[] = "bar" declarations.
4391 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004392 WARN("STATIC_CONST_CHAR_ARRAY",
4393 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004394 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004395 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004396
Joe Perchesab7e23f2015-04-16 12:44:22 -07004397# check for const <foo> const where <foo> is not a pointer or array type
4398 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4399 my $found = $1;
4400 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4401 WARN("CONST_CONST",
4402 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4403 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4404 WARN("CONST_CONST",
4405 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4406 }
4407 }
4408
Joe Perches73169762020-12-15 20:44:30 -08004409# check for const static or static <non ptr type> const declarations
4410# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4411 if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
4412 $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
4413 if (WARN("STATIC_CONST",
4414 "Move const after static - use 'static const $1'\n" . $herecurr) &&
4415 $fix) {
4416 $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
4417 $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
4418 }
4419 }
4420
Joe Perches9b0fa602014-04-03 14:49:18 -07004421# check for non-global char *foo[] = {"bar", ...} declarations.
4422 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4423 WARN("STATIC_CONST_CHAR_ARRAY",
4424 "char * array declaration might be better as static const\n" .
4425 $herecurr);
4426 }
4427
Joe Perchesb598b672015-04-16 12:44:36 -07004428# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4429 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4430 my $array = $1;
4431 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4432 my $array_div = $1;
4433 if (WARN("ARRAY_SIZE",
4434 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4435 $fix) {
4436 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4437 }
4438 }
4439 }
4440
Joe Perchesb36190c2014-01-27 17:07:18 -08004441# check for function declarations without arguments like "int foo()"
Joe Perches16b7f3c2020-04-06 20:11:17 -07004442 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Joe Perchesb36190c2014-01-27 17:07:18 -08004443 if (ERROR("FUNCTION_WITHOUT_ARGS",
4444 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4445 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004446 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004447 }
4448 }
4449
Andy Whitcroft653d4872007-06-23 17:16:34 -07004450# check for new typedefs, only function parameters and sparse annotations
4451# make sense.
4452 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004453 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004454 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004455 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004456 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004457 WARN("NEW_TYPEDEFS",
4458 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004459 }
4460
4461# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004462 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004463 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4464 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004465 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004466
Andy Whitcroft65863862009-01-06 14:41:21 -08004467 # Should start with a space.
4468 $to =~ s/^(\S)/ $1/;
4469 # Should not end with a space.
4470 $to =~ s/\s+$//;
4471 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004472 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004473 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004474
Joe Perches3705ce52013-07-03 15:05:31 -07004475## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004476 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004477 if (ERROR("POINTER_LOCATION",
4478 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4479 $fix) {
4480 my $sub_from = $ident;
4481 my $sub_to = $ident;
4482 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004483 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004484 s@\Q$sub_from\E@$sub_to@;
4485 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004486 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004487 }
4488 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4489 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004490 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004491
Andy Whitcroft65863862009-01-06 14:41:21 -08004492 # Should start with a space.
4493 $to =~ s/^(\S)/ $1/;
4494 # Should not end with a space.
4495 $to =~ s/\s+$//;
4496 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004497 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004498 }
4499 # Modifiers should have spaces.
4500 $to =~ s/(\b$Modifier$)/$1 /;
4501
Joe Perches3705ce52013-07-03 15:05:31 -07004502## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004503 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004504 if (ERROR("POINTER_LOCATION",
4505 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4506 $fix) {
4507
4508 my $sub_from = $match;
4509 my $sub_to = $match;
4510 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004511 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004512 s@\Q$sub_from\E@$sub_to@;
4513 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004514 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004515 }
4516
Joe Perches9d3e3c72015-09-09 15:37:27 -07004517# avoid BUG() or BUG_ON()
4518 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004519 my $msg_level = \&WARN;
4520 $msg_level = \&CHK if ($file);
4521 &{$msg_level}("AVOID_BUG",
4522 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
Joe Perches9d3e3c72015-09-09 15:37:27 -07004523 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004524
Joe Perches9d3e3c72015-09-09 15:37:27 -07004525# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004526 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004527 WARN("LINUX_VERSION_CODE",
4528 "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 -08004529 }
4530
Joe Perches17441222011-06-15 15:08:17 -07004531# check for uses of printk_ratelimit
4532 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004533 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004534 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004535 }
4536
Joe Percheseeef5732017-11-17 15:28:41 -08004537# printk should use KERN_* levels
4538 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4539 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4540 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004541 }
4542
Joe Perches243f3802012-05-31 16:26:09 -07004543 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4544 my $orig = $1;
4545 my $level = lc($orig);
4546 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004547 my $level2 = $level;
4548 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004549 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004550 "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 -07004551 }
4552
Joe Perchesdc139312013-02-21 16:44:13 -08004553 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4554 my $orig = $1;
4555 my $level = lc($orig);
4556 $level = "warn" if ($level eq "warning");
4557 $level = "dbg" if ($level eq "debug");
4558 WARN("PREFER_DEV_LEVEL",
4559 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4560 }
4561
Nicolas Boichat8020b252020-10-15 20:12:02 -07004562# trace_printk should not be used in production code.
4563 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4564 WARN("TRACE_PRINTK",
4565 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4566 }
4567
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004568# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4569# number of false positives, but assembly files are not checked, so at
4570# least the arch entry code will not trigger this warning.
4571 if ($line =~ /\bENOSYS\b/) {
4572 WARN("ENOSYS",
4573 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4574 }
4575
Jakub Kicinski6b9ea5f2020-05-11 10:08:07 -07004576# ENOTSUPP is not a standard error code and should be avoided in new patches.
4577# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4578# Similarly to ENOSYS warning a small number of false positives is expected.
4579 if (!$file && $line =~ /\bENOTSUPP\b/) {
4580 if (WARN("ENOTSUPP",
4581 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4582 $fix) {
4583 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4584 }
4585 }
4586
Andy Whitcroft653d4872007-06-23 17:16:34 -07004587# function brace can't be on same line, except for #defines of do while,
4588# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004589 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004590 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4591 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4592 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004593 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004594 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004595 $fix) {
4596 fix_delete_line($fixlinenr, $rawline);
4597 my $fixed_line = $rawline;
Dwaipayan Ray03f49352020-12-15 20:45:02 -08004598 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
Joe Perches8d182472014-08-06 16:11:12 -07004599 my $line1 = $1;
4600 my $line2 = $2;
4601 fix_insert_line($fixlinenr, ltrim($line1));
4602 fix_insert_line($fixlinenr, "\+{");
4603 if ($line2 !~ /^\s*$/) {
4604 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4605 }
4606 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004607 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004608
Andy Whitcroft8905a672007-11-28 16:21:06 -08004609# open braces for enum, union and struct go on the same line.
4610 if ($line =~ /^.\s*{/ &&
4611 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004612 if (ERROR("OPEN_BRACE",
4613 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4614 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4615 fix_delete_line($fixlinenr - 1, $prevrawline);
4616 fix_delete_line($fixlinenr, $rawline);
4617 my $fixedline = rtrim($prevrawline) . " {";
4618 fix_insert_line($fixlinenr, $fixedline);
4619 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004620 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004621 if ($fixedline !~ /^\+\s*$/) {
4622 fix_insert_line($fixlinenr, $fixedline);
4623 }
4624 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004625 }
4626
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004627# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004628 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4629 if (WARN("SPACING",
4630 "missing space after $1 definition\n" . $herecurr) &&
4631 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004632 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004633 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4634 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004635 }
4636
Joe Perches31070b52014-01-23 15:54:49 -08004637# Function pointer declarations
4638# check spacing between type, funcptr, and args
4639# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004640 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004641 my $declare = $1;
4642 my $pre_pointer_space = $2;
4643 my $post_pointer_space = $3;
4644 my $funcname = $4;
4645 my $post_funcname_space = $5;
4646 my $pre_args_space = $6;
4647
Joe Perches91f72e92014-04-03 14:49:12 -07004648# the $Declare variable will capture all spaces after the type
4649# so check it for a missing trailing missing space but pointer return types
4650# don't need a space so don't warn for those.
4651 my $post_declare_space = "";
4652 if ($declare =~ /(\s+)$/) {
4653 $post_declare_space = $1;
4654 $declare = rtrim($declare);
4655 }
4656 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004657 WARN("SPACING",
4658 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004659 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004660 }
4661
4662# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004663# This test is not currently implemented because these declarations are
4664# equivalent to
4665# int foo(int bar, ...)
4666# and this is form shouldn't/doesn't generate a checkpatch warning.
4667#
4668# elsif ($declare =~ /\s{2,}$/) {
4669# WARN("SPACING",
4670# "Multiple spaces after return type\n" . $herecurr);
4671# }
Joe Perches31070b52014-01-23 15:54:49 -08004672
4673# unnecessary space "type ( *funcptr)(args...)"
4674 if (defined $pre_pointer_space &&
4675 $pre_pointer_space =~ /^\s/) {
4676 WARN("SPACING",
4677 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4678 }
4679
4680# unnecessary space "type (* funcptr)(args...)"
4681 if (defined $post_pointer_space &&
4682 $post_pointer_space =~ /^\s/) {
4683 WARN("SPACING",
4684 "Unnecessary space before function pointer name\n" . $herecurr);
4685 }
4686
4687# unnecessary space "type (*funcptr )(args...)"
4688 if (defined $post_funcname_space &&
4689 $post_funcname_space =~ /^\s/) {
4690 WARN("SPACING",
4691 "Unnecessary space after function pointer name\n" . $herecurr);
4692 }
4693
4694# unnecessary space "type (*funcptr) (args...)"
4695 if (defined $pre_args_space &&
4696 $pre_args_space =~ /^\s/) {
4697 WARN("SPACING",
4698 "Unnecessary space before function pointer arguments\n" . $herecurr);
4699 }
4700
4701 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004702 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004703 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004704 }
4705 }
4706
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004707# check for spacing round square brackets; allowed:
4708# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004709# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4710# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004711 while ($line =~ /(.*?\s)\[/g) {
4712 my ($where, $prefix) = ($-[1], $1);
4713 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004714 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004715 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004716 if (ERROR("BRACKET_SPACE",
4717 "space prohibited before open square bracket '['\n" . $herecurr) &&
4718 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004719 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004720 s/^(\+.*?)\s+\[/$1\[/;
4721 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004722 }
4723 }
4724
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004725# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004726 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004727 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004728 my $ctx_before = substr($line, 0, $-[1]);
4729 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004730
4731 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004732 if ($name =~ /^(?:
4733 if|for|while|switch|return|case|
4734 volatile|__volatile__|
4735 __attribute__|format|__extension__|
4736 asm|__asm__)$/x)
4737 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004738 # cpp #define statements have non-optional spaces, ie
4739 # if there is a space between the name and the open
4740 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004741 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004742
4743 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004744 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004745
4746 # If this whole things ends with a type its most
4747 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004748 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004749
4750 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004751 if (WARN("SPACING",
4752 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4753 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004754 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004755 s/\b$name\s+\(/$name\(/;
4756 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004757 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004758 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004759
Andy Whitcroft653d4872007-06-23 17:16:34 -07004760# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004761 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004762 my $fixed_line = "";
4763 my $line_fixed = 0;
4764
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004765 my $ops = qr{
4766 <<=|>>=|<=|>=|==|!=|
4767 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4768 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004769 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004770 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004771 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004772 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004773
4774## print("element count: <" . $#elements . ">\n");
4775## foreach my $el (@elements) {
4776## print("el: <$el>\n");
4777## }
4778
4779 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004780 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004781
Joe Perches3705ce52013-07-03 15:05:31 -07004782 foreach my $el (@elements) {
4783 push(@fix_elements, substr($rawline, $off, length($el)));
4784 $off += length($el);
4785 }
4786
4787 $off = 0;
4788
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004789 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004790 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004791
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004792 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004793
4794 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4795
4796## print("n: <$n> good: <$good>\n");
4797
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004798 $off += length($elements[$n]);
4799
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004800 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004801 my $ca = substr($opline, 0, $off);
4802 my $cc = '';
4803 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4804 $cc = substr($opline, $off + length($elements[$n + 1]));
4805 }
4806 my $cb = "$ca$;$cc";
4807
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004808 my $a = '';
4809 $a = 'V' if ($elements[$n] ne '');
4810 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004811 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004812 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4813 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004814 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004815
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004816 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004817
4818 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004819 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004820 $c = 'V' if ($elements[$n + 2] ne '');
4821 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004822 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004823 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4824 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004825 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004826 } else {
4827 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004828 }
4829
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004830 my $ctx = "${a}x${c}";
4831
4832 my $at = "(ctx:$ctx)";
4833
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004834 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004835 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004836
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004837 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004838 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004839
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004840 # Get the full operator variant.
4841 my $opv = $op . substr($curr_vars, $off, 1);
4842
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004843 # Ignore operators passed as parameters.
4844 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004845 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004846
Andy Whitcroftcf655042008-03-04 14:28:20 -08004847# # Ignore comments
4848# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004849
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004850 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004851 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004852 if ($ctx !~ /.x[WEBC]/ &&
4853 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004854 if (ERROR("SPACING",
4855 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004856 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004857 $line_fixed = 1;
4858 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004859 }
4860
4861 # // is a comment
4862 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004863
Joe Perchesb00e4812014-04-03 14:49:33 -07004864 # : when part of a bitfield
4865 } elsif ($opv eq ':B') {
4866 # skip the bitfield test for now
4867
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004868 # No spaces for:
4869 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004870 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004871 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004872 if (ERROR("SPACING",
4873 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004874 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004875 if (defined $fix_elements[$n + 2]) {
4876 $fix_elements[$n + 2] =~ s/^\s+//;
4877 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004878 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004879 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004880 }
4881
Joe Perches23810972014-12-10 15:51:32 -08004882 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004883 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004884 my $rtrim_before = 0;
4885 my $space_after = 0;
4886 if ($ctx =~ /Wx./) {
4887 if (ERROR("SPACING",
4888 "space prohibited before that '$op' $at\n" . $hereptr)) {
4889 $line_fixed = 1;
4890 $rtrim_before = 1;
4891 }
4892 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004893 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004894 if (ERROR("SPACING",
4895 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004896 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004897 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004898 $space_after = 1;
4899 }
4900 }
4901 if ($rtrim_before || $space_after) {
4902 if ($rtrim_before) {
4903 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4904 } else {
4905 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4906 }
4907 if ($space_after) {
4908 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004909 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004910 }
4911
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004912 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004913 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004914 #warn "'*' is part of type\n";
4915
4916 # unary operators should have a space before and
4917 # none after. May be left adjacent to another
4918 # unary operator, or a cast
4919 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004920 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004921 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004922 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004923 if (ERROR("SPACING",
4924 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004925 if ($n != $last_after + 2) {
4926 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4927 $line_fixed = 1;
4928 }
Joe Perches3705ce52013-07-03 15:05:31 -07004929 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004930 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004931 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004932 # A unary '*' may be const
4933
4934 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004935 if (ERROR("SPACING",
4936 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004937 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004938 if (defined $fix_elements[$n + 2]) {
4939 $fix_elements[$n + 2] =~ s/^\s+//;
4940 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004941 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004942 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004943 }
4944
4945 # unary ++ and unary -- are allowed no space on one side.
4946 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004947 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004948 if (ERROR("SPACING",
4949 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004950 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004951 $line_fixed = 1;
4952 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004953 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004954 if ($ctx =~ /Wx[BE]/ ||
4955 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004956 if (ERROR("SPACING",
4957 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004958 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004959 $line_fixed = 1;
4960 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004961 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004962 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004963 if (ERROR("SPACING",
4964 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004965 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004966 if (defined $fix_elements[$n + 2]) {
4967 $fix_elements[$n + 2] =~ s/^\s+//;
4968 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004969 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004970 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004971 }
4972
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004973 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004974 } elsif ($op eq '<<' or $op eq '>>' or
4975 $op eq '&' or $op eq '^' or $op eq '|' or
4976 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004977 $op eq '*' or $op eq '/' or
4978 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004979 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004980 if ($check) {
4981 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4982 if (CHK("SPACING",
4983 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4984 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4985 $fix_elements[$n + 2] =~ s/^\s+//;
4986 $line_fixed = 1;
4987 }
4988 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4989 if (CHK("SPACING",
4990 "space preferred before that '$op' $at\n" . $hereptr)) {
4991 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4992 $line_fixed = 1;
4993 }
4994 }
4995 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004996 if (ERROR("SPACING",
4997 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004998 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4999 if (defined $fix_elements[$n + 2]) {
5000 $fix_elements[$n + 2] =~ s/^\s+//;
5001 }
Joe Perches3705ce52013-07-03 15:05:31 -07005002 $line_fixed = 1;
5003 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005004 }
5005
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005006 # A colon needs no spaces before when it is
5007 # terminating a case value or a label.
5008 } elsif ($opv eq ':C' || $opv eq ':L') {
5009 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07005010 if (ERROR("SPACING",
5011 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005012 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005013 $line_fixed = 1;
5014 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005015 }
5016
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005017 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08005018 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005019 my $ok = 0;
5020
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005021 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005022 if (($op eq '<' &&
5023 $cc =~ /^\S+\@\S+>/) ||
5024 ($op eq '>' &&
5025 $ca =~ /<\S+\@\S+$/))
5026 {
Antonio Borneo342d3d22020-04-06 20:11:01 -07005027 $ok = 1;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005028 }
5029
Joe Perchese0df7e12015-04-16 12:44:53 -07005030 # for asm volatile statements
5031 # ignore a colon with another
5032 # colon immediately before or after
5033 if (($op eq ':') &&
5034 ($ca =~ /:$/ || $cc =~ /^:/)) {
5035 $ok = 1;
5036 }
5037
Joe Perches84731622013-11-12 15:10:05 -08005038 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005039 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07005040 my $msg_level = \&ERROR;
5041 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08005042
Jean Delvare0675a8f2017-09-08 16:16:07 -07005043 if (&{$msg_level}("SPACING",
5044 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005045 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5046 if (defined $fix_elements[$n + 2]) {
5047 $fix_elements[$n + 2] =~ s/^\s+//;
5048 }
Joe Perches3705ce52013-07-03 15:05:31 -07005049 $line_fixed = 1;
5050 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005051 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005052 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005053 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005054
5055## print("n: <$n> GOOD: <$good>\n");
5056
5057 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005058 }
Joe Perches3705ce52013-07-03 15:05:31 -07005059
5060 if (($#elements % 2) == 0) {
5061 $fixed_line = $fixed_line . $fix_elements[$#elements];
5062 }
5063
Joe Perches194f66f2014-08-06 16:11:03 -07005064 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
5065 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07005066 }
5067
5068
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005069 }
5070
Joe Perches786b6322013-07-03 15:05:32 -07005071# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08005072 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07005073 if (WARN("SPACING",
5074 "space prohibited before semicolon\n" . $herecurr) &&
5075 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005076 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07005077 s/^(\+.*\S)\s+;/$1;/;
5078 }
5079 }
5080
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005081# check for multiple assignments
5082 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005083 CHK("MULTIPLE_ASSIGNMENTS",
5084 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005085 }
5086
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005087## # check for multiple declarations, allowing for a function declaration
5088## # continuation.
5089## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5090## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5091##
5092## # Remove any bracketed sections to ensure we do not
Dwaipayan Raye73d2712020-12-15 20:44:56 -08005093## # falsely report the parameters of functions.
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005094## my $ln = $line;
5095## while ($ln =~ s/\([^\(\)]*\)//g) {
5096## }
5097## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005098## WARN("MULTIPLE_DECLARATION",
5099## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005100## }
5101## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005102
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005103#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07005104 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005105 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005106 if (ERROR("SPACING",
5107 "space required before the open brace '{'\n" . $herecurr) &&
5108 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005109 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07005110 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005111 }
5112
Joe Perchesc4a62ef2013-07-03 15:05:28 -07005113## # check for blank lines before declarations
5114## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5115## $prevrawline =~ /^.\s*$/) {
5116## WARN("SPACING",
5117## "No blank lines before declarations\n" . $hereprev);
5118## }
5119##
5120
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005121# closing brace should have a space following it when it has anything
5122# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07005123 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005124 if (ERROR("SPACING",
5125 "space required after that close brace '}'\n" . $herecurr) &&
5126 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005127 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07005128 s/}((?!(?:,|;|\)))\S)/} $1/;
5129 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005130 }
5131
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005132# check spacing on square brackets
5133 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005134 if (ERROR("SPACING",
5135 "space prohibited after that open square bracket '['\n" . $herecurr) &&
5136 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005137 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005138 s/\[\s+/\[/;
5139 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005140 }
5141 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005142 if (ERROR("SPACING",
5143 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
5144 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005145 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005146 s/\s+\]/\]/;
5147 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005148 }
5149
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005150# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005151 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
5152 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005153 if (ERROR("SPACING",
5154 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
5155 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005156 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005157 s/\(\s+/\(/;
5158 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005159 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005160 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005161 $line !~ /for\s*\(.*;\s+\)/ &&
5162 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005163 if (ERROR("SPACING",
5164 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
5165 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005166 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005167 s/\s+\)/\)/;
5168 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005169 }
5170
Joe Perchese2826fd2014-08-06 16:10:48 -07005171# check unnecessary parentheses around addressof/dereference single $Lvals
5172# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5173
5174 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08005175 my $var = $1;
5176 if (CHK("UNNECESSARY_PARENTHESES",
5177 "Unnecessary parentheses around $var\n" . $herecurr) &&
5178 $fix) {
5179 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
5180 }
5181 }
5182
5183# check for unnecessary parentheses around function pointer uses
5184# ie: (foo->bar)(); should be foo->bar();
5185# but not "if (foo->bar) (" to avoid some false positives
5186 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
5187 my $var = $2;
5188 if (CHK("UNNECESSARY_PARENTHESES",
5189 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
5190 $fix) {
5191 my $var2 = deparenthesize($var);
5192 $var2 =~ s/\s//g;
5193 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
5194 }
5195 }
Joe Perchese2826fd2014-08-06 16:10:48 -07005196
Joe Perches63b7c732017-09-08 16:16:01 -07005197# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08005198# when !drivers/staging or command-line uses --strict
5199 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07005200 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07005201 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
5202 my $if_stat = $1;
5203 my $test = substr($2, 1, -1);
5204 my $herectx;
5205 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5206 my $match = $1;
5207 # avoid parentheses around potential macro args
5208 next if ($match =~ /^\s*\w+\s*$/);
5209 if (!defined($herectx)) {
5210 $herectx = $here . "\n";
5211 my $cnt = statement_rawlines($if_stat);
5212 for (my $n = 0; $n < $cnt; $n++) {
5213 my $rl = raw_line($linenr, $n);
5214 $herectx .= $rl . "\n";
5215 last if $rl =~ /^[ \+].*\{/;
5216 }
5217 }
5218 CHK("UNNECESSARY_PARENTHESES",
5219 "Unnecessary parentheses around '$match'\n" . $herectx);
5220 }
5221 }
5222
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005223#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005224 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005225 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005226 if (WARN("INDENTED_LABEL",
5227 "labels should not be indented\n" . $herecurr) &&
5228 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005229 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005230 s/^(.)\s+/$1/;
5231 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005232 }
5233
Joe Perches40873ab2020-10-15 20:11:56 -07005234# check if a statement with a comma should be two statements like:
5235# foo = bar(), /* comma should be semicolon */
5236# bar = baz();
5237 if (defined($stat) &&
5238 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5239 my $cnt = statement_rawlines($stat);
5240 my $herectx = get_stat_here($linenr, $cnt, $here);
5241 WARN("SUSPECT_COMMA_SEMICOLON",
5242 "Possible comma where semicolon could be used\n" . $herectx);
5243 }
5244
Joe Perches5b9553a2014-04-03 14:49:21 -07005245# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08005246 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005247 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07005248 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07005249 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
5250 my $value = $1;
5251 $value = deparenthesize($value);
5252 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
5253 ERROR("RETURN_PARENTHESES",
5254 "return is not a function, parentheses are not required\n" . $herecurr);
5255 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005256 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005257 ERROR("SPACING",
5258 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005259 }
5260 }
Joe Perches507e5142013-11-12 15:10:13 -08005261
Joe Perchesb43ae212014-06-23 13:22:07 -07005262# unnecessary return in a void function
5263# at end-of-function, with the previous line a single leading tab, then return;
5264# and the line before that not a goto label target like "out:"
5265 if ($sline =~ /^[ \+]}\s*$/ &&
5266 $prevline =~ /^\+\treturn\s*;\s*$/ &&
5267 $linenr >= 3 &&
5268 $lines[$linenr - 3] =~ /^[ +]/ &&
5269 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07005270 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07005271 "void function return statements are not generally useful\n" . $hereprev);
5272 }
Joe Perches9819cf22014-06-04 16:12:09 -07005273
Joe Perches189248d2014-01-23 15:54:47 -08005274# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07005275 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08005276 $line =~ /\bif\s*((?:\(\s*){2,})/) {
5277 my $openparens = $1;
5278 my $count = $openparens =~ tr@\(@\(@;
5279 my $msg = "";
5280 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5281 my $comp = $4; #Not $1 because of $LvalOrFunc
5282 $msg = " - maybe == should be = ?" if ($comp eq "==");
5283 WARN("UNNECESSARY_PARENTHESES",
5284 "Unnecessary parentheses$msg\n" . $herecurr);
5285 }
5286 }
5287
Joe Perchesc5595fa2015-09-09 15:37:58 -07005288# comparisons with a constant or upper case identifier on the left
5289# avoid cases like "foo + BAR < baz"
5290# only fix matches surrounded by parentheses to avoid incorrect
5291# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07005292 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005293 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5294 my $lead = $1;
5295 my $const = $2;
5296 my $comp = $3;
5297 my $to = $4;
5298 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07005299 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005300 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5301 WARN("CONSTANT_COMPARISON",
5302 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5303 $fix) {
5304 if ($comp eq "<") {
5305 $newcomp = ">";
5306 } elsif ($comp eq "<=") {
5307 $newcomp = ">=";
5308 } elsif ($comp eq ">") {
5309 $newcomp = "<";
5310 } elsif ($comp eq ">=") {
5311 $newcomp = "<=";
5312 }
5313 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5314 }
5315 }
5316
Joe Perchesf34e4a42015-04-16 12:44:19 -07005317# Return of what appears to be an errno should normally be negative
5318 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005319 my $name = $1;
5320 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07005321 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07005322 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005323 }
5324 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005325
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005326# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07005327 if ($line =~ /\b(if|while|for|switch)\(/) {
5328 if (ERROR("SPACING",
5329 "space required before the open parenthesis '('\n" . $herecurr) &&
5330 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005331 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005332 s/\b(if|while|for|switch)\(/$1 \(/;
5333 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005334 }
5335
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07005336# Check for illegal assignment in if conditional -- and check for trailing
5337# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005338 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08005339 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5340 ctx_statement_block($linenr, $realcnt, 0)
5341 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005342 my ($stat_next) = ctx_statement_block($line_nr_next,
5343 $remain_next, $off_next);
5344 $stat_next =~ s/\n./\n /g;
5345 ##print "stat<$stat> stat_next<$stat_next>\n";
5346
5347 if ($stat_next =~ /^\s*while\b/) {
5348 # If the statement carries leading newlines,
5349 # then count those as offsets.
5350 my ($whitespace) =
5351 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5352 my $offset =
5353 statement_rawlines($whitespace) - 1;
5354
5355 $suppress_whiletrailers{$line_nr_next +
5356 $offset} = 1;
5357 }
5358 }
5359 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08005360 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005361 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005362 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005363
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08005364 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches65b64b32020-08-11 18:35:10 -07005365 if (ERROR("ASSIGN_IN_IF",
5366 "do not use assignment in if condition\n" . $herecurr) &&
5367 $fix && $perl_version_ok) {
5368 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5369 my $space = $1;
5370 my $not = $2;
5371 my $statement = $3;
5372 my $assigned = $4;
5373 my $test = $8;
5374 my $against = $9;
5375 my $brace = $15;
5376 fix_delete_line($fixlinenr, $rawline);
5377 fix_insert_line($fixlinenr, "$space$statement;");
5378 my $newline = "${space}if (";
5379 $newline .= '!' if defined($not);
5380 $newline .= '(' if (defined $not && defined($test) && defined($against));
5381 $newline .= "$assigned";
5382 $newline .= " $test $against" if (defined($test) && defined($against));
5383 $newline .= ')' if (defined $not && defined($test) && defined($against));
5384 $newline .= ')';
5385 $newline .= " {" if (defined($brace));
5386 fix_insert_line($fixlinenr + 1, $newline);
5387 }
5388 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005389 }
5390
5391 # Find out what is on the end of the line after the
5392 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005393 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08005394 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005395 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07005396 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5397 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005398 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005399 # Find out how long the conditional actually is.
5400 my @newlines = ($c =~ /\n/gs);
5401 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005402 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005403
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005404 $stat_real = raw_line($linenr, $cond_lines)
5405 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005406 if (defined($stat_real) && $cond_lines > 1) {
5407 $stat_real = "[...]\n$stat_real";
5408 }
5409
Joe Perches000d1cc12011-07-25 17:13:25 -07005410 ERROR("TRAILING_STATEMENTS",
5411 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005412 }
5413 }
5414
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005415# Check for bitwise tests written as boolean
5416 if ($line =~ /
5417 (?:
5418 (?:\[|\(|\&\&|\|\|)
5419 \s*0[xX][0-9]+\s*
5420 (?:\&\&|\|\|)
5421 |
5422 (?:\&\&|\|\|)
5423 \s*0[xX][0-9]+\s*
5424 (?:\&\&|\|\||\)|\])
5425 )/x)
5426 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005427 WARN("HEXADECIMAL_BOOLEAN_TEST",
5428 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005429 }
5430
Andy Whitcroft8905a672007-11-28 16:21:06 -08005431# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005432 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5433 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005434 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005435 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005436 ERROR("TRAILING_STATEMENTS",
5437 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005438 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005439 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005440# if should not continue a brace
5441 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005442 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005443 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005444 $herecurr);
5445 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005446# case and default should not have general statements after them
5447 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5448 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005449 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005450 \s*return\s+
5451 )/xg)
5452 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005453 ERROR("TRAILING_STATEMENTS",
5454 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005455 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005456
5457 # Check for }<nl>else {, these must be at the same
5458 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005459 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5460 $previndent == $indent) {
5461 if (ERROR("ELSE_AFTER_BRACE",
5462 "else should follow close brace '}'\n" . $hereprev) &&
5463 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5464 fix_delete_line($fixlinenr - 1, $prevrawline);
5465 fix_delete_line($fixlinenr, $rawline);
5466 my $fixedline = $prevrawline;
5467 $fixedline =~ s/}\s*$//;
5468 if ($fixedline !~ /^\+\s*$/) {
5469 fix_insert_line($fixlinenr, $fixedline);
5470 }
5471 $fixedline = $rawline;
5472 $fixedline =~ s/^(.\s*)else/$1} else/;
5473 fix_insert_line($fixlinenr, $fixedline);
5474 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005475 }
5476
Joe Perches8b8856f2014-08-06 16:11:14 -07005477 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5478 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005479 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5480
5481 # Find out what is on the end of the line after the
5482 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005483 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005484 $s =~ s/\n.*//g;
5485
5486 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005487 if (ERROR("WHILE_AFTER_BRACE",
5488 "while should follow close brace '}'\n" . $hereprev) &&
5489 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5490 fix_delete_line($fixlinenr - 1, $prevrawline);
5491 fix_delete_line($fixlinenr, $rawline);
5492 my $fixedline = $prevrawline;
5493 my $trailing = $rawline;
5494 $trailing =~ s/^\+//;
5495 $trailing = trim($trailing);
5496 $fixedline =~ s/}\s*$/} $trailing/;
5497 fix_insert_line($fixlinenr, $fixedline);
5498 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005499 }
5500 }
5501
Joe Perches95e2c602013-07-03 15:05:20 -07005502#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005503 while ($line =~ m{($Constant|$Lval)}g) {
5504 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005505
Joe Perches95e2c602013-07-03 15:05:20 -07005506#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005507 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005508 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Łukasz Stelmach4104a202020-12-15 20:44:27 -08005509#Ignore some autogenerated defines and enum values
5510 $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005511#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005512 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005513#Ignore SI style variants like nS, mV and dB
5514#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5515 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005516#Ignore some three character SI units explicitly, like MiB and KHz
5517 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005518 while ($var =~ m{($Ident)}g) {
5519 my $word = $1;
5520 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005521 if ($check) {
5522 seed_camelcase_includes();
5523 if (!$file && !$camelcase_file_seeded) {
5524 seed_camelcase_file($realfile);
5525 $camelcase_file_seeded = 1;
5526 }
5527 }
Joe Perches7e781f62013-09-11 14:23:55 -07005528 if (!defined $camelcase{$word}) {
5529 $camelcase{$word} = 1;
5530 CHK("CAMELCASE",
5531 "Avoid CamelCase: <$word>\n" . $herecurr);
5532 }
Joe Perches34456862013-07-03 15:05:34 -07005533 }
Joe Perches323c1262012-12-17 16:02:07 -08005534 }
5535 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005536
5537#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005538 if ($line =~ /\#\s*define.*\\\s+$/) {
5539 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5540 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5541 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005542 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005543 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005544 }
5545
Fabian Frederick0e212e02015-04-16 12:44:25 -07005546# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5547# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005548 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005549 my $file = "$1.h";
5550 my $checkfile = "include/linux/$file";
5551 if (-f "$root/$checkfile" &&
5552 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005553 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005554 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005555 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5556 if ($asminclude > 0) {
5557 if ($realfile =~ m{^arch/}) {
5558 CHK("ARCH_INCLUDE_LINUX",
5559 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5560 } else {
5561 WARN("INCLUDE_LINUX",
5562 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5563 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005564 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005565 }
5566 }
5567
Andy Whitcroft653d4872007-06-23 17:16:34 -07005568# multi-statement macros should be enclosed in a do while loop, grab the
5569# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005570# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005571 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5572 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005573 my $ln = $linenr;
5574 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005575 my ($off, $dstat, $dcond, $rest);
5576 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005577 my $has_flow_statement = 0;
5578 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005579 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005580 ctx_statement_block($linenr, $realcnt, 0);
5581 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005582 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005583 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005584
Joe Perches08a28432014-10-13 15:51:55 -07005585 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005586 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005587
Joe Perchesf59b64b2016-10-11 13:52:08 -07005588 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5589 my $define_args = $1;
5590 my $define_stmt = $dstat;
5591 my @def_args = ();
5592
5593 if (defined $define_args && $define_args ne "") {
5594 $define_args = substr($define_args, 1, length($define_args) - 2);
5595 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005596 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005597 @def_args = split(",", $define_args);
5598 }
5599
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005600 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005601 $dstat =~ s/\\\n.//g;
5602 $dstat =~ s/^\s*//s;
5603 $dstat =~ s/\s*$//s;
5604
5605 # Flatten any parentheses and braces
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005606 while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
5607 $dstat =~ s/\{[^\{\}]*\}/1u/ ||
5608 $dstat =~ s/.\[[^\[\]]*\]/1u/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005609 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005610 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005611
Antonio Borneo342d3d22020-04-06 20:11:01 -07005612 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005613 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5614 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005615 {
5616 }
5617
Joe Perches42e15292016-03-15 14:58:01 -07005618 # Make asm volatile uses seem like a generic function
5619 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5620
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005621 my $exceptions = qr{
5622 $Declare|
5623 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005624 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005625 DECLARE_PER_CPU|
5626 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005627 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005628 union|
5629 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005630 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005631 ^\"|\"$|
5632 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005633 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005634 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005635
5636 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005637 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005638 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005639
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005640 if ($dstat ne '' &&
5641 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5642 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005643 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005644 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005645 $dstat !~ /$exceptions/ &&
5646 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005647 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005648 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005649 $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...}
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005650 $dstat !~ /^for\s*$Constant$/ && # for (...)
5651 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5652 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005653 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005654 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005655 {
Joe Perchese7955562017-05-08 15:55:48 -07005656 if ($dstat =~ /^\s*if\b/) {
5657 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5658 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5659 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005660 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5661 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5662 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005663 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005664 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005665 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005666
5667 }
Joe Perches52076492016-10-11 13:52:14 -07005668
5669 # Make $define_stmt single line, comment-free, etc
5670 my @stmt_array = split('\n', $define_stmt);
5671 my $first = 1;
5672 $define_stmt = "";
5673 foreach my $l (@stmt_array) {
5674 $l =~ s/\\$//;
5675 if ($first) {
5676 $define_stmt = $l;
5677 $first = 0;
5678 } elsif ($l =~ /^[\+ ]/) {
5679 $define_stmt .= substr($l, 1);
5680 }
5681 }
5682 $define_stmt =~ s/$;//g;
5683 $define_stmt =~ s/\s+/ /g;
5684 $define_stmt = trim($define_stmt);
5685
Joe Perchesf59b64b2016-10-11 13:52:08 -07005686# check if any macro arguments are reused (ignore '...' and 'type')
5687 foreach my $arg (@def_args) {
5688 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005689 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005690 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005691 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
Joe Perches7fe528a22017-07-10 15:52:27 -07005692 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5693 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005694 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005695 if ($use_cnt > 1) {
5696 CHK("MACRO_ARG_REUSE",
5697 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005698 }
5699# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005700 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005701 ((defined($1) && $1 ne ',') ||
5702 (defined($2) && $2 ne ','))) {
5703 CHK("MACRO_ARG_PRECEDENCE",
5704 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005705 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005706 }
Joe Perches5023d342012-12-17 16:01:47 -08005707
Joe Perches08a28432014-10-13 15:51:55 -07005708# check for macros with flow control, but without ## concatenation
5709# ## concatenation is commonly a macro that defines a function so ignore those
5710 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005711 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005712 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005713
Joe Perches08a28432014-10-13 15:51:55 -07005714 WARN("MACRO_WITH_FLOW_CONTROL",
5715 "Macros with flow control statements should be avoided\n" . "$herectx");
5716 }
5717
Joe Perches481eb482012-12-17 16:01:56 -08005718# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005719
5720 } else {
5721 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005722 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5723 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005724 $line =~ /^\+.*\\$/) {
5725 WARN("LINE_CONTINUATIONS",
5726 "Avoid unnecessary line continuations\n" . $herecurr);
5727 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005728 }
5729
Joe Perchesb13edf72012-07-30 14:41:24 -07005730# do {} while (0) macro tests:
5731# single-statement macros do not need to be enclosed in do while (0) loop,
5732# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005733 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005734 $realfile !~ m@/vmlinux.lds.h$@ &&
5735 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5736 my $ln = $linenr;
5737 my $cnt = $realcnt;
5738 my ($off, $dstat, $dcond, $rest);
5739 my $ctx = '';
5740 ($dstat, $dcond, $ln, $cnt, $off) =
5741 ctx_statement_block($linenr, $realcnt, 0);
5742 $ctx = $dstat;
5743
5744 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005745 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005746
5747 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5748 my $stmts = $2;
5749 my $semis = $3;
5750
5751 $ctx =~ s/\n*$//;
5752 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005753 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005754
Joe Perchesac8e97f2012-08-21 16:15:53 -07005755 if (($stmts =~ tr/;/;/) == 1 &&
5756 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005757 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5758 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5759 }
5760 if (defined $semis && $semis ne "") {
5761 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5762 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5763 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005764 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5765 $ctx =~ s/\n*$//;
5766 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005767 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005768
5769 WARN("TRAILING_SEMICOLON",
5770 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005771 }
5772 }
5773
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005774# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005775 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5776 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005777 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005778 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005779 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5780 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005781 my @allowed = ();
5782 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005783 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005784 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005785 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005786 for my $chunk (@chunks) {
5787 my ($cond, $block) = @{$chunk};
5788
Andy Whitcroft773647a2008-03-28 14:15:58 -07005789 # If the condition carries leading newlines, then count those as offsets.
5790 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5791 my $offset = statement_rawlines($whitespace) - 1;
5792
Joe Perchesaad4f612012-03-23 15:02:19 -07005793 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005794 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5795
5796 # We have looked at and allowed this specific line.
5797 $suppress_ifbraces{$ln + $offset} = 1;
5798
5799 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005800 $ln += statement_rawlines($block) - 1;
5801
Andy Whitcroft773647a2008-03-28 14:15:58 -07005802 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005803
5804 $seen++ if ($block =~ /^\s*{/);
5805
Joe Perchesaad4f612012-03-23 15:02:19 -07005806 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005807 if (statement_lines($cond) > 1) {
5808 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005809 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005810 }
5811 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005812 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005813 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005814 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005815 if (statement_block_size($block) > 1) {
5816 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005817 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005818 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005819 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005820 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005821 if ($seen) {
5822 my $sum_allowed = 0;
5823 foreach (@allowed) {
5824 $sum_allowed += $_;
5825 }
5826 if ($sum_allowed == 0) {
5827 WARN("BRACES",
5828 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5829 } elsif ($sum_allowed != $allow &&
5830 $seen != $allow) {
5831 CHK("BRACES",
5832 "braces {} should be used on all arms of this statement\n" . $herectx);
5833 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005834 }
5835 }
5836 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005837 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005838 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005839 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005840
Andy Whitcroftcf655042008-03-04 14:28:20 -08005841 # Check the pre-context.
5842 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5843 #print "APW: ALLOWED: pre<$1>\n";
5844 $allowed = 1;
5845 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005846
5847 my ($level, $endln, @chunks) =
5848 ctx_statement_full($linenr, $realcnt, $-[0]);
5849
Andy Whitcroftcf655042008-03-04 14:28:20 -08005850 # Check the condition.
5851 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005852 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005853 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005854 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005855 }
5856 if (statement_lines($cond) > 1) {
5857 #print "APW: ALLOWED: cond<$cond>\n";
5858 $allowed = 1;
5859 }
5860 if ($block =~/\b(?:if|for|while)\b/) {
5861 #print "APW: ALLOWED: block<$block>\n";
5862 $allowed = 1;
5863 }
5864 if (statement_block_size($block) > 1) {
5865 #print "APW: ALLOWED: lines block<$block>\n";
5866 $allowed = 1;
5867 }
5868 # Check the post-context.
5869 if (defined $chunks[1]) {
5870 my ($cond, $block) = @{$chunks[1]};
5871 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005872 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005873 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005874 if ($block =~ /^\s*\{/) {
5875 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5876 $allowed = 1;
5877 }
5878 }
5879 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005880 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005881 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005882
Joe Perches000d1cc12011-07-25 17:13:25 -07005883 WARN("BRACES",
5884 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005885 }
5886 }
5887
Joe Perchese4c5bab2017-02-24 15:01:41 -08005888# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005889 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5890 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005891 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5892 }
5893
Joe Perches0979ae62012-12-17 16:01:59 -08005894# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005895 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005896 if (CHK("BRACES",
5897 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5898 $fix && $prevrawline =~ /^\+/) {
5899 fix_delete_line($fixlinenr - 1, $prevrawline);
5900 }
Joe Perches0979ae62012-12-17 16:01:59 -08005901 }
Joe Perches77b9a532013-07-03 15:05:29 -07005902 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005903 if (CHK("BRACES",
5904 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5905 $fix) {
5906 fix_delete_line($fixlinenr, $rawline);
5907 }
Joe Perches0979ae62012-12-17 16:01:59 -08005908 }
5909
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005910# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005911 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5912 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005913 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005914 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005915 }
5916
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005917# Check for user-visible strings broken across lines, which breaks the ability
5918# to grep for the string. Make exceptions when the previous string ends in a
5919# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5920# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005921 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005922 $prevline =~ /"\s*$/ &&
5923 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5924 if (WARN("SPLIT_STRING",
5925 "quoted string split across lines\n" . $hereprev) &&
5926 $fix &&
5927 $prevrawline =~ /^\+.*"\s*$/ &&
5928 $last_coalesced_string_linenr != $linenr - 1) {
5929 my $extracted_string = get_quoted_string($line, $rawline);
5930 my $comma_close = "";
5931 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5932 $comma_close = $1;
5933 }
5934
5935 fix_delete_line($fixlinenr - 1, $prevrawline);
5936 fix_delete_line($fixlinenr, $rawline);
5937 my $fixedline = $prevrawline;
5938 $fixedline =~ s/"\s*$//;
5939 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5940 fix_insert_line($fixlinenr - 1, $fixedline);
5941 $fixedline = $rawline;
5942 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5943 if ($fixedline !~ /\+\s*$/) {
5944 fix_insert_line($fixlinenr, $fixedline);
5945 }
5946 $last_coalesced_string_linenr = $linenr;
5947 }
5948 }
5949
5950# check for missing a space in a string concatenation
5951 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5952 WARN('MISSING_SPACE',
5953 "break quoted strings at a space character\n" . $hereprev);
5954 }
5955
Joe Perchese4b7d302017-05-08 15:55:51 -07005956# check for an embedded function name in a string when the function is known
5957# This does not work very well for -f --file checking as it depends on patch
5958# context providing the function name or a single line form for in-file
5959# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005960 if ($line =~ /^\+.*$String/ &&
5961 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005962 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5963 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005964 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005965 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005966 }
5967
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005968# check for spaces before a quoted newline
5969 if ($rawline =~ /^.*\".*\s\\n/) {
5970 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5971 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5972 $fix) {
5973 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5974 }
5975
5976 }
5977
Joe Perchesf17dba42014-10-13 15:51:51 -07005978# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005979 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5980 if (CHK("CONCATENATED_STRING",
5981 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5982 $fix) {
5983 while ($line =~ /($String)/g) {
5984 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5985 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5986 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5987 }
5988 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005989 }
5990
Joe Perches90ad30e2014-12-10 15:51:59 -08005991# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005992 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005993 if (WARN("STRING_FRAGMENTS",
5994 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5995 $fix) {
5996 while ($line =~ /($String)(?=\s*")/g) {
5997 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5998 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5999 }
6000 }
Joe Perches90ad30e2014-12-10 15:51:59 -08006001 }
6002
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006003# check for non-standard and hex prefixed decimal printf formats
6004 my $show_L = 1; #don't show the same defect twice
6005 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006006 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006007 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006008 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006009 # check for %L
6010 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006011 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006012 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
6013 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006014 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006015 # check for %Z
6016 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
6017 WARN("PRINTF_Z",
6018 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
6019 $show_Z = 0;
6020 }
6021 # check for 0x<decimal>
6022 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
6023 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07006024 "Prefixing 0x with decimal output is defective\n" . $herecurr);
6025 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006026 }
6027
6028# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08006029 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006030 WARN("LINE_CONTINUATIONS",
6031 "Avoid line continuations in quoted strings\n" . $herecurr);
6032 }
6033
Andy Whitcroft00df3442007-06-08 13:47:06 -07006034# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006035 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07006036 WARN("IF_0",
6037 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
6038 }
6039
6040# warn about #if 1
6041 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
6042 WARN("IF_1",
6043 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006044 }
6045
Andy Whitcroft03df4b52012-12-17 16:01:52 -08006046# check for needless "if (<foo>) fn(<foo>)" uses
6047 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07006048 my $tested = quotemeta($1);
6049 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
6050 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6051 my $func = $1;
6052 if (WARN('NEEDLESS_IF',
6053 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
6054 $fix) {
6055 my $do_fix = 1;
6056 my $leading_tabs = "";
6057 my $new_leading_tabs = "";
6058 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
6059 $leading_tabs = $1;
6060 } else {
6061 $do_fix = 0;
6062 }
6063 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
6064 $new_leading_tabs = $1;
6065 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
6066 $do_fix = 0;
6067 }
6068 } else {
6069 $do_fix = 0;
6070 }
6071 if ($do_fix) {
6072 fix_delete_line($fixlinenr - 1, $prevrawline);
6073 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
6074 }
6075 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07006076 }
6077 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006078
Joe Perchesebfdc402014-08-06 16:10:27 -07006079# check for unnecessary "Out of Memory" messages
6080 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
6081 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
6082 (defined $1 || defined $3) &&
6083 $linenr > 3) {
6084 my $testval = $2;
6085 my $testline = $lines[$linenr - 3];
6086
6087 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
6088# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6089
Joe Perchese29a70f2019-03-07 16:28:35 -08006090 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6091 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07006092 WARN("OOM_MESSAGE",
6093 "Possible unnecessary 'out of memory' message\n" . $hereprev);
6094 }
6095 }
6096
Joe Perchesf78d98f2014-10-13 15:52:01 -07006097# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08006098 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07006099 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
6100 my $level = $1;
6101 if (WARN("UNNECESSARY_KERN_LEVEL",
6102 "Possible unnecessary $level\n" . $herecurr) &&
6103 $fix) {
6104 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
6105 }
6106 }
6107
Joe Perches45c55e92017-02-24 15:01:31 -08006108# check for logging continuations
6109 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
6110 WARN("LOGGING_CONTINUATION",
6111 "Avoid logging continuation uses where feasible\n" . $herecurr);
6112 }
6113
Dwaipayan Ray70eb2272020-12-15 20:45:15 -08006114# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6115 if (defined $stat &&
6116 $line =~ /\b$logFunctions\s*\(/ &&
6117 index($stat, '"') >= 0) {
6118 my $lc = $stat =~ tr@\n@@;
6119 $lc = $lc + $linenr;
6120 my $stat_real = get_stat_real($linenr, $lc);
6121 pos($stat_real) = index($stat_real, '"');
6122 while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) {
6123 my $pspec = $1;
6124 my $h = $2;
6125 my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@;
6126 if (WARN("UNNECESSARY_MODIFIER",
6127 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") &&
6128 $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) {
6129 my $nspec = $pspec;
6130 $nspec =~ s/h//g;
6131 $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/;
6132 }
6133 }
6134 }
6135
Joe Perchesabb08a52014-12-10 15:51:46 -08006136# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07006137 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08006138 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
6139 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
6140 WARN("MASK_THEN_SHIFT",
6141 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
6142 }
6143
Joe Perchesb75ac612014-12-10 15:52:02 -08006144# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07006145 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08006146 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
6147 my $val = $1;
6148 my $equal = "!";
6149 $equal = "" if ($4 eq "!=");
6150 if (CHK("COMPARISON_TO_NULL",
6151 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
6152 $fix) {
6153 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
6154 }
6155 }
6156 }
6157
Joe Perches8716de32013-09-11 14:24:05 -07006158# check for bad placement of section $InitAttribute (e.g.: __initdata)
6159 if ($line =~ /(\b$InitAttribute\b)/) {
6160 my $attr = $1;
6161 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6162 my $ptr = $1;
6163 my $var = $2;
6164 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
6165 ERROR("MISPLACED_INIT",
6166 "$attr should be placed after $var\n" . $herecurr)) ||
6167 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
6168 WARN("MISPLACED_INIT",
6169 "$attr should be placed after $var\n" . $herecurr))) &&
6170 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006171 $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 -07006172 }
6173 }
6174 }
6175
Joe Perchese970b8842013-11-12 15:10:10 -08006176# check for $InitAttributeData (ie: __initdata) with const
6177 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
6178 my $attr = $1;
6179 $attr =~ /($InitAttributePrefix)(.*)/;
6180 my $attr_prefix = $1;
6181 my $attr_type = $2;
6182 if (ERROR("INIT_ATTRIBUTE",
6183 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
6184 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006185 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006186 s/$InitAttributeData/${attr_prefix}initconst/;
6187 }
6188 }
6189
6190# check for $InitAttributeConst (ie: __initconst) without const
6191 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
6192 my $attr = $1;
6193 if (ERROR("INIT_ATTRIBUTE",
6194 "Use of $attr requires a separate use of const\n" . $herecurr) &&
6195 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006196 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006197 /(^\+\s*(?:static\s+))/;
6198 $lead = rtrim($1);
6199 $lead = "$lead " if ($lead !~ /^\+$/);
6200 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07006201 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08006202 }
6203 }
6204
Joe Perchesc17893c2015-04-16 12:44:42 -07006205# check for __read_mostly with const non-pointer (should just be const)
6206 if ($line =~ /\b__read_mostly\b/ &&
6207 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
6208 if (ERROR("CONST_READ_MOSTLY",
6209 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
6210 $fix) {
6211 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
6212 }
6213 }
6214
Joe Perchesfbdb8132014-04-03 14:49:14 -07006215# don't use __constant_<foo> functions outside of include/uapi/
6216 if ($realfile !~ m@^include/uapi/@ &&
6217 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6218 my $constant_func = $1;
6219 my $func = $constant_func;
6220 $func =~ s/^__constant_//;
6221 if (WARN("CONSTANT_CONVERSION",
6222 "$constant_func should be $func\n" . $herecurr) &&
6223 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006224 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07006225 }
6226 }
6227
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006228# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08006229 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07006230 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006231 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07006232 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006233 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006234 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07006235 }
6236 if ($delay > 2000) {
6237 WARN("LONG_UDELAY",
6238 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006239 }
6240 }
6241
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006242# warn about unexpectedly long msleep's
6243 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
6244 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006245 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006246 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006247 }
6248 }
6249
Joe Perches36ec1932013-07-03 15:05:25 -07006250# check for comparisons of jiffies
6251 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
6252 WARN("JIFFIES_COMPARISON",
6253 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6254 }
6255
Joe Perches9d7a34a2013-07-03 15:05:26 -07006256# check for comparisons of get_jiffies_64()
6257 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
6258 WARN("JIFFIES_COMPARISON",
6259 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6260 }
6261
Andy Whitcroft00df3442007-06-08 13:47:06 -07006262# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006263# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07006264# print "#ifdef in C files should be avoided\n";
6265# print "$herecurr";
6266# $clean = 0;
6267# }
6268
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006269# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006270 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07006271 if (ERROR("SPACING",
6272 "exactly one space required after that #$1\n" . $herecurr) &&
6273 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006274 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07006275 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
6276 }
6277
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006278 }
6279
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006280# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006281 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
6282 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006283 my $which = $1;
6284 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006285 CHK("UNCOMMENTED_DEFINITION",
6286 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006287 }
6288 }
6289# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006290
6291 my $barriers = qr{
6292 mb|
6293 rmb|
Will Deaconad83ec62019-11-07 14:49:00 +00006294 wmb
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006295 }x;
6296 my $barrier_stems = qr{
6297 mb__before_atomic|
6298 mb__after_atomic|
6299 store_release|
6300 load_acquire|
6301 store_mb|
6302 (?:$barriers)
6303 }x;
6304 my $all_barriers = qr{
6305 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02006306 smp_(?:$barrier_stems)|
6307 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006308 }x;
6309
6310 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006311 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08006312 WARN("MEMORY_BARRIER",
6313 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006314 }
6315 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006316
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02006317 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6318
6319 if ($realfile !~ m@^include/asm-generic/@ &&
6320 $realfile !~ m@/barrier\.h$@ &&
6321 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6322 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6323 WARN("MEMORY_BARRIER",
6324 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6325 }
6326
Joe Perchescb426e92015-06-25 15:02:46 -07006327# check for waitqueue_active without a comment.
6328 if ($line =~ /\bwaitqueue_active\s*\(/) {
6329 if (!ctx_has_comment($first_line, $linenr)) {
6330 WARN("WAITQUEUE_ACTIVE",
6331 "waitqueue_active without comment\n" . $herecurr);
6332 }
6333 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006334
Marco Elver5099a722020-04-01 12:17:14 +02006335# check for data_race without a comment.
6336 if ($line =~ /\bdata_race\s*\(/) {
6337 if (!ctx_has_comment($first_line, $linenr)) {
6338 WARN("DATA_RACE",
6339 "data_race without comment\n" . $herecurr);
6340 }
6341 }
6342
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006343# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006344 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006345 CHK("ARCH_DEFINES",
6346 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006347 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006348
Joe Perches596ed452017-07-12 14:37:02 -07006349# check that the storage class is not after a type
6350 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006351 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07006352 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6353 }
6354# Check that the storage class is at the beginning of a declaration
6355 if ($line =~ /\b$Storage\b/ &&
6356 $line !~ /^.\s*$Storage/ &&
6357 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6358 $1 !~ /[\,\)]\s*$/) {
6359 WARN("STORAGE_CLASS",
6360 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07006361 }
6362
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006363# check the location of the inline attribute, that it is between
6364# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006365 if ($line =~ /\b$Type\s+$Inline\b/ ||
6366 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006367 ERROR("INLINE_LOCATION",
6368 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006369 }
6370
Andy Whitcroft8905a672007-11-28 16:21:06 -08006371# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08006372 if ($realfile !~ m@\binclude/uapi/@ &&
6373 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006374 if (WARN("INLINE",
6375 "plain inline is preferred over $1\n" . $herecurr) &&
6376 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006377 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006378
6379 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006380 }
6381
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006382# Check for compiler attributes
Joe Perches2b7ab452013-11-12 15:10:14 -08006383 if ($realfile !~ m@\binclude/uapi/@ &&
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006384 $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
6385 my $attr = $1;
6386 $attr =~ s/\s*\(\s*(.*)\)\s*/$1/;
Joe Perches3d130fd2011-01-12 17:00:00 -08006387
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006388 my %attr_list = (
Joe Perches0830aab2020-12-15 20:44:50 -08006389 "alias" => "__alias",
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006390 "aligned" => "__aligned",
6391 "always_inline" => "__always_inline",
6392 "assume_aligned" => "__assume_aligned",
6393 "cold" => "__cold",
6394 "const" => "__attribute_const__",
6395 "copy" => "__copy",
6396 "designated_init" => "__designated_init",
6397 "externally_visible" => "__visible",
6398 "format" => "printf|scanf",
6399 "gnu_inline" => "__gnu_inline",
6400 "malloc" => "__malloc",
6401 "mode" => "__mode",
6402 "no_caller_saved_registers" => "__no_caller_saved_registers",
6403 "noclone" => "__noclone",
6404 "noinline" => "noinline",
6405 "nonstring" => "__nonstring",
6406 "noreturn" => "__noreturn",
6407 "packed" => "__packed",
6408 "pure" => "__pure",
Joe Perches339f29d2020-12-15 20:44:43 -08006409 "section" => "__section",
Joe Perches0830aab2020-12-15 20:44:50 -08006410 "used" => "__used",
6411 "weak" => "__weak"
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006412 );
Joe Perches39b7e282011-07-25 17:13:24 -07006413
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006414 while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
Joe Perches339f29d2020-12-15 20:44:43 -08006415 my $orig_attr = $1;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006416 my $params = '';
6417 $params = $2 if defined($2);
Joe Perches339f29d2020-12-15 20:44:43 -08006418 my $curr_attr = $orig_attr;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006419 $curr_attr =~ s/^[\s_]+|[\s_]+$//g;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006420 if (exists($attr_list{$curr_attr})) {
Joe Perches339f29d2020-12-15 20:44:43 -08006421 my $new = $attr_list{$curr_attr};
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006422 if ($curr_attr eq "format" && $params) {
6423 $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
Joe Perches339f29d2020-12-15 20:44:43 -08006424 $new = "__$1\($2";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006425 } else {
Joe Perches339f29d2020-12-15 20:44:43 -08006426 $new = "$new$params";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006427 }
Joe Perches339f29d2020-12-15 20:44:43 -08006428 if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6429 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
6430 $fix) {
6431 my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
6432 $fixed[$fixlinenr] =~ s/$remove//;
6433 $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
6434 $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
6435 $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
6436 }
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006437 }
6438 }
6439
6440 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6441 if ($attr =~ /^_*unused/) {
6442 WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6443 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
Joe Perchesd5e616f2013-09-11 14:23:54 -07006444 }
Joe Perches6061d942012-03-23 15:02:16 -07006445 }
6446
Joe Perches619a9082014-12-10 15:51:35 -08006447# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07006448 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08006449 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6450 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6451 $line =~ /\b__weak\b/)) {
6452 ERROR("WEAK_DECLARATION",
6453 "Using weak declarations can have unintended link defects\n" . $herecurr);
6454 }
6455
Tomas Winklerfd39f902016-12-12 16:46:34 -08006456# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07006457 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08006458 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07006459 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6460 my $type = $1;
6461 if ($type =~ /\b($typeC99Typedefs)\b/) {
6462 $type = $1;
6463 my $kernel_type = 'u';
6464 $kernel_type = 's' if ($type =~ /^_*[si]/);
6465 $type =~ /(\d+)/;
6466 $kernel_type .= $1;
6467 if (CHK("PREFER_KERNEL_TYPES",
6468 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6469 $fix) {
6470 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6471 }
6472 }
6473 }
6474
Joe Perches938224b2016-01-20 14:59:15 -08006475# check for cast of C90 native int or longer types constants
6476 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6477 my $cast = $1;
6478 my $const = $2;
6479 if (WARN("TYPECAST_INT_CONSTANT",
6480 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6481 $fix) {
6482 my $suffix = "";
6483 my $newconst = $const;
6484 $newconst =~ s/${Int_type}$//;
6485 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6486 if ($cast =~ /\blong\s+long\b/) {
6487 $suffix .= 'LL';
6488 } elsif ($cast =~ /\blong\b/) {
6489 $suffix .= 'L';
6490 }
6491 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6492 }
6493 }
6494
Joe Perches8f53a9b2010-03-05 13:43:48 -08006495# check for sizeof(&)
6496 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006497 WARN("SIZEOF_ADDRESS",
6498 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006499 }
6500
Joe Perches66c80b62012-07-30 14:41:22 -07006501# check for sizeof without parenthesis
6502 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006503 if (WARN("SIZEOF_PARENTHESIS",
6504 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6505 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006506 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006507 }
Joe Perches66c80b62012-07-30 14:41:22 -07006508 }
6509
Joe Perches88982fe2012-12-17 16:02:00 -08006510# check for struct spinlock declarations
6511 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6512 WARN("USE_SPINLOCK_T",
6513 "struct spinlock should be spinlock_t\n" . $herecurr);
6514 }
6515
Joe Perchesa6962d72013-04-29 16:18:13 -07006516# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006517 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006518 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006519 $fmt =~ s/%%//g;
6520 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006521 if (WARN("PREFER_SEQ_PUTS",
6522 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6523 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006524 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006525 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006526 }
6527 }
6528
Joe Perches478b1792018-04-10 16:33:34 -07006529# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006530 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006531 defined $stat &&
6532 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6533 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006534 my $stat_real;
6535
Joe Perches0b523762017-05-08 15:55:36 -07006536 my $lc = $stat =~ tr@\n@@;
6537 $lc = $lc + $linenr;
6538 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006539 my $specifier;
6540 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006541 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006542 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006543 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6544 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006545
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006546 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006547 $specifier = $1;
6548 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006549 $qualifier = $3;
Linus Torvalds361b0d22019-11-26 19:45:12 -08006550 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006551 ($extension eq "f" &&
6552 defined $qualifier && $qualifier !~ /^w/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006553 $bad_specifier = $specifier;
6554 last;
6555 }
6556 if ($extension eq "x" && !defined($stat_real)) {
6557 if (!defined($stat_real)) {
6558 $stat_real = get_stat_real($linenr, $lc);
6559 }
6560 WARN("VSPRINTF_SPECIFIER_PX",
6561 "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");
6562 }
6563 }
6564 if ($bad_specifier ne "") {
6565 my $stat_real = get_stat_real($linenr, $lc);
6566 my $ext_type = "Invalid";
6567 my $use = "";
6568 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006569 $use = " - use %pS instead";
6570 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6571 }
6572
6573 WARN("VSPRINTF_POINTER_EXTENSION",
6574 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6575 }
Joe Perches0b523762017-05-08 15:55:36 -07006576 }
6577 }
6578
Andy Whitcroft554e1652012-01-10 15:09:57 -08006579# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006580 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006581 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006582 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006583
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006584 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006585 my $ms_val = $7;
6586 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006587
Andy Whitcroft554e1652012-01-10 15:09:57 -08006588 if ($ms_size =~ /^(0x|)0$/i) {
6589 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006590 "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 -08006591 } elsif ($ms_size =~ /^(0x|)1$/i) {
6592 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006593 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6594 }
6595 }
6596
Joe Perches98a9bba2014-01-23 15:54:52 -08006597# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006598# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006599# defined $stat &&
6600# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6601# if (WARN("PREFER_ETHER_ADDR_COPY",
6602# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6603# $fix) {
6604# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6605# }
6606# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006607
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006608# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006609# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006610# defined $stat &&
6611# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6612# WARN("PREFER_ETHER_ADDR_EQUAL",
6613# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6614# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006615
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006616# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6617# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006618# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006619# defined $stat &&
6620# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6621#
6622# my $ms_val = $7;
6623#
6624# if ($ms_val =~ /^(?:0x|)0+$/i) {
6625# if (WARN("PREFER_ETH_ZERO_ADDR",
6626# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6627# $fix) {
6628# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6629# }
6630# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6631# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6632# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6633# $fix) {
6634# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6635# }
6636# }
6637# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006638
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006639# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006640 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006641 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006642 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006643 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006644 my $call = $1;
6645 my $cast1 = deparenthesize($2);
6646 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006647 my $cast2 = deparenthesize($7);
6648 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006649 my $cast;
6650
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006651 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006652 $cast = "$cast1 or $cast2";
6653 } elsif ($cast1 ne "") {
6654 $cast = $cast1;
6655 } else {
6656 $cast = $cast2;
6657 }
6658 WARN("MINMAX",
6659 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006660 }
6661 }
6662
Joe Perches4a273192012-07-30 14:41:20 -07006663# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006664 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006665 defined $stat &&
6666 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6667 my $min = $1;
6668 my $max = $7;
6669 if ($min eq $max) {
6670 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006671 "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 -07006672 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6673 $min > $max) {
6674 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006675 "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 -07006676 }
6677 }
6678
Joe Perches823b7942013-11-12 15:10:15 -08006679# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006680 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006681 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006682 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006683 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6684 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6685 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6686 my $lc = $stat =~ tr@\n@@;
6687 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006688 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006689 WARN("NAKED_SSCANF",
6690 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6691 }
6692
Joe Perchesafc819a2014-06-04 16:12:08 -07006693# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006694 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006695 defined $stat &&
6696 $line =~ /\bsscanf\b/) {
6697 my $lc = $stat =~ tr@\n@@;
6698 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006699 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006700 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6701 my $format = $6;
6702 my $count = $format =~ tr@%@%@;
6703 if ($count == 1 &&
6704 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6705 WARN("SSCANF_TO_KSTRTO",
6706 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6707 }
6708 }
6709 }
6710
Joe Perches70dc8a42013-09-11 14:23:58 -07006711# check for new externs in .h files.
6712 if ($realfile =~ /\.h$/ &&
6713 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006714 if (CHK("AVOID_EXTERNS",
6715 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006716 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006717 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006718 }
6719 }
6720
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006721# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006722 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006723 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006724 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006725 my $function_name = $1;
6726 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006727
6728 my $s = $stat;
6729 if (defined $cond) {
6730 substr($s, 0, length($cond), '');
6731 }
Kees Cookd8b44b52020-06-03 14:18:09 -07006732 if ($s =~ /^\s*;/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006733 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006734 WARN("AVOID_EXTERNS",
6735 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006736 }
6737
6738 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006739 WARN("FUNCTION_ARGUMENTS",
6740 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006741 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006742
6743 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6744 $stat =~ /^.\s*extern\s+/)
6745 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006746 WARN("AVOID_EXTERNS",
6747 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006748 }
6749
Joe Perchesa0ad7592017-07-10 15:52:19 -07006750# check for function declarations that have arguments without identifier names
6751 if (defined $stat &&
Kees Cookd8b44b52020-06-03 14:18:09 -07006752 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6753 $1 ne "void") {
6754 my $args = trim($1);
Joe Perchesca0d8922016-10-11 13:52:16 -07006755 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6756 my $arg = trim($1);
Kees Cookd8b44b52020-06-03 14:18:09 -07006757 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07006758 WARN("FUNCTION_ARGUMENTS",
6759 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6760 }
6761 }
6762 }
6763
Joe Perchesa0ad7592017-07-10 15:52:19 -07006764# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006765 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006766 defined $stat &&
6767 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6768 $context_function = $1;
6769
6770# check for multiline function definition with misplaced open brace
6771 my $ok = 0;
6772 my $cnt = statement_rawlines($stat);
6773 my $herectx = $here . "\n";
6774 for (my $n = 0; $n < $cnt; $n++) {
6775 my $rl = raw_line($linenr, $n);
6776 $herectx .= $rl . "\n";
6777 $ok = 1 if ($rl =~ /^[ \+]\{/);
6778 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6779 last if $rl =~ /^[ \+].*\{/;
6780 }
6781 if (!$ok) {
6782 ERROR("OPEN_BRACE",
6783 "open brace '{' following function definitions go on the next line\n" . $herectx);
6784 }
6785 }
6786
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006787# checks for new __setup's
6788 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6789 my $name = $1;
6790
6791 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006792 CHK("UNDOCUMENTED_SETUP",
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07006793 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006794 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006795 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006796
Joe Perchese29a70f2019-03-07 16:28:35 -08006797# check for pointless casting of alloc functions
6798 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006799 WARN("UNNECESSARY_CASTS",
6800 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006801 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006802
Joe Perchesa640d252013-07-03 15:05:21 -07006803# alloc style
6804# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006805 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006806 $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 -07006807 CHK("ALLOC_SIZEOF_STRUCT",
6808 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6809 }
6810
Joe Perches60a55362014-06-04 16:12:07 -07006811# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006812 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006813 defined $stat &&
6814 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07006815 my $oldfunc = $3;
6816 my $a1 = $4;
6817 my $a2 = $10;
6818 my $newfunc = "kmalloc_array";
6819 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006820 my $r1 = $a1;
6821 my $r2 = $a2;
6822 if ($a1 =~ /^sizeof\s*\S/) {
6823 $r1 = $a2;
6824 $r2 = $a1;
6825 }
6826 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6827 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006828 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006829 my $herectx = get_stat_here($linenr, $cnt, $here);
6830
Joe Perches60a55362014-06-04 16:12:07 -07006831 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006832 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6833 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006834 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006835 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
Joe Perches60a55362014-06-04 16:12:07 -07006836 }
6837 }
6838 }
6839
Joe Perches972fdea2013-04-29 16:18:12 -07006840# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006841 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006842 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6843 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006844 WARN("KREALLOC_ARG_REUSE",
6845 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6846 }
6847
Joe Perches5ce59ae2013-02-21 16:44:18 -08006848# check for alloc argument mismatch
6849 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6850 WARN("ALLOC_ARRAY_ARGS",
6851 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6852 }
6853
Joe Perchescaf2a542011-01-12 16:59:56 -08006854# check for multiple semicolons
6855 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006856 if (WARN("ONE_SEMICOLON",
6857 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6858 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006859 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006860 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006861 }
6862
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006863# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6864 if ($realfile !~ m@^include/uapi/@ &&
6865 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006866 my $ull = "";
6867 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6868 if (CHK("BIT_MACRO",
6869 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6870 $fix) {
6871 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6872 }
6873 }
6874
Joe Perches50161262020-08-11 18:35:07 -07006875# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006876 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
Joe Perches50161262020-08-11 18:35:07 -07006877 WARN("IS_ENABLED_CONFIG",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006878 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
Joe Perches50161262020-08-11 18:35:07 -07006879 }
6880
Joe Perches2d632742016-05-20 17:04:00 -07006881# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006882 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 -07006883 my $config = $1;
6884 if (WARN("PREFER_IS_ENABLED",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006885 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
Joe Perches2d632742016-05-20 17:04:00 -07006886 $fix) {
6887 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6888 }
6889 }
6890
Joe Perchesf36d3eb2020-04-06 20:10:58 -07006891# check for /* fallthrough */ like comment, prefer fallthrough;
6892 my @fallthroughs = (
6893 'fallthrough',
6894 '@fallthrough@',
6895 'lint -fallthrough[ \t]*',
6896 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6897 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6898 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6899 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6900 );
6901 if ($raw_comment ne '') {
6902 foreach my $ft (@fallthroughs) {
6903 if ($raw_comment =~ /$ft/) {
6904 my $msg_level = \&WARN;
6905 $msg_level = \&CHK if ($file);
6906 &{$msg_level}("PREFER_FALLTHROUGH",
6907 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6908 last;
6909 }
6910 }
6911 }
6912
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006913# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006914 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006915 defined $stat &&
6916 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006917 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006918 my $herectx = get_stat_here($linenr, $cnt, $here);
6919
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006920 WARN("DEFAULT_NO_BREAK",
6921 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006922 }
6923
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006924# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006925 if ($line =~ /\b__FUNCTION__\b/) {
6926 if (WARN("USE_FUNC",
6927 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6928 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006929 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006930 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006931 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006932
Joe Perches62ec8182015-02-13 14:38:18 -08006933# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6934 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6935 ERROR("DATE_TIME",
6936 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6937 }
6938
Joe Perches2c924882012-03-23 15:02:20 -07006939# check for use of yield()
6940 if ($line =~ /\byield\s*\(\s*\)/) {
6941 WARN("YIELD",
6942 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6943 }
6944
Joe Perches179f8f42013-07-03 15:05:30 -07006945# check for comparisons against true and false
6946 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6947 my $lead = $1;
6948 my $arg = $2;
6949 my $test = $3;
6950 my $otype = $4;
6951 my $trail = $5;
6952 my $op = "!";
6953
6954 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6955
6956 my $type = lc($otype);
6957 if ($type =~ /^(?:true|false)$/) {
6958 if (("$test" eq "==" && "$type" eq "true") ||
6959 ("$test" eq "!=" && "$type" eq "false")) {
6960 $op = "";
6961 }
6962
6963 CHK("BOOL_COMPARISON",
6964 "Using comparison to $otype is error prone\n" . $herecurr);
6965
6966## maybe suggesting a correct construct would better
6967## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6968
6969 }
6970 }
6971
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006972# check for semaphores initialized locked
6973 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006974 WARN("CONSIDER_COMPLETION",
6975 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006976 }
Joe Perches6712d852012-03-23 15:02:20 -07006977
Joe Perches67d0a072011-10-31 17:13:10 -07006978# recommend kstrto* over simple_strto* and strict_strto*
6979 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006980 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006981 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006982 }
Joe Perches6712d852012-03-23 15:02:20 -07006983
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006984# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006985 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006986 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006987 "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 -07006988 }
Joe Perches6712d852012-03-23 15:02:20 -07006989
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006990# check for spin_is_locked(), suggest lockdep instead
6991 if ($line =~ /\bspin_is_locked\(/) {
6992 WARN("USE_LOCKDEP",
6993 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6994 }
6995
Joe Perches9189c7e2018-09-07 15:26:18 -07006996# check for deprecated apis
6997 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6998 my $deprecated_api = $1;
6999 my $new_api = $deprecated_apis{$deprecated_api};
7000 WARN("DEPRECATED_API",
7001 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
7002 }
7003
Joe Perches0f3c5aa2015-02-13 14:39:05 -08007004# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07007005# and avoid what seem like struct definitions 'struct foo {'
Quentin Monnetced69da12020-08-11 18:35:13 -07007006 if (defined($const_structs) &&
7007 $line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07007008 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007009 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07007010 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08007011 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07007012
7013# use of NR_CPUS is usually wrong
7014# ignore definitions of NR_CPUS and usage to define arrays as likely right
7015 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07007016 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
7017 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07007018 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
7019 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
7020 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07007021 {
Joe Perches000d1cc12011-07-25 17:13:25 -07007022 WARN("NR_CPUS",
7023 "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 -07007024 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07007025
Joe Perches52ea8502013-11-12 15:10:09 -08007026# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7027 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
7028 ERROR("DEFINE_ARCH_HAS",
7029 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
7030 }
7031
Joe Perchesacd93622015-02-13 14:38:38 -08007032# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07007033 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08007034 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
7035 WARN("LIKELY_MISUSE",
7036 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
7037 }
7038
Denis Efremovde3f1862019-09-25 16:49:25 -07007039# nested likely/unlikely calls
7040 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
7041 WARN("LIKELY_MISUSE",
7042 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
7043 }
7044
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007045# whine mightly about in_atomic
7046 if ($line =~ /\bin_atomic\s*\(/) {
7047 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007048 ERROR("IN_ATOMIC",
7049 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08007050 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007051 WARN("IN_ATOMIC",
7052 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007053 }
7054 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01007055
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02007056# check for mutex_trylock_recursive usage
7057 if ($line =~ /mutex_trylock_recursive/) {
7058 ERROR("LOCKING",
7059 "recursive locking is bad, do not use this ever.\n" . $herecurr);
7060 }
7061
Peter Zijlstra1704f472010-03-19 01:37:42 +01007062# check for lockdep_set_novalidate_class
7063 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
7064 $line =~ /__lockdep_no_validate__\s*\)/ ) {
7065 if ($realfile !~ m@^kernel/lockdep@ &&
7066 $realfile !~ m@^include/linux/lockdep@ &&
7067 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007068 ERROR("LOCKDEP",
7069 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01007070 }
7071 }
Dave Jones88f88312011-01-12 16:59:59 -08007072
Joe Perchesb392c642015-04-16 12:44:16 -07007073 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
7074 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007075 WARN("EXPORTED_WORLD_WRITABLE",
7076 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08007077 }
Joe Perches24358802014-04-03 14:49:13 -07007078
Joe Perches00180462018-02-06 15:38:55 -08007079# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7080# and whether or not function naming is typical and if
7081# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07007082 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08007083 defined $stat &&
7084 $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*\)/) {
7085 my $var = $1;
7086 my $perms = $2;
7087 my $show = $3;
7088 my $store = $4;
7089 my $octal_perms = perms_to_octal($perms);
7090 if ($show =~ /^${var}_show$/ &&
7091 $store =~ /^${var}_store$/ &&
7092 $octal_perms eq "0644") {
7093 if (WARN("DEVICE_ATTR_RW",
7094 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
7095 $fix) {
7096 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7097 }
7098 } elsif ($show =~ /^${var}_show$/ &&
7099 $store =~ /^NULL$/ &&
7100 $octal_perms eq "0444") {
7101 if (WARN("DEVICE_ATTR_RO",
7102 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
7103 $fix) {
7104 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7105 }
7106 } elsif ($show =~ /^NULL$/ &&
7107 $store =~ /^${var}_store$/ &&
7108 $octal_perms eq "0200") {
7109 if (WARN("DEVICE_ATTR_WO",
7110 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
7111 $fix) {
7112 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7113 }
7114 } elsif ($octal_perms eq "0644" ||
7115 $octal_perms eq "0444" ||
7116 $octal_perms eq "0200") {
7117 my $newshow = "$show";
7118 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
7119 my $newstore = $store;
7120 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
7121 my $rename = "";
7122 if ($show ne $newshow) {
7123 $rename .= " '$show' to '$newshow'";
7124 }
7125 if ($store ne $newstore) {
7126 $rename .= " '$store' to '$newstore'";
7127 }
7128 WARN("DEVICE_ATTR_FUNCTIONS",
7129 "Consider renaming function(s)$rename\n" . $herecurr);
7130 } else {
7131 WARN("DEVICE_ATTR_PERMS",
7132 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
7133 }
7134 }
7135
Joe Perches515a2352014-04-03 14:49:24 -07007136# Mode permission misuses where it seems decimal should be octal
7137# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08007138# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7139# specific definition of not visible in sysfs.
7140# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7141# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07007142 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07007143 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07007144 $line =~ /$mode_perms_search/) {
7145 foreach my $entry (@mode_permission_funcs) {
7146 my $func = $entry->[0];
7147 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07007148
Joe Perches459cf0a2016-10-11 13:52:19 -07007149 my $lc = $stat =~ tr@\n@@;
7150 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07007151 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07007152
Joe Perches515a2352014-04-03 14:49:24 -07007153 my $skip_args = "";
7154 if ($arg_pos > 1) {
7155 $arg_pos--;
7156 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
7157 }
Joe Perchesf90774e2016-10-11 13:51:47 -07007158 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07007159 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07007160 my $val = $1;
7161 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08007162 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
7163 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
7164 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07007165 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07007166 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007167 }
7168 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08007169 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07007170 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007171 }
Joe Perches24358802014-04-03 14:49:13 -07007172 }
7173 }
7174 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007175
Joe Perches459cf0a2016-10-11 13:52:19 -07007176# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07007177 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08007178 my $oval = $1;
7179 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07007180 if (WARN("SYMBOLIC_PERMS",
7181 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7182 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08007183 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07007184 }
7185 }
7186
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007187# validate content of MODULE_LICENSE against list from include/linux/module.h
7188 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
7189 my $extracted_string = get_quoted_string($line, $rawline);
7190 my $valid_licenses = qr{
7191 GPL|
7192 GPL\ v2|
7193 GPL\ and\ additional\ rights|
7194 Dual\ BSD/GPL|
7195 Dual\ MIT/GPL|
7196 Dual\ MPL/GPL|
7197 Proprietary
7198 }x;
7199 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
7200 WARN("MODULE_LICENSE",
7201 "unknown module license " . $extracted_string . "\n" . $herecurr);
7202 }
7203 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07007204
7205# check for sysctl duplicate constants
7206 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
7207 WARN("DUPLICATED_SYSCTL_CONST",
7208 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7209 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007210 }
7211
7212 # If we have no input at all, then there is nothing to report on
7213 # so just keep quiet.
7214 if ($#rawlines == -1) {
7215 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007216 }
7217
Andy Whitcroft8905a672007-11-28 16:21:06 -08007218 # In mailback mode only produce a report in the negative, for
7219 # things that appear to be patches.
7220 if ($mailback && ($clean == 1 || !$is_patch)) {
7221 exit(0);
7222 }
7223
Dwaipayan Raye73d2712020-12-15 20:44:56 -08007224 # This is not a patch, and we are in 'no-patch' mode so
Andy Whitcroft8905a672007-11-28 16:21:06 -08007225 # just keep quiet.
7226 if (!$chk_patch && !$is_patch) {
7227 exit(0);
7228 }
7229
Stafford Hornea08ffbe2017-10-03 16:16:51 -07007230 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007231 ERROR("NOT_UNIFIED_DIFF",
7232 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007233 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007234 if ($is_patch && $has_commit_log && $chk_signoff) {
7235 if ($signoff == 0) {
7236 ERROR("MISSING_SIGN_OFF",
7237 "Missing Signed-off-by: line(s)\n");
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07007238 } elsif ($authorsignoff != 1) {
7239 # authorsignoff values:
7240 # 0 -> missing sign off
7241 # 1 -> sign off identical
7242 # 2 -> names and addresses match, comments mismatch
7243 # 3 -> addresses match, names different
7244 # 4 -> names match, addresses different
7245 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7246
7247 my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";
7248
7249 if ($authorsignoff == 0) {
7250 ERROR("NO_AUTHOR_SIGN_OFF",
7251 "Missing Signed-off-by: line by nominal patch author '$author'\n");
7252 } elsif ($authorsignoff == 2) {
7253 CHK("FROM_SIGN_OFF_MISMATCH",
7254 "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
7255 } elsif ($authorsignoff == 3) {
7256 WARN("FROM_SIGN_OFF_MISMATCH",
7257 "From:/Signed-off-by: email name mismatch: $sob_msg\n");
7258 } elsif ($authorsignoff == 4) {
7259 WARN("FROM_SIGN_OFF_MISMATCH",
7260 "From:/Signed-off-by: email address mismatch: $sob_msg\n");
7261 } elsif ($authorsignoff == 5) {
7262 WARN("FROM_SIGN_OFF_MISMATCH",
7263 "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
7264 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007265 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007266 }
7267
Andy Whitcroft8905a672007-11-28 16:21:06 -08007268 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007269 if ($summary && !($clean == 1 && $quiet == 1)) {
7270 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08007271 print "total: $cnt_error errors, $cnt_warn warnings, " .
7272 (($check)? "$cnt_chk checks, " : "") .
7273 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07007274 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08007275
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007276 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07007277 # If there were any defects found and not already fixing them
7278 if (!$clean and !$fix) {
7279 print << "EOM"
7280
7281NOTE: For some of the reported defects, checkpatch may be able to
7282 mechanically convert to the typical style using --fix or --fix-inplace.
7283EOM
7284 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007285 # If there were whitespace errors which cleanpatch can fix
7286 # then suggest that.
7287 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07007288 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07007289 print << "EOM"
7290
7291NOTE: Whitespace errors detected.
7292 You may wish to use scripts/cleanpatch or scripts/cleanfile
7293EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007294 }
7295 }
7296
Joe Perchesd752fcc2014-08-06 16:11:05 -07007297 if ($clean == 0 && $fix &&
7298 ("@rawlines" ne "@fixed" ||
7299 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08007300 my $newfile = $filename;
7301 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07007302 my $linecount = 0;
7303 my $f;
7304
Joe Perchesd752fcc2014-08-06 16:11:05 -07007305 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
7306
Joe Perches3705ce52013-07-03 15:05:31 -07007307 open($f, '>', $newfile)
7308 or die "$P: Can't open $newfile for write\n";
7309 foreach my $fixed_line (@fixed) {
7310 $linecount++;
7311 if ($file) {
7312 if ($linecount > 3) {
7313 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07007314 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07007315 }
7316 } else {
7317 print $f $fixed_line . "\n";
7318 }
7319 }
7320 close($f);
7321
7322 if (!$quiet) {
7323 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07007324
Joe Perches3705ce52013-07-03 15:05:31 -07007325Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
7326
7327Do _NOT_ trust the results written to this file.
7328Do _NOT_ submit these changes without inspecting them for correctness.
7329
7330This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7331No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07007332EOM
7333 }
7334 }
7335
Joe Perchesd8469f12015-06-25 15:03:00 -07007336 if ($quiet == 0) {
7337 print "\n";
7338 if ($clean == 1) {
7339 print "$vname has no obvious style problems and is ready for submission.\n";
7340 } else {
7341 print "$vname has style problems, please review.\n";
7342 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007343 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007344 return $clean;
7345}